libMesh::VariableGroup Class Reference

#include <variable.h>

Inheritance diagram for libMesh::VariableGroup:

Public Member Functions
	VariableGroup (System *sys, const std::vector< std::string > &var_names, const unsigned int var_number, const unsigned int first_scalar_num, const FEType &var_type)
	VariableGroup (System *sys, const std::vector< std::string > &var_names, const unsigned int var_number, const unsigned int first_scalar_num, const FEType &var_type, const std::set< subdomain_id_type > &var_active_subdomains)
unsigned int	n_variables () const
Variable	variable (unsigned int v) const
Variable	operator() (unsigned int v) const
const std::string &	name (unsigned int v) const
unsigned int	number (unsigned int v) const
unsigned int	first_scalar_number (unsigned int v) const
void	append (const std::string &var_name)
System *	system () const
const std::string &	name () const
unsigned int	number () const
unsigned int	first_scalar_number () const
const FEType &	type () const
unsigned int	n_components () const
bool	active_on_subdomain (subdomain_id_type sid) const
bool	implicitly_active () const
const std::set < subdomain_id_type > &	active_subdomains () const
Protected Attributes
std::vector< std::string >	_names
System *	_sys
std::string	_name
unsigned int	_number
unsigned int	_first_scalar_number
FEType	_type
std::set< subdomain_id_type >	_active_subdomains

Detailed Description

This class defines a logically grouped set of variables in the system. VariableGroup is appropriate for representing several unknowns in the problem that are all approximated with the same finite element approximation family and (optionally) a list of subdomains to which the variables are restricted.

Definition at line 165 of file variable.h.

Constructor & Destructor Documentation

libMesh::VariableGroup::VariableGroup	(	System *	sys,
		const std::vector< std::string > &	var_names,
		const unsigned int	var_number,
		const unsigned int	first_scalar_num,
		const FEType &	var_type
	)			`[inline]`

Constructor. Omits the subdomain mapping, hence this constructor creates a variable which is active on all subdomains.

Definition at line 173 of file variable.h.

00177                                          :
00178     Variable (sys,
00179               "var_group",
00180               var_number,
00181               first_scalar_num,
00182               var_type),
00183     _names(var_names)
00184   {}

libMesh::VariableGroup::VariableGroup	(	System *	sys,
		const std::vector< std::string > &	var_names,
		const unsigned int	var_number,
		const unsigned int	first_scalar_num,
		const FEType &	var_type,
		const std::set< subdomain_id_type > &	var_active_subdomains
	)			`[inline]`

Constructor. Takes a set which contains the subdomain indices for which this variable is active.

Definition at line 191 of file variable.h.

00196                                                                          :
00197 
00198     Variable (sys,
00199               "var_group",
00200               var_number,
00201               first_scalar_num,
00202               var_type,
00203               var_active_subdomains),
00204     _names(var_names)
00205   {}

Member Function Documentation

bool libMesh::Variable::active_on_subdomain ( subdomain_id_type sid ) const [inline, inherited]

returns true if this variable is active on subdomain sid, false otherwise. Note that we interperet the special case of an empty _active_subdomains container as active everywhere, i.e. for all subdomains.

Definition at line 129 of file variable.h.

References libMesh::Variable::_active_subdomains.

Referenced by libMesh::EquationSystems::build_solution_vector(), libMesh::DofMap::distribute_local_dofs_node_major(), libMesh::DofMap::distribute_local_dofs_var_major(), libMesh::EquationSystems::get_solution(), libMesh::BoundaryProjectSolution::operator()(), libMesh::ProjectFEMSolution::operator()(), libMesh::ProjectSolution::operator()(), and libMesh::DofMap::reinit().

00130   { return (_active_subdomains.empty() || _active_subdomains.count(sid));  }

const std::set<subdomain_id_type>& libMesh::Variable::active_subdomains ( ) const [inline, inherited]

Returns set of subdomain ids this variable lives on

Definition at line 143 of file variable.h.

References libMesh::Variable::_active_subdomains.

Referenced by variable(), and libMesh::System::write_header().

00144   { return _active_subdomains; }

void libMesh::VariableGroup::append ( const std::string & var_name ) [inline]

Appends a variable to the group. Really only can be used by System in a very limited window of opportunity - after the user specifies variables but before the system is initialized.

Definition at line 267 of file variable.h.

References _names.

00268   { _names.push_back (var_name); }

unsigned int libMesh::Variable::first_scalar_number ( ) const [inline, inherited]

The index of the first scalar component of this variable in the system.

Definition at line 108 of file variable.h.

References libMesh::Variable::_first_scalar_number.

Referenced by libMesh::System::n_components(), and variable().

00109   { return _first_scalar_number; }

unsigned int libMesh::VariableGroup::first_scalar_number ( unsigned int v ) const [inline]

The index of the first scalar component of this variable in the system.

Definition at line 256 of file variable.h.

References libMesh::Variable::_first_scalar_number, and n_variables().

