Home | Doxygen Documentation | Tutorials | Developer Tools (restricted)

Public Types | Public Member Functions | Protected Member Functions | Private Attributes
concepts::ElementFormulaContainer< F, G > Class Template Reference

#include <elementFormulaContainer.hh>

Inheritance diagram for concepts::ElementFormulaContainer< F, G >:
Inheritance graph
[legend]
Collaboration diagram for concepts::ElementFormulaContainer< F, G >:
Collaboration graph
[legend]

List of all members.

Public Types

typedef F value_type

Public Member Functions

virtual
ElementFormulaContainer< F, G > * 
clone () const
 Virtual copy constructor.
 ElementFormulaContainer (const F x)
 Special constructor for a constant.
 ElementFormulaContainer (const RCP< const ElementFormula< F, G > > frm)
 Constructor for an RCP to an element formula, replaces the own RCP.
 ElementFormulaContainer ()
 Constructor with no argument.
 ElementFormulaContainer (const ElementFormula< F, G > *frm)
 Constructor for a pointer to an element formula in dynamic memory which will be deleted by this class.
 ElementFormulaContainer (const ElementFormula< F, G > &frm)
 Constructor for an element formula, takes a clone.
 ElementFormulaContainer (const ElementFormulaContainer< F, G > &frm)
 Copy constructor.
bool empty () const
 Returns true if no formula is stored.
const ElementFormula< F, G > & frm () const
virtual F operator() (const ElementWithCell< G > &elm, const Real p, const Real t=0.0) const
 Evaluates the formula.
virtual F operator() (const ElementWithCell< G > &elm, const Real2d &p, const Real t=0.0) const
virtual F operator() (const ElementWithCell< G > &elm, const Real3d &p, const Real t=0.0) const
virtual ~ElementFormulaContainer ()

Protected Member Functions

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

Private Attributes

RCP< const ElementFormula< F, G > > frm_
 Element formula is stored as a RCP.

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

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

Constructor & Destructor Documentation

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
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.

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.

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.

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.

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

Copy constructor.

template<class F, typename G = typename Realtype<F>::type>
virtual concepts::ElementFormulaContainer< F, G >::~ElementFormulaContainer ( ) [virtual]

Member Function Documentation

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

Virtual copy constructor.

Implements concepts::ElementFormula< F, G >.

Definition at line 62 of file elementFormulaContainer.hh.

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 69 of file elementFormulaContainer.hh.

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

Definition at line 66 of file elementFormulaContainer.hh.

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

Returns information in an output stream.

Reimplemented from concepts::OutputOperator.

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]
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 >.

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]

Member Data Documentation

template<class F, typename G = typename Realtype<F>::type>
RCP<const ElementFormula<F,G> > concepts::ElementFormulaContainer< F, G >::frm_ [private]

Element formula is stored as a RCP.

Definition at line 76 of file elementFormulaContainer.hh.


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

Home | Doxygen Documentation | Tutorials | Developer Tools (restricted)