libMesh
Public Types | Public Member Functions | Public Attributes | Protected Attributes | List of all members
libMesh::PeriodicBoundaryBase Class Referenceabstract

The base class for defining periodic boundaries. More...

#include <periodic_boundary_base.h>

Inheritance diagram for libMesh::PeriodicBoundaryBase:
[legend]

Public Types

enum  TransformationType { FORWARD =0, INVERSE =1 }
 

Public Member Functions

 PeriodicBoundaryBase ()
 Constructor. More...
 
 PeriodicBoundaryBase (const PeriodicBoundaryBase &other)
 Copy constructor. More...
 
virtual ~PeriodicBoundaryBase ()
 Destructor. More...
 
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. More...
 
virtual std::unique_ptr< PeriodicBoundaryBaseclone (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. More...
 
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. More...
 
void set_transformation_matrix (const DenseMatrix< Real > &matrix)
 Set the transformation matrix. More...
 
const std::set< unsigned int > & get_variables () const
 Get the set of variables for this periodic boundary condition. More...
 

Public Attributes

boundary_id_type myboundary
 The boundary ID of this boundary and its counterpart. More...
 
boundary_id_type pairedboundary
 

Protected Attributes

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

Detailed Description

The base class for defining periodic boundaries.

Author
Roy Stogner
Date
2010 Base class for all PeriodicBoundary implementations.

Definition at line 49 of file periodic_boundary_base.h.

Member Enumeration Documentation

◆ TransformationType

Constructor & Destructor Documentation

◆ PeriodicBoundaryBase() [1/2]

libMesh::PeriodicBoundaryBase::PeriodicBoundaryBase ( )

Constructor.

◆ PeriodicBoundaryBase() [2/2]

libMesh::PeriodicBoundaryBase::PeriodicBoundaryBase ( const PeriodicBoundaryBase other)

Copy constructor.

◆ ~PeriodicBoundaryBase()

virtual libMesh::PeriodicBoundaryBase::~PeriodicBoundaryBase ( )
virtual

Destructor.

Definition at line 74 of file periodic_boundary_base.h.

74 {}

Member Function Documentation

◆ clone()

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.

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

Implemented in libMesh::PeriodicBoundary.

◆ get_corresponding_pos()

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.

Implemented in libMesh::PeriodicBoundary.

◆ get_transformation_matrix()

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.

◆ get_variables()

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

Get the set of variables for this periodic boundary condition.

◆ has_transformation_matrix()

bool libMesh::PeriodicBoundaryBase::has_transformation_matrix ( ) const
Returns
true if _transformation_matrix is not null.

◆ is_my_variable()

bool libMesh::PeriodicBoundaryBase::is_my_variable ( unsigned int  var_num) const

◆ merge()

void libMesh::PeriodicBoundaryBase::merge ( const PeriodicBoundaryBase pb)

◆ set_transformation_matrix()

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.

◆ set_variable()

void libMesh::PeriodicBoundaryBase::set_variable ( unsigned int  var)

Member Data Documentation

◆ _transformation_matrix

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 exaple, 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.

Definition at line 147 of file periodic_boundary_base.h.

◆ myboundary

boundary_id_type libMesh::PeriodicBoundaryBase::myboundary

The boundary ID of this boundary and its counterpart.

Definition at line 59 of file periodic_boundary_base.h.

◆ pairedboundary

boundary_id_type libMesh::PeriodicBoundaryBase::pairedboundary

Definition at line 59 of file periodic_boundary_base.h.

◆ variables

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

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

Definition at line 135 of file periodic_boundary_base.h.


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