libMesh::PeriodicBoundary Class Reference

The definition of a periodic boundary. More...

#include <periodic_boundary.h>

Inheritance diagram for libMesh::PeriodicBoundary:

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

Public Member Functions
	PeriodicBoundary ()
	Constructor. More...
virtual	~PeriodicBoundary ()=default
	Destructor. More...
	PeriodicBoundary (const PeriodicBoundary &o, TransformationType t=FORWARD)
	Copy constructor, with option for the copy to represent an inverse transformation. More...
	PeriodicBoundary (const RealVectorValue &vector)
	Constructor taking a reference to the translation vector. More...
virtual Point	get_corresponding_pos (const Point &pt) const override
	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< PeriodicBoundaryBase >	clone (TransformationType t=FORWARD) const override
	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
RealVectorValue	translation_vector
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 definition of a periodic boundary.

Author

Roy Stogner

Date

2010 Used for implementing periodic BCs via constraints.

Definition at line 44 of file periodic_boundary.h.

Member Enumeration Documentation

TransformationType

enum libMesh::PeriodicBoundaryBase::TransformationType

inherited

Enumerator
FORWARD
INVERSE

Definition at line 51 of file periodic_boundary_base.h.

    { FORWARD=0,
      INVERSE=1 };

Constructor & Destructor Documentation

PeriodicBoundary() [1/3]

libMesh::PeriodicBoundary::PeriodicBoundary

(

)

Constructor.

Definition at line 33 of file periodic_boundary.C.

                                   :
  PeriodicBoundaryBase(),
  translation_vector()
{
}

~PeriodicBoundary()

virtual libMesh::PeriodicBoundary::~PeriodicBoundary ( )

virtualdefault

Destructor.

PeriodicBoundary() [2/3]

libMesh::PeriodicBoundary::PeriodicBoundary	(	const PeriodicBoundary &	o,
		TransformationType	t = FORWARD
	)

Copy constructor, with option for the copy to represent an inverse transformation.

Definition at line 41 of file periodic_boundary.C.

References libMesh::PeriodicBoundaryBase::INVERSE, libMesh::PeriodicBoundaryBase::myboundary, libMesh::PeriodicBoundaryBase::pairedboundary, and translation_vector.

                                                                                   :
  PeriodicBoundaryBase(o),
  translation_vector(o.translation_vector)
{
  if (t == INVERSE)
    {
      std::swap(myboundary, pairedboundary);
      translation_vector *= -1.0;
    }
}

PeriodicBoundary() [3/3]

libMesh::PeriodicBoundary::PeriodicBoundary

(

const RealVectorValue &

vector

)

Constructor taking a reference to the translation vector.

Definition at line 54 of file periodic_boundary.C.

                                                                 :
  PeriodicBoundaryBase(),
  translation_vector(vector)
{
}

Member Function Documentation

clone()

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

overridevirtual

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.

Implements libMesh::PeriodicBoundaryBase.

Definition at line 69 of file periodic_boundary.C.

{
  return std::make_unique<PeriodicBoundary>(*this, t);
}

get_corresponding_pos()

Point libMesh::PeriodicBoundary::get_corresponding_pos ( const Point &  pt ) const

overridevirtual

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

Implements libMesh::PeriodicBoundaryBase.

Definition at line 62 of file periodic_boundary.C.

References translation_vector.

{
  return pt + translation_vector;
}

get_transformation_matrix()

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

inherited

Get the transformation matrix, if it is defined.

Throw an error if it is not defined.

Definition at line 86 of file periodic_boundary_base.C.

References libMesh::PeriodicBoundaryBase::_transformation_matrix, and libMesh::PeriodicBoundaryBase::has_transformation_matrix().

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

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

  return *_transformation_matrix;
}

get_variables()

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

inherited

Get the set of variables for this periodic boundary condition.

Definition at line 109 of file periodic_boundary_base.C.

References libMesh::PeriodicBoundaryBase::variables.

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

{
  return variables;
}

has_transformation_matrix()

bool libMesh::PeriodicBoundaryBase::has_transformation_matrix ( ) const

inherited

Returns

true if _transformation_matrix is not null.

Definition at line 79 of file periodic_boundary_base.C.

References libMesh::PeriodicBoundaryBase::_transformation_matrix.

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

{
  return bool(_transformation_matrix);
}

is_my_variable()

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

inherited

Definition at line 71 of file periodic_boundary_base.C.

References libMesh::PeriodicBoundaryBase::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 )

inherited

Definition at line 64 of file periodic_boundary_base.C.

References libMesh::PeriodicBoundaryBase::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 )

inherited

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 96 of file periodic_boundary_base.C.

References libMesh::PeriodicBoundaryBase::_transformation_matrix, and libMesh::PeriodicBoundaryBase::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());
}

set_variable()

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

inherited

Definition at line 57 of file periodic_boundary_base.C.

References libMesh::PeriodicBoundaryBase::variables.

{
  variables.insert(var);
}

Member Data Documentation

_transformation_matrix

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

protectedinherited

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.

Definition at line 146 of file periodic_boundary_base.h.

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

myboundary

boundary_id_type libMesh::PeriodicBoundaryBase::myboundary

inherited

The boundary ID of this boundary and its counterpart.

Definition at line 58 of file periodic_boundary_base.h.

Referenced by libMesh::DofMap::add_periodic_boundary(), Biharmonic::JR::JR(), main(), PeriodicBoundary(), and PeriodicBCTest::testPeriodicBC().

pairedboundary

boundary_id_type libMesh::PeriodicBoundaryBase::pairedboundary

inherited

Definition at line 58 of file periodic_boundary_base.h.

Referenced by libMesh::DofMap::add_periodic_boundary(), libMesh::FEGenericBase< FEOutputType< T >::type >::compute_periodic_constraints(), Biharmonic::JR::JR(), main(), libMesh::PeriodicBoundaries::neighbor(), PeriodicBoundary(), and PeriodicBCTest::testPeriodicBC().

translation_vector

RealVectorValue libMesh::PeriodicBoundary::translation_vector

protected

Definition at line 85 of file periodic_boundary.h.

Referenced by get_corresponding_pos(), and PeriodicBoundary().

variables

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

protectedinherited

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

Definition at line 134 of file periodic_boundary_base.h.

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

---

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

• include/base/periodic_boundary.h
• src/base/periodic_boundary.C