concepts::FormulaContainer< F > Class Template Reference

#include <formulaContainer.hh>

Inheritance diagram for concepts::FormulaContainer< F >:

Public Types
typedef Realtype< F >::type	G
typedef F	value_type

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

Protected Member Functions
virtual std::ostream &	info (std::ostream &os) const

Private Attributes
RCP< const Formula< F > >	frm_
	Element formula is stored as a RCP. More...

Detailed Description

template<class F>
class concepts::FormulaContainer< F >

Definition at line 22 of file formulaContainer.hh.

Member Typedef Documentation

G

template<typename F >

typedef Realtype<F>::type concepts::Formula< F >::G

inherited

Definition at line 37 of file formula.hh.

value_type

template<typename F >

typedef F concepts::Formula< F >::value_type

inherited

Definition at line 36 of file formula.hh.

Constructor & Destructor Documentation

FormulaContainer() [1/6]

template<class F >

concepts::FormulaContainer< F >::FormulaContainer

(

const F

x

)

Special constructor for a constant.

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

See also

testsuite/testFormula.cc

FormulaContainer() [2/6]

template<class F >

concepts::FormulaContainer< F >::FormulaContainer ( )

inline

Constructor with no argument.

Definition at line 35 of file formulaContainer.hh.

FormulaContainer() [3/6]

template<class F >

concepts::FormulaContainer< F >::FormulaContainer

(

const Formula< F > &

frm

)

Constructor for a formula, takes a clone.

FormulaContainer() [4/6]

template<class F >

concepts::FormulaContainer< F >::FormulaContainer

(

const RCP< const Formula< F > >

frm

)

Constructor for an RCP to a formula, replaces the own RCP.

FormulaContainer() [5/6]

template<class F >

concepts::FormulaContainer< F >::FormulaContainer ( const Formula< F > *  frm )

explicit

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

FormulaContainer() [6/6]

template<class F >

concepts::FormulaContainer< F >::FormulaContainer ( const FormulaContainer< F > &  frm )

explicit

Copy constructor.

~FormulaContainer()

template<class F >

virtual concepts::FormulaContainer< F >::~FormulaContainer ( )

virtual

Member Function Documentation

clone()

template<class F >

virtual FormulaContainer<F>* concepts::FormulaContainer< F >::clone ( ) const

inlinevirtual

Virtual copy constructor.

Implements concepts::Formula< F >.

Definition at line 59 of file formulaContainer.hh.

empty()

template<class F >

bool concepts::FormulaContainer< F >::empty ( ) const

inline

Returns true if no formula is stored.

Definition at line 66 of file formulaContainer.hh.

frm()

template<class F >

const Formula<F>& concepts::FormulaContainer< F >::frm ( ) const

inline

Definition at line 63 of file formulaContainer.hh.

info()

template<class F >

virtual std::ostream& concepts::FormulaContainer< F >::info ( std::ostream &  os ) const

protectedvirtual

operator()() [1/6]

template<typename F >

virtual F concepts::Formula< F >::operator() ( const Connector &  cntr, const Real  p, const Real  t = 0.0  ) const

inlinevirtualinherited

Convenience implementation, that by default ignores its elm param.

Reimplemented in concepts::FormulaFromElementFormula< dim, F, G >.

Definition at line 53 of file formula.hh.

operator()() [2/6]

template<typename F >

virtual F concepts::Formula< F >::operator() ( const Connector &  cntr, const Real2d &  p, const Real  t = 0.0  ) const

inlinevirtualinherited

Convenience implementation, that by default ignores its elm param.

Reimplemented in concepts::FormulaFromElementFormula< dim, F, G >.

Definition at line 56 of file formula.hh.

operator()() [3/6]

template<typename F >

virtual F concepts::Formula< F >::operator() ( const Connector &  cntr, const Real3d &  p, const Real  t = 0.0  ) const

inlinevirtualinherited

Convenience implementation, that by default ignores its elm param.

Reimplemented in concepts::FormulaFromElementFormula< dim, F, G >.

Definition at line 59 of file formula.hh.

operator()() [4/6]

template<class F >

virtual F concepts::FormulaContainer< F >::operator() ( const Real  p, const Real  t = 0.0  ) const

virtual

Evaluates the formula.

Parameters

p	Point in space
t	Point in time

Implements concepts::Formula< F >.

operator()() [5/6]

template<class F >

virtual F concepts::FormulaContainer< F >::operator() ( const Real2d &  p, const Real  t = 0.0  ) const

virtual

Application operator.

Evaluates the formula.

Parameters

p	Point in space
t	Point in time

Implements concepts::Formula< F >.

operator()() [6/6]

template<class F >

virtual F concepts::FormulaContainer< F >::operator() ( const Real3d &  p, const Real  t = 0.0  ) const

virtual

Application operator.

Evaluates the formula.

Parameters

p	Point in space
t	Point in time

Implements concepts::Formula< F >.

Member Data Documentation

frm_

template<class F >

RCP<const Formula<F> > concepts::FormulaContainer< F >::frm_

private

Element formula is stored as a RCP.

Definition at line 73 of file formulaContainer.hh.

---

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

• formula/formulaContainer.hh