FreePOOMA  2.4.1
Public Member Functions
ConstantFaceBC< Dim, T > Class Template Reference

ConstantFaceBC is an Relation functor class. More...

#include <ConstantFaceBC.h>

List of all members.

Public Member Functions

 ConstantFaceBC (int face, const T &constant, bool enforceConstantBoundary=false)
 ConstantFaceBC (const ConstantFaceBC< Dim, T > &model)
template<class Target >
 ConstantFaceBC (const ConstantFaceBC< Dim, T > &init, const Target &t)
ConstantFaceBC< Dim, T > & operator= (const ConstantFaceBC< Dim, T > &rhs)
constant () const
 Constant we set the boundary to.
void setConstant (T newConstant)
 User may want to change the constant's value, e.g., for time-dependence.
int face () const
 Face we operate on.
template<class Target >
void operator() (const Target &t) const

Detailed Description

template<int Dim, class T>
class ConstantFaceBC< Dim, T >

ConstantFaceBC is an Relation functor class.

It represents a Dirichlet boundary condition on a logically rectilinear domain where the value on that face is a constant. The setConstant() function provides a means to have a time-dependent BC. A constructor switch allows the BC to enforce that the mesh-boundary value is zero; this affects only vertex-centered Field values/components because the boundary is defined to be the last vertex.

The T template parameter is the type of the constant value.


Constructor & Destructor Documentation

template<int Dim, class T>
ConstantFaceBC< Dim, T >::ConstantFaceBC ( int  face,
const T &  constant,
bool  enforceConstantBoundary = false 
) [inline]
template<int Dim, class T>
ConstantFaceBC< Dim, T >::ConstantFaceBC ( const ConstantFaceBC< Dim, T > &  model) [inline]
template<int Dim, class T>
template<class Target >
ConstantFaceBC< Dim, T >::ConstantFaceBC ( const ConstantFaceBC< Dim, T > &  init,
const Target &  t 
) [inline]

References PAssert.


Member Function Documentation

template<int Dim, class T>
ConstantFaceBC<Dim, T>& ConstantFaceBC< Dim, T >::operator= ( const ConstantFaceBC< Dim, T > &  rhs) [inline]
template<int Dim, class T>
T ConstantFaceBC< Dim, T >::constant ( ) const [inline]

Constant we set the boundary to.

template<int Dim, class T>
void ConstantFaceBC< Dim, T >::setConstant ( newConstant) [inline]

User may want to change the constant's value, e.g., for time-dependence.

template<int Dim, class T>
int ConstantFaceBC< Dim, T >::face ( ) const [inline]

Face we operate on.

template<int Dim, class T>
template<class Target >
void ConstantFaceBC< Dim, T >::operator() ( const Target &  t) const [inline]

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