GRINS-0.8.0
List of all members | Public Member Functions | Private Member Functions
GRINS::ScalarVariable Class Reference

Variables with a single SCALAR component. More...

#include <single_variable.h>

Inheritance diagram for GRINS::ScalarVariable:
Inheritance graph
[legend]
Collaboration diagram for GRINS::ScalarVariable:
Collaboration graph
[legend]

Public Member Functions

 ScalarVariable (const std::vector< std::string > &var_names, const std::vector< VariableIndex > &var_indices, const std::set< libMesh::subdomain_id_type > &subdomain_ids)
 
 ~ScalarVariable ()
 
- Public Member Functions inherited from GRINS::SingleVariable
 SingleVariable (const std::vector< std::string > &var_names, const std::vector< VariableIndex > &var_indices, const std::set< libMesh::subdomain_id_type > &subdomain_ids)
 
 ~SingleVariable ()
 
VariableIndex var () 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

 ScalarVariable ()
 

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 with a single SCALAR component.

Will use the type to assert the SCALAR part in the factory.

Definition at line 123 of file single_variable.h.

Constructor & Destructor Documentation

GRINS::ScalarVariable::ScalarVariable ( 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 126 of file single_variable.h.

130  {}
const std::set< libMesh::subdomain_id_type > & subdomain_ids() const
const std::vector< VariableIndex > & var_indices() const
GRINS::ScalarVariable::~ScalarVariable ( )
inline

Definition at line 132 of file single_variable.h.

132 {}
GRINS::ScalarVariable::ScalarVariable ( )
private

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

Generated on Tue Dec 19 2017 12:47:32 for GRINS-0.8.0 by  doxygen 1.8.9.1