libMesh::Variable类 参考

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

#include <variable.h>

类 libMesh::Variable 继承关系图:

Public 成员函数
	Variable (System *sys, std::string var_name, const unsigned int var_number, const unsigned int first_scalar_num, const FEType &var_type)
	Constructor. 更多...
	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. 更多...
	Variable (const Variable &)=default
	Standard constructors. 更多...
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
bool	active_on_subdomain (subdomain_id_type sid) const
bool	implicitly_active () const
const std::set < subdomain_id_type > &	active_subdomains () const

Protected 属性
System *	_sys
std::string	_name
std::set< subdomain_id_type >	_active_subdomains
unsigned int	_number
unsigned int	_first_scalar_number
FEType	_type

详细描述

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.

作者

Roy Stogner

日期

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

在文件 variable.h 第 49 行定义.

构造及析构函数说明

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.

在文件 variable.h 第 58 行定义.

参考自 libMesh::VariableGroup::variable().

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

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.

在文件 variable.h 第 75 行定义.

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

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

default

Standard constructors.

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

default

成员函数说明

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

inline

返回

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

注解

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

在文件 variable.h 第 157 行定义.

参考 _active_subdomains.

参考自 libMesh::DofMap::_dof_indices(), libMesh::DofMap::distribute_local_dofs_node_major(), libMesh::DofMap::distribute_local_dofs_var_major(), libMesh::DofMap::dof_indices(), libMesh::DofMap::local_variable_indices(), libMesh::DofMap::old_dof_indices() , 以及 libMesh::DofMap::reinit().

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

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

inline

返回

The set of subdomain ids this variable lives on.

在文件 variable.h 第 171 行定义.

参考 _active_subdomains.

参考自 libMesh::VariableGroup::variable().

  { return _active_subdomains; }

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

inline

返回

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

在文件 variable.h 第 134 行定义.

参考 _first_scalar_number.

参考自 libMesh::VariableGroup::variable().

  { return _first_scalar_number; }

bool libMesh::Variable::implicitly_active ( ) const

inline

返回

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.

在文件 variable.h 第 165 行定义.

参考 _active_subdomains.

  { return _active_subdomains.empty(); }

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

inline

返回

The number of components of this variable.

在文件 variable.h 第 146 行定义.

参考 _type , 以及 type().

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

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

inline

返回

The user-specified name of the variable.

在文件 variable.h 第 121 行定义.

参考 _name.

参考自 libMesh::VariableGroup::variable().

  { return _name; }

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

inline

返回

The rank of this variable in the system.

在文件 variable.h 第 127 行定义.

参考 _number.

参考自 libMesh::VariableGroup::variable().

  { return _number; }

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

default

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

default

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

inline

返回

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

在文件 variable.h 第 101 行定义.

参考 _active_subdomains, _first_scalar_number, _name, _sys , 以及 _type.

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

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

inline

返回

A pointer to the System this Variable is part of.

在文件 variable.h 第 113 行定义.

参考 _sys.

参考自 libMesh::VariableGroup::variable().

  {
    return _sys;
  }

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

inline

返回

The FEType for this variable.

在文件 variable.h 第 140 行定义.

参考 _type.

参考自 libMesh::DofMap::_dof_indices(), libMesh::DofMap::_node_dof_indices(), 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(), n_components(), libMesh::DofMap::old_dof_indices(), libMesh::DofMap::reinit(), libMesh::DofMap::SCALAR_dof_indices() , 以及 libMesh::VariableGroup::variable().

  { return _type; }

类成员变量说明

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

protected

在文件 variable.h 第 177 行定义.

参考自 active_on_subdomain(), active_subdomains(), implicitly_active() , 以及 operator==().

unsigned int libMesh::Variable::_first_scalar_number

protected

在文件 variable.h 第 179 行定义.

参考自 first_scalar_number(), libMesh::VariableGroup::first_scalar_number() , 以及 operator==().

std::string libMesh::Variable::_name

protected

在文件 variable.h 第 176 行定义.

参考自 name() , 以及 operator==().

unsigned int libMesh::Variable::_number

protected

在文件 variable.h 第 178 行定义.

参考自 number() , 以及 libMesh::VariableGroup::number().

System* libMesh::Variable::_sys

protected

在文件 variable.h 第 175 行定义.

参考自 operator==() , 以及 system().

FEType libMesh::Variable::_type

protected

在文件 variable.h 第 180 行定义.

参考自 n_components(), operator==() , 以及 type().

---

该类的文档由以下文件生成:

• /home/lwz/libmesh/include/base/variable.h