libMesh::FEMFunctionBase< Output > Class Template Referenceabstract

#include <dirichlet_boundaries.h>

Inheritance diagram for libMesh::FEMFunctionBase< Output >:

Public Member Functions

virtual ~FEMFunctionBase ()
 
virtual void init_context (const FEMContext &)
 
virtual UniquePtr< FEMFunctionBase< Output > > clone () const =0
 
virtual Output operator() (const FEMContext &, const Point &p, const Real time=0.)=0
 
void operator() (const FEMContext &, const Point &p, DenseVector< Output > &output)
 
virtual void operator() (const FEMContext &, const Point &p, const Real time, DenseVector< Output > &output)=0
 
virtual Output component (const FEMContext &, unsigned int i, const Point &p, Real time=0.)
 

Protected Member Functions

 FEMFunctionBase ()
 

Detailed Description

template<typename Output = Number>
class libMesh::FEMFunctionBase< Output >

FEMFunctionBase is a base class from which users can derive in order to define "function-like" objects that can be used within FEMSystem.

Author
Roy Stogner
Date
2012

Definition at line 43 of file dirichlet_boundaries.h.

Constructor & Destructor Documentation

template<typename Output = Number>
libMesh::FEMFunctionBase< Output >::FEMFunctionBase ( )
inlineprotected

Constructor.

Definition at line 55 of file fem_function_base.h.

55 {}
template<typename Output = Number>
virtual libMesh::FEMFunctionBase< Output >::~FEMFunctionBase ( )
inlinevirtual

Destructor.

Definition at line 62 of file fem_function_base.h.

62 {}

Member Function Documentation

template<typename Output = Number>
virtual UniquePtr<FEMFunctionBase<Output> > libMesh::FEMFunctionBase< Output >::clone ( ) const
pure virtual
Returns
A new copy of the function.

The new copy should be as "deep" as necessary to allow independent destruction and simultaneous evaluations of the copies in different threads.

Implemented in libMesh::CompositeFEMFunction< Output >, libMesh::ParsedFEMFunction< Output >, libMesh::ParsedFEMFunction< T >, libMesh::WrappedFunctor< Output >, and libMesh::ConstFEMFunction< Output >.

Referenced by libMesh::CompositeFEMFunction< Output >::attach_subfunction(), libMesh::DirichletBoundary::DirichletBoundary(), and libMesh::FEMFunctionBase< Output >::init_context().

template<typename Output >
Output libMesh::FEMFunctionBase< Output >::component ( const FEMContext context,
unsigned int  i,
const Point p,
Real  time = 0. 
)
inlinevirtual
Returns
The vector component i at coordinate p and time time.
Note
Subclasses aren't required to override this, since the default implementation is based on the full vector evaluation, which is often correct.
Subclasses are recommended to override this, since the default implementation is based on a vector evaluation, which is usually unnecessarily inefficient.

Reimplemented in libMesh::CompositeFEMFunction< Output >, libMesh::ParsedFEMFunction< Output >, libMesh::ParsedFEMFunction< T >, and libMesh::WrappedFunctor< Output >.

Definition at line 131 of file fem_function_base.h.

Referenced by libMesh::FEMFunctionBase< Output >::init_context(), and libMesh::System::project_vector().

135 {
136  DenseVector<Output> outvec(i+1);
137  (*this)(context, p, time, outvec);
138  return outvec(i);
139 }
template<typename Output = Number>
virtual void libMesh::FEMFunctionBase< Output >::init_context ( const FEMContext )
inlinevirtual

Prepares a context object for use.

Most problems will want to reimplement this for efficiency, in order to call FE::get_*() as their particular function requires.

Reimplemented in libMesh::ParsedFEMFunction< Output >, and libMesh::ParsedFEMFunction< T >.

Definition at line 71 of file fem_function_base.h.

References libMesh::FEMFunctionBase< Output >::clone(), libMesh::FEMFunctionBase< Output >::component(), libMesh::FEMFunctionBase< Output >::operator()(), and libMesh::Real.

71 {}
template<typename Output = Number>
virtual Output libMesh::FEMFunctionBase< Output >::operator() ( const FEMContext ,
const Point p,
const Real  time = 0. 
)
pure virtual
Returns
The scalar function value at coordinate p and time time, which defaults to zero.

Pure virtual, so you have to override it.

Implemented in libMesh::CompositeFEMFunction< Output >, libMesh::ParsedFEMFunction< Output >, libMesh::ParsedFEMFunction< T >, libMesh::WrappedFunctor< Output >, and libMesh::ConstFEMFunction< Output >.

Referenced by libMesh::FEMFunctionBase< Output >::init_context(), and libMesh::FEMFunctionBase< Output >::operator()().

template<typename Output >
void libMesh::FEMFunctionBase< Output >::operator() ( const FEMContext context,
const Point p,
DenseVector< Output > &  output 
)
inline

Evaluation function for time-independent vector-valued functions. Sets output values in the passed-in output DenseVector.

Definition at line 143 of file fem_function_base.h.

References libMesh::FEMFunctionBase< Output >::operator()().

146 {
147  // Call the time-dependent function with t=0.
148  this->operator()(context, p, 0., output);
149 }
virtual Output operator()(const FEMContext &, const Point &p, const Real time=0.)=0
template<typename Output = Number>
virtual void libMesh::FEMFunctionBase< Output >::operator() ( const FEMContext ,
const Point p,
const Real  time,
DenseVector< Output > &  output 
)
pure virtual

Evaluation function for time-dependent vector-valued functions. Sets output values in the passed-in output DenseVector.

Pure virtual, so you have to override it.

Implemented in libMesh::CompositeFEMFunction< Output >, libMesh::ParsedFEMFunction< Output >, libMesh::WrappedFunctor< Output >, and libMesh::ConstFEMFunction< Output >.


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