libMesh::PeriodicBoundaryBase类 参考

The base class for defining periodic boundaries. 更多...

#include <periodic_boundary_base.h>

类 libMesh::PeriodicBoundaryBase 继承关系图:

Public 类型
enum	TransformationType { FORWARD =0, INVERSE =1 }

Public 成员函数
	PeriodicBoundaryBase ()
	Constructor. 更多...
	PeriodicBoundaryBase (const PeriodicBoundaryBase &other)
	Copy constructor. 更多...
virtual	~PeriodicBoundaryBase ()=default
	Destructor. 更多...
virtual Point	get_corresponding_pos (const Point &pt) const =0
	This function should be overridden by derived classes to define how one finds corresponding nodes on the periodic boundary pair. 更多...
virtual std::unique_ptr < PeriodicBoundaryBase >	clone (TransformationType t=FORWARD) const =0
	If we want the DofMap to be able to make copies of references and store them in the underlying map, this class must be clone'able, i.e. 更多...
void	set_variable (unsigned int var)
void	merge (const PeriodicBoundaryBase &pb)
bool	is_my_variable (unsigned int var_num) const
bool	has_transformation_matrix () const
const DenseMatrix< Real > &	get_transformation_matrix () const
	Get the transformation matrix, if it is defined. 更多...
void	set_transformation_matrix (const DenseMatrix< Real > &matrix)
	Set the transformation matrix. 更多...
const std::set< unsigned int > &	get_variables () const
	Get the set of variables for this periodic boundary condition. 更多...

Public 属性
boundary_id_type	myboundary
	The boundary ID of this boundary and its counterpart. 更多...
boundary_id_type	pairedboundary

Protected 属性
std::set< unsigned int >	variables
	Set of variables for this periodic boundary, empty means all variables possible. 更多...
std::unique_ptr< DenseMatrix < Real > >	_transformation_matrix
	A DenseMatrix that defines the mapping of variables on this boundary and the counterpart boundary. 更多...

详细描述

The base class for defining periodic boundaries.

作者

Roy Stogner

日期

2010 Base class for all PeriodicBoundary implementations.

在文件 periodic_boundary_base.h 第 48 行定义.

成员枚举类型说明

enum libMesh::PeriodicBoundaryBase::TransformationType

枚举值
FORWARD
INVERSE

在文件 periodic_boundary_base.h 第 51 行定义.

    { FORWARD=0,
      INVERSE=1 };

构造及析构函数说明

libMesh::PeriodicBoundaryBase::PeriodicBoundaryBase

(

)

Constructor.

在文件 periodic_boundary_base.C 第 34 行定义.

                                           :
  myboundary(BoundaryInfo::invalid_id),
  pairedboundary(BoundaryInfo::invalid_id)
{
}

libMesh::PeriodicBoundaryBase::PeriodicBoundaryBase

(

const PeriodicBoundaryBase &

other

)

Copy constructor.

在文件 periodic_boundary_base.C 第 42 行定义.

参考 _transformation_matrix.

                                                                         :
  myboundary(o.myboundary),
  pairedboundary(o.pairedboundary),
  variables(o.variables)
{
  // Make a deep copy of _transformation_matrix, if it's not null
  if(o._transformation_matrix)
  {
    this->_transformation_matrix = std::make_unique<DenseMatrix<Real>>();
    *(this->_transformation_matrix) = *(o._transformation_matrix);
  }
}

virtual libMesh::PeriodicBoundaryBase::~PeriodicBoundaryBase ( )

virtualdefault

Destructor.

成员函数说明

virtual std::unique_ptr<PeriodicBoundaryBase> libMesh::PeriodicBoundaryBase::clone ( TransformationType  t = FORWARD ) const

pure virtual

If we want the DofMap to be able to make copies of references and store them in the underlying map, this class must be clone'able, i.e.

have a kind of virtual construction mechanism. The user can also pass a flag to enable an 'inverse transformation' to be cloned from a forward transformation. The simplest way to implement a clone function like this is in terms of a copy constructor, see periodic_boundary.h.

注解

Not every transformation needs to provide an automatic way to clone an inverse: you can simply add a pair of PeriodicBoundaryBase objects using the appropriate DofMap interface instead.

在 libMesh::PeriodicBoundary 内被实现.

参考自 libMesh::DofMap::add_periodic_boundary().

virtual Point libMesh::PeriodicBoundaryBase::get_corresponding_pos ( const Point &  pt ) const

pure virtual

This function should be overridden by derived classes to define how one finds corresponding nodes on the periodic boundary pair.

