libMesh::Variable Class Reference

This class defines the notion of a variable in the system. More...

#include <variable.h>

Inheritance diagram for libMesh::Variable:

Public Member Functions
	Variable (System *sys, std::string var_name, const unsigned int var_number, const unsigned int first_scalar_num, const FEType &var_type)
	Constructor. More...
	Variable (System *sys, std::string var_name, 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. More...
	Variable (const Variable &)=default
	Standard constructors. More...
Variable &	operator= (const Variable &)=default
	Variable (Variable &&)=default
Variable &	operator= (Variable &&)=default
bool	operator== (const Variable &other) const
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
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
System *	_sys
std::string	_name
std::set< subdomain_id_type >	_active_subdomains
unsigned int	_number
unsigned int	_first_scalar_number
FEType	_type

Detailed Description

This class defines the notion of a variable in the system.

A variable is one of potentially several unknowns in the problem at hand. A variable is described by a unique name, a finite element approximation family, and (optionally) a list of subdomains to which the variable is restricted.

Author

Roy Stogner

Date

2010 A variable which is solved for in a System of equations.

Definition at line 50 of file variable.h.

Constructor & Destructor Documentation

Variable() [1/4]

libMesh::Variable::Variable ( System *  sys, std::string  var_name, 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 59 of file variable.h.

Referenced by libMesh::VariableGroup::variable().

                                     :
    _sys(sys),
    _name(std::move(var_name)),
    _active_subdomains(),
    _number(var_number),
    _first_scalar_number(first_scalar_num),
    _type(var_type)
  {}

Variable() [2/4]

libMesh::Variable::Variable ( System *  sys, std::string  var_name, 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 76 of file variable.h.

                                                                     :
    _sys(sys),
    _name(std::move(var_name)),
    _active_subdomains(var_active_subdomains),
    _number(var_number),
    _first_scalar_number(first_scalar_num),
    _type(var_type)
  {}

Variable() [3/4]

libMesh::Variable::Variable ( const Variable &  )

default

Standard constructors.

Variable() [4/4]

libMesh::Variable::Variable ( Variable &&  )

default

Member Function Documentation

active_on_subdomain()

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

inline

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.

References _active_subdomains.

Referenced by libMesh::ExactSolution::_compute_error(), libMesh::DofMap::_dof_indices(), libMesh::EquationSystems::build_discontinuous_solution_vector(), libMesh::EquationSystems::build_parallel_elemental_solution_vector(), libMesh::EquationSystems::build_parallel_solution_vector(), libMesh::FEGenericBase< FEOutputType< T >::type >::compute_proj_constraints(), libMesh::DofMap::distribute_local_dofs_node_major(), libMesh::DofMap::distribute_local_dofs_var_major(), 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::BoundaryProjectSolution::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::SortAndCopy::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectInteriors::operator()(), libMesh::DofMap::reinit(), and libMesh::Nemesis_IO_Helper::write_nodal_solution().

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

active_subdomains()

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

inline

Returns

The set of subdomain ids this variable lives on.

Definition at line 181 of file variable.h.

References _active_subdomains.

Referenced by libMesh::DifferentiableSystem::add_second_order_dot_vars(), libMesh::System::add_variable(), libMesh::EquationSystems::get_vars_active_subdomains(), main(), libMesh::System::point_gradient(), libMesh::System::point_hessian(), libMesh::System::point_value(), libMesh::VariableGroup::variable(), and libMesh::System::write_header().

  { return _active_subdomains; }

first_scalar_number()

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

inline

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.

References _first_scalar_number.

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

  { return _first_scalar_number; }

implicitly_active()

bool libMesh::Variable::implicitly_active ( ) const

inline

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.

References _active_subdomains.

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

  { return _active_subdomains.empty(); }

n_components() [1/2]

unsigned int libMesh::Variable::n_components

(

)

const

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.

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

Referenced by libMesh::System::n_components(), libMesh::BoundaryVolumeSolutionTransfer::transfer_boundary_volume(), and libMesh::BoundaryVolumeSolutionTransfer::transfer_volume_boundary().

{
  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;
}

n_components() [2/2]

unsigned int libMesh::Variable::n_components

(

const MeshBase &

mesh

)

const

Returns

The number of components of this variable

Definition at line 36 of file variable.C.

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

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

name()

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

inline

Returns

The user-specified name of the variable.

Definition at line 122 of file variable.h.

References _name.

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

  { return _name; }

number()

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

inline

Returns

The rank of this variable in the system.

Definition at line 128 of file variable.h.

References _number.

Referenced by libMesh::MeshFunctionSolutionTransfer::transfer(), libMesh::DirectSolutionTransfer::transfer(), libMesh::MeshfreeSolutionTransfer::transfer(), libMesh::BoundaryVolumeSolutionTransfer::transfer_boundary_volume(), libMesh::BoundaryVolumeSolutionTransfer::transfer_volume_boundary(), and libMesh::VariableGroup::variable().

  { return _number; }

operator=() [1/2]

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

default

operator=() [2/2]

Variable& libMesh::Variable::operator= ( Variable &&  )

default

operator==()

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

inline

Returns

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

Definition at line 102 of file variable.h.

References _active_subdomains, _first_scalar_number, _name, _sys, and _type.

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

system()

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

inline

Returns

A pointer to the System this Variable is part of.

Definition at line 114 of file variable.h.

References _sys.

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

  {
    return _sys;
  }

type()

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

inline

Returns

The FEType for this variable.

Definition at line 144 of file variable.h.

References _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::FEMSystem::assembly(), libMesh::FEGenericBase< FEOutputType< T >::type >::compute_proj_constraints(), libMesh::FirstOrderUnsteadySolver::compute_second_order_eqns(), libMesh::DofMap::distribute_dofs(), libMesh::DofMap::distribute_local_dofs_node_major(), libMesh::DofMap::distribute_local_dofs_var_major(), libMesh::DofMap::distribute_scalar_dofs(), libMesh::DofMap::dof_indices(), libMesh::System::get_info(), main(), libMesh::DifferentiablePhysics::nonlocal_mass_residual(), libMesh::DofMap::old_dof_indices(), libMesh::BoundaryProjectSolution::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::SortAndCopy::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::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectInteriors::operator()(), libMesh::System::project_vector(), libMesh::System::read_parallel_data(), libMesh::System::read_SCALAR_dofs(), libMesh::StaticCondensationDofMap::reinit(), libMesh::DofMap::reinit(), libMesh::DofMap::SCALAR_dof_indices(), libMesh::PetscDMWrapper::set_point_range_in_section(), libMesh::MeshFunctionSolutionTransfer::transfer(), libMesh::DirectSolutionTransfer::transfer(), libMesh::VariableGroup::variable(), libMesh::System::write_parallel_data(), and libMesh::System::write_serialized_vector().

  { return _type; }

Member Data Documentation

_active_subdomains

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

protected

Definition at line 187 of file variable.h.

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

_first_scalar_number

unsigned int libMesh::Variable::_first_scalar_number

protected

Definition at line 189 of file variable.h.

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

_name

std::string libMesh::Variable::_name

protected

Definition at line 186 of file variable.h.

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

_number

unsigned int libMesh::Variable::_number

protected

Definition at line 188 of file variable.h.

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

_sys

System* libMesh::Variable::_sys

protected

Definition at line 185 of file variable.h.

Referenced by operator==(), and system().

_type

FEType libMesh::Variable::_type

protected

Definition at line 190 of file variable.h.

Referenced by n_components(), operator==(), and type().

---

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

• include/base/variable.h
• src/base/variable.C