libMesh::VariableGroup Class Reference

This class defines a logically grouped set of variables in the system. More...

#include <variable.h>

Inheritance diagram for libMesh::VariableGroup:

Public Member Functions
	VariableGroup (System *sys, std::vector< std::string > var_names, const unsigned int var_number, const unsigned int first_scalar_num, const FEType &var_type)
	Constructor.
	VariableGroup (System *sys, 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)
	Constructor.
	VariableGroup (const VariableGroup &)=default
	Standard constructors.
VariableGroup &	operator= (const VariableGroup &)=default
	VariableGroup (VariableGroup &&)=default
VariableGroup &	operator= (VariableGroup &&)=default
bool	operator== (const VariableGroup &other) const
unsigned int	n_variables () const
Variable	variable (unsigned int v) const
Variable	operator() (unsigned int v) const
	Support vg(v).
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 (std::string var_name)
	Appends a variable to the group.
unsigned int	number () const
bool	operator== (const Variable &other) const
System *	system () const
const std::string &	name () const
unsigned int	first_scalar_number () const
const FEType &	type () const
unsigned int	n_components () const
unsigned int	n_components (const MeshBase &mesh) 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
std::set< subdomain_id_type >	_active_subdomains
unsigned int	_number
unsigned int	_first_scalar_number
FEType	_type

Private Member Functions
FEType &	type ()

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 215 of file variable.h.

Constructor & Destructor Documentation

VariableGroup() [1/4]

