Inheritance diagram for concepts::FormulaContainer< F >:

Public Types
typedef F	value_type

typedef Realtype< F >::type	G

Public Member Functions
	FormulaContainer (const F x)

	FormulaContainer ()

	FormulaContainer (const Formula< F > &frm)

	FormulaContainer (const RCP< const Formula< F > > frm)

	FormulaContainer (const Formula< F > *frm)

	FormulaContainer (const FormulaContainer< F > &frm)
	Copy constructor.

virtual F	operator() (const Real p, const Real t=0.0) const

virtual F	operator() (const Real2d &p, const Real t=0.0) const

virtual F	operator() (const Real3d &p, const Real t=0.0) const

virtual FormulaContainer< F > *	clone () const
	Virtual copy constructor.

const Formula< F > &	frm () const

bool	empty () const
	Returns true if no formula is stored.

virtual F	operator() (const ElementWithCell< G > &elm, const Real p, const Real t=0.0) const

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 F	operator() (const ElementWithCell< concepts::Realtype< F >::type > &elm, const Real p, const Real t=0.0) const=0

virtual F	operator() (const ElementWithCell< concepts::Realtype< F >::type > &elm, const Real2d &p, const Real t=0.0) const=0

virtual F	operator() (const ElementWithCell< concepts::Realtype< F >::type > &elm, const Real3d &p, const Real t=0.0) const=0

virtual const F &	dflt_value () const
	Gives default value.

virtual F &	dflt_value ()
	Gives default value.


virtual F	operator() (const Connector &cntr, const Real p, const Real t=0.0) const

virtual F	operator() (const Connector &cntr, const Real2d &p, const Real t=0.0) const

virtual F	operator() (const Connector &cntr, const Real3d &p, const Real t=0.0) const

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

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/5]

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/5]

template<class F >

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

inline

Constructor with no argument

Definition at line 35 of file formulaContainer.hh.

◆ FormulaContainer() [3/5]

template<class F >

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

Constructor for a formula, takes a clone

◆ FormulaContainer() [4/5]

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/5]

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.

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.

◆ dflt_value() [1/2]

template<typename F >

virtual F & concepts::PiecewiseFormulaBase< F >::dflt_value ( )

inlinevirtualinherited

Gives default value.

Definition at line 83 of file piecewiseFormula.hh.

◆ dflt_value() [2/2]

template<typename F >

virtual const F & concepts::PiecewiseFormulaBase< F >::dflt_value ( ) const

inlinevirtualinherited

Gives default value.

Definition at line 81 of file piecewiseFormula.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

Returns information in an output stream.

Reimplemented from concepts::PiecewiseFormulaBase< F >.

◆ operator()() [1/12]

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.

Implements concepts::PiecewiseFormulaBase< F >.

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

Definition at line 53 of file formula.hh.

◆ operator()() [2/12]

template<typename F >

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

inlinevirtualinherited

Implements concepts::PiecewiseFormulaBase< F >.

Definition at line 56 of file formula.hh.

◆ operator()() [3/12]

template<typename F >

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

inlinevirtualinherited

Implements concepts::PiecewiseFormulaBase< F >.

Definition at line 59 of file formula.hh.

◆ operator()() [4/12]

virtual F concepts::ElementFormula< F, concepts::Realtype< F >::type >::operator()	(	const ElementWithCell< concepts::Realtype< F >::type > &	elm,
		const Real	p,
		const Real	t = `0.0`
	)		const

pure virtualinherited

Evaluates the formula.

Parameters

elm	Element
p	Point in space in local element coordinates
t	Point in time

◆ operator()() [5/12]

virtual F concepts::ElementFormula< F, concepts::Realtype< F >::type >::operator()	(	const ElementWithCell< concepts::Realtype< F >::type > &	elm,
		const Real2d &	p,
		const Real	t = `0.0`
	)		const

pure virtualinherited

Evaluates the formula.

Parameters

elm	Element
p	Point in space in local element coordinates
t	Point in time

◆ operator()() [6/12]

virtual F concepts::ElementFormula< F, concepts::Realtype< F >::type >::operator()	(	const ElementWithCell< concepts::Realtype< F >::type > &	elm,
		const Real3d &	p,
		const Real	t = `0.0`
	)		const

pure virtualinherited

Evaluates the formula.

Parameters

elm	Element
p	Point in space in local element coordinates
t	Point in time

◆ operator()() [7/12]

template<typename F >

virtual F concepts::PiecewiseFormulaBase< F >::operator()	(	const ElementWithCell< G > &	elm,
		const Real	p,
		const Real	t = `0.0`
	)		const

inlinevirtualinherited

Definition at line 52 of file piecewiseFormula.hh.

◆ operator()() [8/12]

template<typename F >

virtual F concepts::PiecewiseFormulaBase< F >::operator()	(	const ElementWithCell< G > &	elm,
		const Real2d &	p,
		const Real	t = `0.0`
	)		const

inlinevirtualinherited

Definition at line 57 of file piecewiseFormula.hh.

◆ operator()() [9/12]

template<typename F >

virtual F concepts::PiecewiseFormulaBase< F >::operator()	(	const ElementWithCell< G > &	elm,
		const Real3d &	p,
		const Real	t = `0.0`
	)		const

inlinevirtualinherited

Definition at line 63 of file piecewiseFormula.hh.

◆ operator()() [10/12]

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()() [11/12]

template<class F >

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

virtual

Implements concepts::Formula< F >.

◆ operator()() [12/12]

template<class F >

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

virtual

Implements concepts::Formula< F >.

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

formula/formulaContainer.hh

Class documentation of Concepts

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ G

◆ value_type

Constructor & Destructor Documentation

◆ FormulaContainer() [1/5]

◆ FormulaContainer() [2/5]

◆ FormulaContainer() [3/5]

◆ FormulaContainer() [4/5]

◆ FormulaContainer() [5/5]

Member Function Documentation

◆ clone()

◆ dflt_value() [1/2]

◆ dflt_value() [2/2]

◆ empty()

◆ frm()

◆ info()

◆ operator()() [1/12]

◆ operator()() [2/12]

◆ operator()() [3/12]

◆ operator()() [4/12]

◆ operator()() [5/12]

◆ operator()() [6/12]

◆ operator()() [7/12]

◆ operator()() [8/12]

◆ operator()() [9/12]

◆ operator()() [10/12]

◆ operator()() [11/12]

◆ operator()() [12/12]