libMesh::VariableGroup类 参考

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

#include <variable.h>

类 libMesh::VariableGroup 继承关系图:

Public 成员函数
	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. 更多...
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 属性
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

详细描述

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.

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

构造及析构函数说明

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.

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

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

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.

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

                                                                          :

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

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

default

Standard constructors.

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

default

成员函数说明

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

inlineinherited

返回

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 行定义.

参考 libMesh::Variable::_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

inlineinherited

返回

The set of subdomain ids this variable lives on.

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

参考 libMesh::Variable::_active_subdomains.

参考自 variable().

  { return _active_subdomains; }

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.

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

参考 _names.

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

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

inlineinherited

返回

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

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

参考 libMesh::Variable::_first_scalar_number.

参考自 variable().

  { 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.

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

参考 libMesh::Variable::_first_scalar_number , 以及 n_variables().

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

bool libMesh::Variable::implicitly_active ( ) const

inlineinherited

返回

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 行定义.

参考 libMesh::Variable::_active_subdomains.

  { return _active_subdomains.empty(); }

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

inlineinherited

返回

The number of components of this variable.

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

参考 libMesh::Variable::_type , 以及 libMesh::Variable::type().

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

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

inline

返回

The number of variables in this VariableGroup

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

参考 _names.

参考自 libMesh::DofMap::add_variable_group(), libMesh::DofMap::distribute_local_dofs_node_major(), libMesh::DofMap::distribute_local_dofs_var_major(), libMesh::DofMap::distribute_scalar_dofs(), libMesh::DofMap::dof_indices(), first_scalar_number(), name(), number(), libMesh::DofMap::old_dof_indices(), libMesh::DofMap::reinit() , 以及 variable().

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

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

inlineinherited

返回

The user-specified name of the variable.

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

参考 libMesh::Variable::_name.

参考自 variable().

  { return _name; }

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

inline

返回

The user-specified name of the variable.

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

参考 _names , 以及 n_variables().

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

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

inlineinherited

返回

The rank of this variable in the system.

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

参考 libMesh::Variable::_number.

参考自 variable().

  { return _number; }

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

inline

返回

The rank of this variable in the system.

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

参考 libMesh::Variable::_number , 以及 n_variables().

参考自 libMesh::DofMap::dof_indices() , 以及 libMesh::DofMap::old_dof_indices().

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

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

inline

Support vg(v).

返回

A Variable for v.

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

参考 variable().

  { return this->variable(v); }

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

default

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

default

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

inlineinherited

返回

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

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

参考 libMesh::Variable::_active_subdomains, libMesh::Variable::_first_scalar_number, libMesh::Variable::_name, libMesh::Variable::_sys , 以及 libMesh::Variable::_type.

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

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

inline

返回

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

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

参考 _names.

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

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

inlineinherited

返回

A pointer to the System this Variable is part of.

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

参考 libMesh::Variable::_sys.

参考自 variable().

  {
    return _sys;
  }

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

inlineinherited

返回

The FEType for this variable.

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

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

  { return _type; }

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

inline

返回

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

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

参考 libMesh::Variable::active_subdomains(), libMesh::Variable::first_scalar_number(), n_variables(), libMesh::Variable::name(), libMesh::Variable::number(), libMesh::Variable::system(), libMesh::Variable::type() , 以及 libMesh::Variable::Variable().

参考自 operator()().

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

类成员变量说明

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

protectedinherited

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

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

unsigned int libMesh::Variable::_first_scalar_number

protectedinherited

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

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

std::string libMesh::Variable::_name

protectedinherited

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

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

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

protected

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

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

unsigned int libMesh::Variable::_number

protectedinherited

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

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

System* libMesh::Variable::_sys

protectedinherited

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

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

FEType libMesh::Variable::_type

protectedinherited

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

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

---

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

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