libMesh::VariableGroup::VariableGroup ( System *  sys, 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 223 of file variable.h.

                                          :
    Variable (sys,
              "var_group",
              var_number,
              first_scalar_num,
              var_type),
    _names(std::move(var_names))
  {}

VariableGroup() [2/4]

libMesh::VariableGroup::VariableGroup ( System *  sys, 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 241 of file variable.h.

                                                                          :
 
    Variable (sys,
              "var_group",
              var_number,
              first_scalar_num,
              var_type,
              var_active_subdomains),
    _names(std::move(var_names))
  {}

VariableGroup() [3/4]

libMesh::VariableGroup::VariableGroup ( const VariableGroup &  )

default

Standard constructors.

VariableGroup() [4/4]

libMesh::VariableGroup::VariableGroup ( VariableGroup &&  )

default

Member Function Documentation

active_on_subdomain()

bool libMesh::Variable::active_on_subdomain ( subdomain_id_type  sid ) const

inlineinherited

Returns

true if this variable is active on subdomain sid, false otherwise.

Note

We interpret the special case of an empty _active_subdomains container as active everywhere, i.e. for all subdomains.

Definition at line 167 of file variable.h.

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

References libMesh::Variable::_active_subdomains.

Referenced by libMesh::ExactSolution::_compute_error(), libMesh::DofMap::_dof_indices(), libMesh::EquationSystems::build_discontinuous_solution_vector(), libMesh::EquationSystems::build_parallel_solution_vector(), libMesh::FEGenericBase< OutputType >::compute_proj_constraints(), libMesh::DofMap::distribute_local_dofs_node_major(), libMesh::DofMap::distribute_local_dofs_var_major(), libMesh::DofMap::dof_indices(), libMesh::DofMap::dof_indices(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::SubFunctor::find_dofs_to_send(), libMesh::DofMap::local_variable_indices(), libMesh::DofMap::old_dof_indices(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::SortAndCopy::operator()(), libMesh::BoundaryProjectSolution::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectInteriors::operator()(), and libMesh::Nemesis_IO_Helper::write_nodal_solution().

active_subdomains()

const std::set< subdomain_id_type > & libMesh::Variable::active_subdomains ( ) const

inlineinherited

Returns

The set of subdomain ids this variable lives on.

Definition at line 181 of file variable.h.

  { return _active_subdomains; }

References libMesh::Variable::_active_subdomains.

Referenced by libMesh::DifferentiableSystem::add_second_order_dot_vars(), libMesh::DofMap::add_variable(), libMesh::DofMap::add_variables(), libMesh::EquationSystems::get_vars_active_subdomains(), main(), variable(), and libMesh::System::write_header().

append()

void libMesh::VariableGroup::append ( 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 340 of file variable.h.

  { _names.push_back (std::move(var_name)); }

References _names.

Referenced by libMesh::DofMap::add_variable(), and libMesh::DofMap::add_variables().

first_scalar_number() [1/2]

unsigned int libMesh::Variable::first_scalar_number ( ) const

inlineinherited

Returns

The index of the first scalar component of this variable in the system. Say you've got a flow problem that's (u,v,w,p,T) - p will be at first_scalar_number 3 regardless of whether p is variable number 1 in the case that u,v,w is represented by a single vector-valued variable at number 0, or p is variable number 3 in the case that u,v,w are three scalar-valued variables with variable numbers 0,1,2

Definition at line 138 of file variable.h.

  { return _first_scalar_number; }

References libMesh::Variable::_first_scalar_number.

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

first_scalar_number() [2/2]

unsigned int libMesh::VariableGroup::first_scalar_number ( unsigned int  v ) const

inline

Returns

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

Definition at line 329 of file variable.h.

  {
    libmesh_assert_less (v, this->n_variables());
    return _first_scalar_number+v;
  }

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

Referenced by libMesh::DofMap::should_p_refine().

implicitly_active()

bool libMesh::Variable::implicitly_active ( ) const

inlineinherited

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 175 of file variable.h.

  { return _active_subdomains.empty(); }

References libMesh::Variable::_active_subdomains.

Referenced by libMesh::DofMap::add_variable(), and libMesh::DofMap::add_variables().

n_components() [1/2]

unsigned int libMesh::Variable::n_components ( ) const

inherited

Returns

The number of components of this variable if the FEFamily is SCALAR or if the associated FEFieldType is TYPE_SCALAR. Otherwise this will error because determination of the number of components for a TYPE_VECTOR requires the mesh

Definition at line 23 of file variable.C.

{
  if (_type.family == SCALAR)
    return _type.order.get_order();
 
  if (const auto fe_field_type = FEInterface::field_type(_type.family);
      fe_field_type == TYPE_VECTOR)
    libmesh_error_msg("Cannot determine the number of components. Please call the n_components "
                      "overload with a mesh argument");
  else
    return 1;
}

References libMesh::Variable::_type, libMesh::FEType::family, libMesh::FEInterface::field_type(), libMesh::OrderWrapper::get_order(), libMesh::FEType::order, libMesh::SCALAR, and libMesh::TYPE_VECTOR.

Referenced by libMesh::DofMap::n_components(), libMesh::StaticCondensationDofMap::reinit(), libMesh::BoundaryVolumeSolutionTransfer::transfer_boundary_volume(), and libMesh::BoundaryVolumeSolutionTransfer::transfer_volume_boundary().

n_components() [2/2]

unsigned int libMesh::Variable::n_components ( const MeshBase &  mesh ) const

inherited

Returns

The number of components of this variable

Definition at line 36 of file variable.C.

{
  if (_type.family == SCALAR)
    return _type.order.get_order();
  else
    return FEInterface::n_vec_dim(mesh, _type);
}

References libMesh::Variable::_type, libMesh::FEType::family, libMesh::OrderWrapper::get_order(), mesh, libMesh::FEInterface::n_vec_dim(), libMesh::FEType::order, and libMesh::SCALAR.

n_variables()

unsigned int libMesh::VariableGroup::n_variables ( ) const

inline

Returns

The number of variables in this VariableGroup

Definition at line 278 of file variable.h.

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

References _names.

Referenced by libMesh::DofMap::add_variable(), libMesh::DofMap::add_variables(), libMesh::DofMap::distribute_local_dofs_node_major(), libMesh::DofMap::distribute_local_dofs_var_major(), libMesh::DofMap::distribute_scalar_dofs(), libMesh::DofMap::dof_indices(), libMesh::DofMap::dof_indices(), first_scalar_number(), libMesh::System::get_info(), name(), number(), libMesh::DofMap::old_dof_indices(), libMesh::DofMap::should_p_refine(), and variable().

name() [1/2]

const std::string & libMesh::Variable::name ( ) const

inlineinherited

Returns

The user-specified name of the variable.

Definition at line 122 of file variable.h.

  { return _name; }

References libMesh::Variable::_name.

Referenced by libMesh::DifferentiableSystem::add_second_order_dot_vars(), DMlibMeshSetSystem_libMesh(), libMesh::StaticCondensationDofMap::reinit(), libMesh::DTKSolutionTransfer::transfer(), libMesh::MeshfreeSolutionTransfer::transfer(), and variable().

name() [2/2]

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

inline

Returns

The user-specified name of the variable.

Definition at line 307 of file variable.h.

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

References _names, and n_variables().

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

number() [1/2]

unsigned int libMesh::Variable::number ( ) const

inline

Returns

The rank of this variable in the system.

Definition at line 128 of file variable.h.

  { return _number; }

Referenced by variable().

number() [2/2]

unsigned int libMesh::VariableGroup::number ( unsigned int  v ) const

inline

Returns

The rank of this variable in the system.

Definition at line 316 of file variable.h.

  {
    libmesh_assert_less (v, this->n_variables());
    return _number + v;
  }

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

Referenced by libMesh::DofMap::dof_indices(), libMesh::DofMap::dof_indices(), libMesh::DofMap::dof_indices(), libMesh::DofMap::dof_indices(), libMesh::DofMap::old_dof_indices(), and libMesh::StaticCondensationDofMap::reinit().

operator()()

Variable libMesh::VariableGroup::operator() ( unsigned int  v ) const

inline

Support vg(v).

Returns

A Variable for v.

Definition at line 301 of file variable.h.

  { return this->variable(v); }

References variable().

operator=() [1/2]

VariableGroup & libMesh::VariableGroup::operator= ( const VariableGroup &  )

default

operator=() [2/2]

VariableGroup & libMesh::VariableGroup::operator= ( VariableGroup &&  )

default

operator==() [1/2]

bool libMesh::Variable::operator== ( const Variable &  other ) const

inlineinherited

Returns

true iff the other Variable has the same characteristics and system numbering as this one.

Definition at line 102 of file variable.h.

  {
    return (_sys == other._sys) &&
           (_name == other._name) &&
           (_active_subdomains == other._active_subdomains) &&
           (_first_scalar_number == other._first_scalar_number) &&
           (_type == other._type);
  }

References libMesh::Variable::_active_subdomains, libMesh::Variable::_first_scalar_number, libMesh::Variable::_name, libMesh::Variable::_sys, and libMesh::Variable::_type.

operator==() [2/2]

bool libMesh::VariableGroup::operator== ( const VariableGroup &  other ) const

inline

Returns

true iff the other VariableGroup has exactly the same Variable members as this one.

Definition at line 269 of file variable.h.

  {
    return (this->Variable::operator==(other)) &&
           (_names == other._names);
  }

References _names.

system()

System * libMesh::Variable::system ( ) const

inlineinherited

Returns

A pointer to the System this Variable is part of.

Definition at line 114 of file variable.h.

  {
    return _sys;
  }

References libMesh::Variable::_sys.

Referenced by libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::SortAndCopy::operator()(), libMesh::BoundaryVolumeSolutionTransfer::transfer(), libMesh::DirectSolutionTransfer::transfer(), libMesh::DTKSolutionTransfer::transfer(), libMesh::MeshfreeSolutionTransfer::transfer(), libMesh::MeshFunctionSolutionTransfer::transfer(), libMesh::BoundaryVolumeSolutionTransfer::transfer_boundary_volume(), libMesh::BoundaryVolumeSolutionTransfer::transfer_volume_boundary(), and variable().

type() [1/2]

FEType & libMesh::Variable::type ( )

inlineprivateinherited

Returns

The FEType for this variable. Altering this while this Variable is already in use may be dangerous!

Definition at line 197 of file variable.h.

  { return _type; }

References libMesh::Variable::_type.

type() [2/2]

const FEType & libMesh::Variable::type ( ) const

inlineinherited

Returns

The FEType for this variable.

Definition at line 144 of file variable.h.

  { return _type; }

References libMesh::Variable::_type.

Referenced by libMesh::DofMap::_dof_indices(), libMesh::DofMap::_node_dof_indices(), libMesh::PetscDMWrapper::add_dofs_to_section(), libMesh::DifferentiableSystem::add_second_order_dot_vars(), libMesh::DofMap::add_variable(), libMesh::DofMap::add_variables(), libMesh::FEMSystem::assembly(), libMesh::FEGenericBase< OutputType >::compute_proj_constraints(), libMesh::FirstOrderUnsteadySolver::compute_second_order_eqns(), libMesh::DofMap::distribute_local_dofs_node_major(), libMesh::DofMap::distribute_local_dofs_var_major(), libMesh::DofMap::distribute_scalar_dofs(), libMesh::DofMap::dof_indices(), libMesh::DofMap::dof_indices(), libMesh::DofMap::dof_indices(), libMesh::DofMap::dof_indices(), libMesh::DifferentiableSystem::have_first_order_scalar_vars(), libMesh::DifferentiableSystem::have_second_order_scalar_vars(), main(), libMesh::DifferentiablePhysics::nonlocal_mass_residual(), libMesh::DofMap::old_dof_indices(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::SortAndCopy::operator()(), libMesh::BoundaryProjectSolution::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectInteriors::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectVertices::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectEdges::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectSides::operator()(), libMesh::System::project_vector(), libMesh::System::read_SCALAR_dofs(), libMesh::System::read_serialized_vectors(), libMesh::StaticCondensationDofMap::reinit(), libMesh::PetscPreconditioner< T >::set_petsc_aux_data(), libMesh::PetscDMWrapper::set_point_range_in_section(), libMesh::DofMap::should_p_refine(), libMesh::DofMap::should_p_refine(), libMesh::DirectSolutionTransfer::transfer(), libMesh::MeshFunctionSolutionTransfer::transfer(), variable(), libMesh::System::write_parallel_data(), libMesh::System::write_serialized_vector(), and libMesh::System::write_serialized_vectors().

variable()

Variable libMesh::VariableGroup::variable ( unsigned int  v ) const

inline

Returns

A Variable object constructed for an individual member of our group.

Definition at line 285 of file variable.h.

  {
    libmesh_assert_less (v, this->n_variables());
    return Variable (this->system(),
                     this->name(v),
                     this->number(v),
                     this->first_scalar_number(v),
                     this->type(),
                     this->active_subdomains());
  }

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

Referenced by operator()().

Member Data Documentation

_active_subdomains

std::set<subdomain_id_type> libMesh::Variable::_active_subdomains

protectedinherited

Definition at line 187 of file variable.h.

Referenced by libMesh::Variable::active_on_subdomain(), libMesh::Variable::active_subdomains(), libMesh::Variable::implicitly_active(), and libMesh::Variable::operator==().

_first_scalar_number

unsigned int libMesh::Variable::_first_scalar_number

protectedinherited

Definition at line 189 of file variable.h.

Referenced by libMesh::Variable::first_scalar_number(), first_scalar_number(), and libMesh::Variable::operator==().

_name

std::string libMesh::Variable::_name

protectedinherited

Definition at line 186 of file variable.h.

Referenced by libMesh::Variable::name(), and libMesh::Variable::operator==().

_names

std::vector<std::string> libMesh::VariableGroup::_names

protected

Definition at line 344 of file variable.h.

Referenced by append(), n_variables(), name(), and operator==().

_number

unsigned int libMesh::Variable::_number

protectedinherited

Definition at line 188 of file variable.h.

Referenced by libMesh::Variable::number(), and number().

_sys

System* libMesh::Variable::_sys

protectedinherited

Definition at line 185 of file variable.h.

Referenced by libMesh::Variable::operator==(), and libMesh::Variable::system().

_type

FEType libMesh::Variable::_type

protectedinherited

Definition at line 190 of file variable.h.

Referenced by libMesh::Variable::n_components(), libMesh::Variable::n_components(), libMesh::Variable::operator==(), libMesh::Variable::type(), and libMesh::Variable::type().

---

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

• include/base/variable.h