GRINS::MulticomponentVariable Class Reference

Variables that may components, but are not intended to be vectors. More...

#include <multicomponent_variable.h>

Inheritance diagram for GRINS::MulticomponentVariable:

Collaboration diagram for GRINS::MulticomponentVariable:

Public Member Functions
	MulticomponentVariable (const std::vector< std::string > &var_names, const std::vector< VariableIndex > &var_indices, const std::set< libMesh::subdomain_id_type > &subdomain_ids)
virtual	~MulticomponentVariable ()
unsigned int	dim () const
	Number of components. More...
VariableIndex	idx_from_component (unsigned int component) const
Public Member Functions inherited from GRINS::FEVariablesBase
	FEVariablesBase (const std::vector< std::string > &var_names, const std::vector< VariableIndex > &var_indices, const std::set< libMesh::subdomain_id_type > &subdomain_ids)
virtual	~FEVariablesBase ()
void	set_is_constraint_var (bool is_constraint_var)
	Set whether or not this is a "constraint" variable. More...
bool	is_constraint_var () const
void	set_neumann_bc_is_positive (bool is_positive)
	Reset whetever Neumann bc is postive or not. More...
libMesh::Real	neumann_bc_sign () const
const std::vector< std::string > &	active_var_names () const
	Return the var names that are active from this class. More...
const std::vector< VariableIndex > &	var_indices () const
const std::set< libMesh::subdomain_id_type > &	subdomain_ids () const

Private Member Functions
	MulticomponentVariable ()

Additional Inherited Members
Protected Attributes inherited from GRINS::FEVariablesBase
std::vector< VariableIndex >	_vars
std::vector< std::string >	_var_names
bool	_is_constraint_var
	Tracks whether this is a constraint variable. More...
libMesh::Real	_neumann_bc_sign
	Track the sign of the Neumann BC term. Defaults to 1.0. More...
std::set< libMesh::subdomain_id_type >	_subdomain_ids

Detailed Description

Variables that may components, but are not intended to be vectors.

Vector variables should instead use MultcomponentVectorVariable.

Definition at line 35 of file multicomponent_variable.h.

Constructor & Destructor Documentation

GRINS::MulticomponentVariable::MulticomponentVariable ( const std::vector< std::string > &  var_names, const std::vector< VariableIndex > &  var_indices, const std::set< libMesh::subdomain_id_type > &  subdomain_ids  )

inline

Definition at line 39 of file multicomponent_variable.h.

      : FEVariablesBase(var_names,var_indices,subdomain_ids)
    {}

virtual GRINS::MulticomponentVariable::~MulticomponentVariable ( )

inlinevirtual

Definition at line 45 of file multicomponent_variable.h.

{}

GRINS::MulticomponentVariable::MulticomponentVariable ( )

private

Member Function Documentation

unsigned int GRINS::MulticomponentVariable::dim ( ) const

inline

Number of components.

Definition at line 48 of file multicomponent_variable.h.

References GRINS::FEVariablesBase::_vars.

Referenced by GRINS::SpeciesMassFractionsVariable::n_species().

    { return _vars.size(); }

VariableIndex GRINS::MulticomponentVariable::idx_from_component ( unsigned int  component ) const

inline

Definition at line 51 of file multicomponent_variable.h.

References GRINS::FEVariablesBase::_vars.

Referenced by GRINS::SpeciesMassFractionsVariable::species().

    { libmesh_assert_less( component, _vars.size() );
      return _vars[component]; }

---

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

• src/variables/include/grins/multicomponent_variable.h