在 libMesh::PeriodicBoundary 内被实现.

参考自 libMesh::PeriodicBoundaries::neighbor().

const DenseMatrix< Real > & libMesh::PeriodicBoundaryBase::get_transformation_matrix

(

)

const

Get the transformation matrix, if it is defined.

Throw an error if it is not defined.

在文件 periodic_boundary_base.C 第 86 行定义.

参考 _transformation_matrix , 以及 has_transformation_matrix().

{
  libmesh_error_msg_if(!has_transformation_matrix(),
                       "Transformation matrix is not defined");

  return *_transformation_matrix;
}

const std::set< unsigned int > & libMesh::PeriodicBoundaryBase::get_variables

(

)

const

Get the set of variables for this periodic boundary condition.

在文件 periodic_boundary_base.C 第 109 行定义.

参考 variables.

{
  return variables;
}

bool libMesh::PeriodicBoundaryBase::has_transformation_matrix

(

)

const

返回

true if _transformation_matrix is not null.

在文件 periodic_boundary_base.C 第 79 行定义.

参考 _transformation_matrix.

参考自 get_transformation_matrix().

{
  return bool(_transformation_matrix);
}

bool libMesh::PeriodicBoundaryBase::is_my_variable

(

unsigned int

var_num

)

const

在文件 periodic_boundary_base.C 第 71 行定义.

参考 variables.

{
  bool a = variables.empty() || (!variables.empty() && variables.find(var_num) != variables.end());
  return a;
}

void libMesh::PeriodicBoundaryBase::merge

(

const PeriodicBoundaryBase &

pb

)

在文件 periodic_boundary_base.C 第 64 行定义.

参考 variables.

参考自 libMesh::DofMap::add_periodic_boundary().

{
  variables.insert(pb.variables.begin(), pb.variables.end());
}

void libMesh::PeriodicBoundaryBase::set_transformation_matrix

(

const DenseMatrix< Real > &

matrix

)

Set the transformation matrix.

When calling this method we require the following conditions: 1) matrix is square with size that matches this->variables.size() 2) the list of variables in this->variables set must all have the same FE type Both of these conditions are asserted in DBG mode.

在文件 periodic_boundary_base.C 第 96 行定义.

参考 _transformation_matrix , 以及 variables.

{
  // Make a deep copy of matrix
  this->_transformation_matrix = std::make_unique<DenseMatrix<Real>>();
  *(this->_transformation_matrix) = matrix;

  // if _transformation_matrix is defined then it must be the same sie as variables.
  libmesh_assert_equal_to(_transformation_matrix->m(), variables.size());
  libmesh_assert_equal_to(_transformation_matrix->n(), variables.size());
}

void libMesh::PeriodicBoundaryBase::set_variable

(

unsigned int

var

)

在文件 periodic_boundary_base.C 第 57 行定义.

参考 variables.

{
  variables.insert(var);
}

类成员变量说明

std::unique_ptr<DenseMatrix<Real> > libMesh::PeriodicBoundaryBase::_transformation_matrix

protected

A DenseMatrix that defines the mapping of variables on this boundary and the counterpart boundary.

This is necessary for periodic-boundaries with vector-valued quantities (e.g. velocity or displacement) on a sector of a circular domain, for example, since in that case we must map each variable to a corresponding linear combination of all the variables. We store the DenseMatrix via a unique_ptr, and an uninitialized pointer is treated as equivalent to the identity matrix.

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

参考自 get_transformation_matrix(), has_transformation_matrix(), PeriodicBoundaryBase() , 以及 set_transformation_matrix().

boundary_id_type libMesh::PeriodicBoundaryBase::myboundary

The boundary ID of this boundary and its counterpart.

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

参考自 libMesh::DofMap::add_periodic_boundary() , 以及 libMesh::PeriodicBoundary::PeriodicBoundary().

boundary_id_type libMesh::PeriodicBoundaryBase::pairedboundary

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

参考自 libMesh::DofMap::add_periodic_boundary(), libMesh::PeriodicBoundaries::neighbor() , 以及 libMesh::PeriodicBoundary::PeriodicBoundary().

std::set<unsigned int> libMesh::PeriodicBoundaryBase::variables

protected

Set of variables for this periodic boundary, empty means all variables possible.

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

参考自 get_variables(), is_my_variable(), merge(), set_transformation_matrix() , 以及 set_variable().

---

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

• /home/lwz/libmesh/include/base/periodic_boundary_base.h
• /home/lwz/libmesh/src/base/periodic_boundary_base.C