00257   {
00258     libmesh_assert_less (v, this->n_variables());
00259     return _first_scalar_number+v;
00260   }

bool libMesh::Variable::implicitly_active ( ) const [inline, inherited]

returns true if this variable is active on all subdomains because it has no specified activity map. This can be used to perform more efficient computations in some places.

Definition at line 137 of file variable.h.

References libMesh::Variable::_active_subdomains.

Referenced by libMesh::EquationSystems::build_solution_vector().

00138   { return _active_subdomains.empty(); }

unsigned int libMesh::Variable::n_components ( ) const [inline, inherited]

The number of components of this variable.

Definition at line 120 of file variable.h.

References libMesh::Variable::_type, libMesh::FEType::family, libMesh::FEType::order, libMeshEnums::SCALAR, and libMesh::Variable::type().

Referenced by libMesh::WrappedFunction< Output >::component(), libMesh::System::n_components(), and libMesh::WrappedFunction< Output >::operator()().

00121   { return type().family == SCALAR ? _type.order : 1; }

unsigned int libMesh::VariableGroup::n_variables ( ) const [inline]

The number of variables in this VariableGroup

Definition at line 210 of file variable.h.

References _names.

Referenced by libMesh::DofMap::add_variable_group(), libMesh::DofMap::distribute_local_dofs_node_major(), libMesh::DofMap::distribute_local_dofs_var_major(), first_scalar_number(), libMesh::System::get_info(), name(), number(), libMesh::DofMap::reinit(), and variable().

00211   { return libmesh_cast_int<unsigned int>(_names.size()); }

const std::string& libMesh::Variable::name ( ) const [inline, inherited]

Arbitrary, user-specified name of the variable.

Definition at line 95 of file variable.h.

References libMesh::Variable::_name.

Referenced by DMLibMeshSetSystem(), and variable().

00096   { return _name; }

const std::string& libMesh::VariableGroup::name ( unsigned int v ) const [inline]

Arbitrary, user-specified name of the variable.

Definition at line 237 of file variable.h.

References _names, and n_variables().

Referenced by libMesh::System::get_info().

00238   {
00239     libmesh_assert_less (v, this->n_variables());
00240     return _names[v];
00241   }

unsigned int libMesh::Variable::number ( ) const [inline, inherited]

The rank of this variable in the system.

Definition at line 101 of file variable.h.

References libMesh::Variable::_number.

Referenced by variable().

00102   { return _number; }

unsigned int libMesh::VariableGroup::number ( unsigned int v ) const [inline]

The rank of this variable in the system.

Definition at line 246 of file variable.h.

References libMesh::Variable::_number, and n_variables().

00247   {
00248     libmesh_assert_less (v, this->n_variables());
00249     return _number + v;
00250   }

Variable libMesh::VariableGroup::operator() ( unsigned int v ) const [inline]

Support vg(v) - returns a Variable for v.

Definition at line 231 of file variable.h.

References variable().

00232   { return this->variable(v); }

System* libMesh::Variable::system ( ) const [inline, inherited]

The System this Variable is part of.

Definition at line 87 of file variable.h.

References libMesh::Variable::_sys.

Referenced by variable().

00088   {
00089     return _sys;
00090   }

const FEType& libMesh::Variable::type ( ) const [inline, inherited]

The FEType for this variable.

Definition at line 114 of file variable.h.

References libMesh::Variable::_type.

Referenced by libMesh::WrappedFunction< Output >::component(), libMesh::DofMap::distribute_local_dofs_node_major(), libMesh::DofMap::distribute_local_dofs_var_major(), libMesh::System::get_info(), libMesh::Variable::n_components(), libMesh::WrappedFunction< Output >::operator()(), libMesh::BoundaryProjectSolution::operator()(), libMesh::ProjectFEMSolution::operator()(), libMesh::ProjectSolution::operator()(), libMesh::System::project_vector(), libMesh::System::read_parallel_data(), libMesh::System::read_SCALAR_dofs(), libMesh::System::read_serialized_vectors(), libMesh::DofMap::reinit(), variable(), libMesh::System::write_parallel_data(), libMesh::System::write_serialized_vector(), and libMesh::System::write_serialized_vectors().

00115   { return _type; }

Variable libMesh::VariableGroup::variable ( unsigned int v ) const [inline]

Construct a Variable object for an individual member of our group.

Definition at line 217 of file variable.h.

References libMesh::Variable::active_subdomains(), libMesh::Variable::first_scalar_number(), n_variables(), libMesh::Variable::name(), libMesh::Variable::number(), libMesh::Variable::system(), libMesh::Variable::type(), and libMesh::Variable::Variable().

Referenced by operator()().

00218   {
00219     libmesh_assert_less (v, this->n_variables());
00220     return Variable (this->system(),
00221                      this->name(v),
00222                      this->number(v),
00223                      this->first_scalar_number(v),
00224                      this->type(),
00225                      this->active_subdomains());
00226   }