Class documentation of Concepts

Loading...
Searching...
No Matches
concepts::ElementFormulaContainer< F, G > Class Template Reference
Inheritance diagram for concepts::ElementFormulaContainer< F, G >:
concepts::ElementFormula< F, G > concepts::Cloneable concepts::OutputOperator

Public Types

typedefvalue_type
 

Public Member Functions

 ElementFormulaContainer (const F x)
 
 ElementFormulaContainer ()
 
 ElementFormulaContainer (const ElementFormula< F, G > &frm)
 
 ElementFormulaContainer (const RCP< const ElementFormula< F, G > > frm)
 
 ElementFormulaContainer (const ElementFormula< F, G > *frm)
 
 ElementFormulaContainer (const ElementFormulaContainer< F, G > &frm)
 Copy constructor.
 
virtualoperator() (const ElementWithCell< G > &elm, const Real p, const Real t=0.0) const
 
virtualoperator() (const ElementWithCell< G > &elm, const Real1d &p, const Real t=0.0) const
 
virtualoperator() (const ElementWithCell< G > &elm, const Real2d &p, const Real t=0.0) const
 
virtualoperator() (const ElementWithCell< G > &elm, const Real3d &p, const Real t=0.0) const
 
virtual ElementFormulaContainer< F, G > * clone () const
 Virtual copy constructor.
 
const ElementFormula< F, G > & frm () const
 
bool empty () const
 Returns true if no formula is stored.
 

Protected Member Functions

virtual std::ostream & info (std::ostream &os) const
 Returns information in an output stream.
 

Detailed Description

template<class F, typename G = typename Realtype<F>::type>
class concepts::ElementFormulaContainer< F, G >

Definition at line 22 of file elementFormulaContainer.hh.

Member Typedef Documentation

◆ value_type

template<typename F , typename G = typename Realtype<F>::type>
typedef F concepts::ElementFormula< F, G >::value_type
inherited

Definition at line 37 of file elementFormula.hh.

Constructor & Destructor Documentation

◆ ElementFormulaContainer() [1/5]

template<class F , typename G = typename Realtype<F>::type>
concepts::ElementFormulaContainer< F, G >::ElementFormulaContainer ( const F  x)

Special constructor for a constant.

So, a constant can simply given to functions where a ElementFormulaContainer<F,G> is expected.

See also
testsuite/testFormula.cc

◆ ElementFormulaContainer() [2/5]

template<class F , typename G = typename Realtype<F>::type>
concepts::ElementFormulaContainer< F, G >::ElementFormulaContainer ( )
inline

Constructor with no argument

Definition at line 35 of file elementFormulaContainer.hh.

◆ ElementFormulaContainer() [3/5]

template<class F , typename G = typename Realtype<F>::type>
concepts::ElementFormulaContainer< F, G >::ElementFormulaContainer ( const ElementFormula< F, G > &  frm)

Constructor for an element formula, takes a clone

◆ ElementFormulaContainer() [4/5]

template<class F , typename G = typename Realtype<F>::type>
concepts::ElementFormulaContainer< F, G >::ElementFormulaContainer ( const RCP< const ElementFormula< F, G > >  frm)

Constructor for an RCP to an element formula, replaces the own RCP

◆ ElementFormulaContainer() [5/5]

template<class F , typename G = typename Realtype<F>::type>
concepts::ElementFormulaContainer< F, G >::ElementFormulaContainer ( const ElementFormula< F, G > *  frm)
explicit

Constructor for a pointer to an element formula in dynamic memory which will be deleted by this class.

Member Function Documentation

◆ clone()

template<class F , typename G = typename Realtype<F>::type>
virtual ElementFormulaContainer< F, G > * concepts::ElementFormulaContainer< F, G >::clone ( ) const
inlinevirtual

Virtual copy constructor.

Implements concepts::ElementFormula< F, G >.

Definition at line 65 of file elementFormulaContainer.hh.

◆ empty()

template<class F , typename G = typename Realtype<F>::type>
bool concepts::ElementFormulaContainer< F, G >::empty ( ) const
inline

Returns true if no formula is stored.

Definition at line 72 of file elementFormulaContainer.hh.

◆ frm()

template<class F , typename G = typename Realtype<F>::type>
const ElementFormula< F, G > & concepts::ElementFormulaContainer< F, G >::frm ( ) const
inline

Definition at line 69 of file elementFormulaContainer.hh.

◆ info()

template<class F , typename G = typename Realtype<F>::type>
virtual std::ostream & concepts::ElementFormulaContainer< F, G >::info ( std::ostream &  os) const
protectedvirtual

Returns information in an output stream.

Reimplemented from concepts::OutputOperator.

◆ operator()() [1/4]

template<class F , typename G = typename Realtype<F>::type>
virtual F concepts::ElementFormulaContainer< F, G >::operator() ( const ElementWithCell< G > &  elm,
const Real  p,
const Real  t = 0.0 
) const
virtual

Evaluates the formula.

Parameters
elmElement
pPoint in space in local element coordinates
tPoint in time

Implements concepts::ElementFormula< F, G >.

◆ operator()() [2/4]

template<class F , typename G = typename Realtype<F>::type>
virtual F concepts::ElementFormulaContainer< F, G >::operator() ( const ElementWithCell< G > &  elm,
const Real1d p,
const Real  t = 0.0 
) const
inlinevirtual

Definition at line 57 of file elementFormulaContainer.hh.

◆ operator()() [3/4]

template<class F , typename G = typename Realtype<F>::type>
virtual F concepts::ElementFormulaContainer< F, G >::operator() ( const ElementWithCell< G > &  elm,
const Real2d p,
const Real  t = 0.0 
) const
virtual

Evaluates the formula.

Parameters
elmElement
pPoint in space in local element coordinates
tPoint in time

Implements concepts::ElementFormula< F, G >.

◆ operator()() [4/4]

template<class F , typename G = typename Realtype<F>::type>
virtual F concepts::ElementFormulaContainer< F, G >::operator() ( const ElementWithCell< G > &  elm,
const Real3d p,
const Real  t = 0.0 
) const
virtual

Evaluates the formula.

Parameters
elmElement
pPoint in space in local element coordinates
tPoint in time

Implements concepts::ElementFormula< F, G >.


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