alma::Scattering_subgroup Class Reference

POD class describing a subgroup of the "/scattering" group of an HDF5 file. More...

#include <bulk_hdf5.hpp>

Collaboration diagram for alma::Scattering_subgroup:

Public Member Functions
	Scattering_subgroup (const std::string &_name, const bool _preserves_symmetry, const std::string &_description, const Eigen::Ref< const Eigen::ArrayXXd > &_w0)
	Public constructor that does not allow extra attributes, datasets or groups. More...

Public Attributes
const std::string	name
	Name of the subgroup.
const bool	preserves_symmetry
	True unless the scattering source alters the q-point equivalence classes. More...
const std::string	description
	Free-format description.
const Eigen::ArrayXXd	w0
	Set of scattering rates [1 / ps].
const std::vector< std::string >	attributes
	List with the names of all non-mandatory attributes in the subgroup. More...
const std::vector< std::string >	datasets
	List with the names of all non-mandatory datasets in the subgroup. More...
const std::vector< std::string >	groups
	List with the names of all subsubgroups in the subgroup.

Friends
Scattering_subgroup	load_scattering_subgroup (const char *filename, const std::string &groupname, const boost::mpi::communicator &comm)
	Read the scattering rates stored in a subgroup from the "/scattering" group. More...

Detailed Description

POD class describing a subgroup of the "/scattering" group of an HDF5 file.

Constructor & Destructor Documentation

Scattering_subgroup()

alma::Scattering_subgroup::Scattering_subgroup ( const std::string &  _name, const bool  _preserves_symmetry, const std::string &  _description, const Eigen::Ref< const Eigen::ArrayXXd > &  _w0  )

inline

Public constructor that does not allow extra attributes, datasets or groups.

Friends And Related Function Documentation

load_scattering_subgroup

Scattering_subgroup load_scattering_subgroup ( const char *  filename, const std::string &  groupname, const boost::mpi::communicator &  comm  )

friend

Read the scattering rates stored in a subgroup from the "/scattering" group.

The existence of the group is not checked.

Parameters

[in]	filename	- path to the HDF5 file
[in]	groupname	- name of the group
[in]	comm	- MPI communicator used to coordinate with all other processes

Returns

a Scattering_subgroup structure

Member Data Documentation

attributes

const std::vector<std::string> alma::Scattering_subgroup::attributes

List with the names of all non-mandatory attributes in the subgroup.

datasets

const std::vector<std::string> alma::Scattering_subgroup::datasets

List with the names of all non-mandatory datasets in the subgroup.

preserves_symmetry

const bool alma::Scattering_subgroup::preserves_symmetry

True unless the scattering source alters the q-point equivalence classes.

---

The documentation for this class was generated from the following file:

• bulk_hdf5.hpp