VariablesDescriptor::Implementation Struct Reference

Public Types
typedef std::map< std::string, Uint >	IndexMapT
	Mapping from variable internal name to index in the vectors. More...
typedef std::vector< Dimensionalities::Type >	VarTypesT
	Type of each variable. More...

Public Member Functions
	Implementation (Component &component)
void	push_back (const std::string &name, const VariablesDescriptor::Dimensionalities::Type type)
void	push_back (const std::string &name, const Uint nb_vars)
Uint	nb_vars () const
Uint	size () const
Uint	size (const std::string &name) const
Uint	offset (const std::string &name) const
Uint	offset (const Uint var_nb) const
const std::string &	user_variable_name (const std::string &name) const
const std::string &	user_variable_name (const Uint var_nb) const
const std::string &	internal_variable_name (const Uint var_nb) const
bool	has_variable (const std::string &vname) const
Uint	var_length (const Uint var_number) const
Uint	var_length (const std::string &name) const
void	set_variables (const std::string &description)
	Implementation based on Willem Deconincks code for Field. More...
std::string	description () const
void	prefix_variable_names (const std::string &prefix)
Uint	to_size (Dimensionalities::Type dim_type) const
	Convert the dimensionality type to a real size. More...
void	trigger_dimensions ()
std::string	variable_property_name (std::string var_name)
Uint	checked_index (const std::string &name) const
	Index for the given internal name, throwing a nice error if it's not found. More...
void	update_description_property ()

Public Attributes
Component &	m_component
Uint	m_dim
	dimension of physics More...
Uint	m_size
	Total size. More...
IndexMapT	m_indices
VarTypesT	m_types
std::vector< Uint >	m_offsets
	Offsets for the variables. More...
std::vector< std::string >	m_user_names
	User defined variable names. More...
std::vector< std::string >	m_internal_names

Detailed Description

Definition at line 38 of file VariablesDescriptor.cpp.

Member Typedef Documentation

typedef std::map<std::string, Uint> IndexMapT

Mapping from variable internal name to index in the vectors.

Definition at line 340 of file VariablesDescriptor.cpp.

typedef std::vector<Dimensionalities::Type> VarTypesT

Type of each variable.

Definition at line 344 of file VariablesDescriptor.cpp.

Constructor & Destructor Documentation

Implementation ( Component &  component )

inline

Definition at line 40 of file VariablesDescriptor.cpp.

Member Function Documentation

Uint checked_index ( const std::string &  name ) const

inline

Index for the given internal name, throwing a nice error if it's not found.

Definition at line 307 of file VariablesDescriptor.cpp.

std::string description ( ) const

inline

Definition at line 228 of file VariablesDescriptor.cpp.

bool has_variable ( const std::string &  vname ) const

inline

Definition at line 147 of file VariablesDescriptor.cpp.

const std::string& internal_variable_name ( const Uint  var_nb ) const

inline

Definition at line 142 of file VariablesDescriptor.cpp.

Uint nb_vars ( ) const

inline

Definition at line 95 of file VariablesDescriptor.cpp.

Uint offset ( const std::string &  name ) const

inline

Definition at line 116 of file VariablesDescriptor.cpp.

Uint offset ( const Uint  var_nb ) const

inline

Definition at line 124 of file VariablesDescriptor.cpp.

void prefix_variable_names ( const std::string &  prefix )

inline

Definition at line 242 of file VariablesDescriptor.cpp.

void push_back ( const std::string &  name, const VariablesDescriptor::Dimensionalities::Type  type  )

inline

Definition at line 54 of file VariablesDescriptor.cpp.

void push_back ( const std::string &  name, const Uint  nb_vars  )

inline

Definition at line 80 of file VariablesDescriptor.cpp.

void set_variables ( const std::string &  description )

inline

Implementation based on Willem Deconincks code for Field.

Definition at line 163 of file VariablesDescriptor.cpp.

Uint size ( ) const

inline

Definition at line 100 of file VariablesDescriptor.cpp.

Uint size ( const std::string &  name ) const

inline

Definition at line 108 of file VariablesDescriptor.cpp.

Uint to_size ( Dimensionalities::Type  dim_type ) const

inline

Convert the dimensionality type to a real size.

Definition at line 269 of file VariablesDescriptor.cpp.

void trigger_dimensions ( )

inline

Definition at line 285 of file VariablesDescriptor.cpp.

void update_description_property ( )

inline

Definition at line 324 of file VariablesDescriptor.cpp.

const std::string& user_variable_name ( const std::string &  name ) const

inline

Definition at line 132 of file VariablesDescriptor.cpp.

const std::string& user_variable_name ( const Uint  var_nb ) const

inline

Definition at line 137 of file VariablesDescriptor.cpp.

Uint var_length ( const Uint  var_number ) const

inline

Definition at line 152 of file VariablesDescriptor.cpp.

Uint var_length ( const std::string &  name ) const

inline

Definition at line 157 of file VariablesDescriptor.cpp.

std::string variable_property_name ( std::string  var_name )

inline

Note

from Willem Deconinck: following line is commented because this forbids case sensitive variable names

Definition at line 299 of file VariablesDescriptor.cpp.

Member Data Documentation

Component& m_component

Definition at line 331 of file VariablesDescriptor.cpp.

Uint m_dim

dimension of physics

Definition at line 334 of file VariablesDescriptor.cpp.

IndexMapT m_indices

Definition at line 341 of file VariablesDescriptor.cpp.

std::vector<std::string> m_internal_names

Definition at line 352 of file VariablesDescriptor.cpp.

std::vector<Uint> m_offsets

Offsets for the variables.

Definition at line 348 of file VariablesDescriptor.cpp.

Uint m_size

Total size.

Definition at line 337 of file VariablesDescriptor.cpp.

VarTypesT m_types

Definition at line 345 of file VariablesDescriptor.cpp.

std::vector<std::string> m_user_names

User defined variable names.

Definition at line 351 of file VariablesDescriptor.cpp.

---

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

• cf3/math/VariablesDescriptor.cpp