libMesh::PeriodicBoundaryBase Class Reference

Base class for all PeriodicBoundary implementations. More...

#include <periodic_boundary_base.h>

Inheritance diagram for libMesh::PeriodicBoundaryBase:

Public Types
enum	TransformationType { FORWARD =0, INVERSE =1 }

Public Member Functions
	PeriodicBoundaryBase ()
	PeriodicBoundaryBase (const PeriodicBoundaryBase &other)
virtual	~PeriodicBoundaryBase ()
virtual Point	get_corresponding_pos (const Point &pt) const =0
virtual std::unique_ptr< PeriodicBoundaryBase >	clone (TransformationType t=FORWARD) const =0
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
void	set_transformation_matrix (const DenseMatrix< Real > &matrix)
const std::set< unsigned int > &	get_variables () const

Public Attributes
boundary_id_type	myboundary
boundary_id_type	pairedboundary

Protected Attributes
std::set< unsigned int >	variables
std::unique_ptr< DenseMatrix< Real > >	_transformation_matrix

Detailed Description

Base class for all PeriodicBoundary implementations.

The base class for defining periodic boundaries.

Author

Roy Stogner

Date

2010

Definition at line 49 of file periodic_boundary_base.h.

Member Enumeration Documentation

TransformationType

enum libMesh::PeriodicBoundaryBase::TransformationType

Enumerator
FORWARD
INVERSE

Definition at line 52 of file periodic_boundary_base.h.

    { FORWARD=0,
      INVERSE=1 };

Constructor & Destructor Documentation

PeriodicBoundaryBase() [1/2]

libMesh::PeriodicBoundaryBase::PeriodicBoundaryBase

(

)

Constructor

Definition at line 29 of file periodic_boundary_base.C.

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

PeriodicBoundaryBase() [2/2]

libMesh::PeriodicBoundaryBase::PeriodicBoundaryBase

(

const PeriodicBoundaryBase &

other

)

Copy constructor

Definition at line 37 of file periodic_boundary_base.C.

References _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 = libmesh_make_unique<DenseMatrix<Real>>();
    *(this->_transformation_matrix) = *(o._transformation_matrix);
  }
}

~PeriodicBoundaryBase()

virtual libMesh::PeriodicBoundaryBase::~PeriodicBoundaryBase ( )

inlinevirtual

Destructor

Definition at line 74 of file periodic_boundary_base.h.

{}

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.

Referenced by libMesh::DofMap::add_periodic_boundary().

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.

Referenced by libMesh::FEGenericBase< FEOutputType< T >::type >::compute_periodic_constraints(), libMesh::FEAbstract::compute_periodic_node_constraints(), and libMesh::PeriodicBoundaries::neighbor().

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.

Definition at line 81 of file periodic_boundary_base.C.

References _transformation_matrix, and has_transformation_matrix().

Referenced by libMesh::FEGenericBase< FEOutputType< T >::type >::compute_periodic_constraints().

{
  if(!has_transformation_matrix())
  {
    libmesh_error_msg("Transformation matrix is not defined");
  }

  return *_transformation_matrix;
}

get_variables()

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

(

)

const

Get the set of variables for this periodic boundary condition.

Definition at line 106 of file periodic_boundary_base.C.

References variables.

Referenced by libMesh::FEGenericBase< FEOutputType< T >::type >::compute_periodic_constraints().

{
  return variables;
}

has_transformation_matrix()

bool libMesh::PeriodicBoundaryBase::has_transformation_matrix

(

)

const

Returns

true if _transformation_matrix is not null.

Definition at line 74 of file periodic_boundary_base.C.

References _transformation_matrix.

Referenced by libMesh::FEGenericBase< FEOutputType< T >::type >::compute_periodic_constraints(), and get_transformation_matrix().

{
  return bool(_transformation_matrix);
}

is_my_variable()

bool libMesh::PeriodicBoundaryBase::is_my_variable

(

unsigned int

var_num

)

const

Definition at line 66 of file periodic_boundary_base.C.

References variables.

Referenced by libMesh::FEGenericBase< FEOutputType< T >::type >::compute_periodic_constraints().

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

merge()

void libMesh::PeriodicBoundaryBase::merge

(

const PeriodicBoundaryBase &

pb

)

Definition at line 59 of file periodic_boundary_base.C.

References variables.

Referenced by libMesh::DofMap::add_periodic_boundary().

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

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.

Definition at line 93 of file periodic_boundary_base.C.

References _transformation_matrix, and variables.

{
  // Make a deep copy of matrix
  this->_transformation_matrix = libmesh_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());
}

set_variable()

void libMesh::PeriodicBoundaryBase::set_variable

(

unsigned int

var

)

Definition at line 52 of file periodic_boundary_base.C.

References variables.

{
  variables.insert(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.

Referenced by get_transformation_matrix(), has_transformation_matrix(), PeriodicBoundaryBase(), and set_transformation_matrix().

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.

Referenced by libMesh::DofMap::add_periodic_boundary(), and libMesh::PeriodicBoundary::PeriodicBoundary().

pairedboundary

boundary_id_type libMesh::PeriodicBoundaryBase::pairedboundary

Definition at line 59 of file periodic_boundary_base.h.

Referenced by libMesh::DofMap::add_periodic_boundary(), libMesh::FEGenericBase< FEOutputType< T >::type >::compute_periodic_constraints(), libMesh::FEAbstract::compute_periodic_node_constraints(), libMesh::PeriodicBoundaries::neighbor(), and libMesh::PeriodicBoundary::PeriodicBoundary().

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.

Referenced by get_variables(), is_my_variable(), merge(), set_transformation_matrix(), and set_variable().

---

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

• periodic_boundary_base.h
• periodic_boundary_base.C