Linear combination of two formulae. More...

#include <formulaLiCo.hh>

Inheritance diagram for concepts::FormulaLiCo:

Collaboration diagram for concepts::FormulaLiCo:

Public Types
typedef Realtype< Real >::type	G
typedef Real	value_type
Public Member Functions
virtual Formula< Real > *	clone () const
	Return a clone of this linear combination.
virtual const Real &	dflt_value () const
	Gives default value.
virtual Real &	dflt_value ()
	Gives default value.
	FormulaLiCo (const Formula< Real > &frmA, const Formula< Real > &frmB, Real cA, Real cB)
	Constructor.
virtual Real	operator() (const ElementWithCell< concepts::Realtype< Real >::type > &elm, const Real2d &p, const Real t=0.0) const =0
virtual Real	operator() (const ElementWithCell< concepts::Realtype< Real >::type > &elm, const Real p, const Real t=0.0) const =0
	Evaluates the formula.
virtual Real	operator() (const ElementWithCell< G > &elm, const Real3d &p, const Real t=0.0) const
virtual Real	operator() (const ElementWithCell< G > &elm, const Real2d &p, const Real t=0.0) const
virtual Real	operator() (const Real p, const Real t=0.0) const
	Application operator for one dimension.
virtual Real	operator() (const Real3d &p, const Real t=0.0) const
	Application operator for three dimensions.
virtual Real	operator() (const Real2d &p, const Real t=0.0) const
	Application operator for two dimensions.
virtual Real	operator() (const ElementWithCell< G > &elm, const Real p, const Real t=0.0) const
virtual Real	operator() (const ElementWithCell< concepts::Realtype< Real >::type > &elm, const Real3d &p, const Real t=0.0) const =0

virtual Real	operator() (const Connector &cntr, const Real p, const Real t=0.0) const
	Convenience implementation, that by default ignores its elm param.
virtual Real	operator() (const Connector &cntr, const Real2d &p, const Real t=0.0) const
	Convenience implementation, that by default ignores its elm param.
virtual Real	operator() (const Connector &cntr, const Real3d &p, const Real t=0.0) const
	Convenience implementation, that by default ignores its elm param.
Protected Member Functions
virtual std::ostream &	info (std::ostream &os) const
	Returns information in an output stream.
Private Attributes
const Real	cA_
const Real	cB_
const Formula< Real > &	frmA_
const Formula< Real > &	frmB_

Detailed Description

Linear combination of two formulae.

Calculates cA * frmA(x,t) + cB * frmB(x,t).

Author:: Christoph Winkelmann, 2003

Definition at line 12 of file formulaLiCo.hh.

Member Typedef Documentation

typedef Realtype<Real >::type concepts::Formula< Real >::G [inherited]

Reimplemented from concepts::PiecewiseFormulaBase< Real >.

Definition at line 35 of file formula.hh.

typedef Real concepts::Formula< Real >::value_type [inherited]

Reimplemented from concepts::ElementFormula< Real, concepts::Realtype< Real >::type >.

Definition at line 34 of file formula.hh.

Constructor & Destructor Documentation

concepts::FormulaLiCo::FormulaLiCo	(	const Formula< Real > &	frmA,
		const Formula< Real > &	frmB,
		Real	cA,
		Real	cB
	)		`[inline]`

Constructor.

Parameters:

frmA	formula A
frmB	formula B
cA	coefficient of `frmA`
cB	coefficient of `frmB`

Definition at line 20 of file formulaLiCo.hh.

Member Function Documentation

virtual Formula<Real>* concepts::FormulaLiCo::clone ( ) const [inline, virtual]

Return a clone of this linear combination.

Implements concepts::Formula< Real >.

Definition at line 23 of file formulaLiCo.hh.

Here is the call graph for this function:

virtual const Real & concepts::PiecewiseFormulaBase< Real >::dflt_value ( ) const [inline, virtual, inherited]

Gives default value.

Definition at line 76 of file piecewiseFormula.hh.

virtual Real & concepts::PiecewiseFormulaBase< Real >::dflt_value ( ) [inline, virtual, inherited]

Gives default value.

Definition at line 78 of file piecewiseFormula.hh.

virtual std::ostream& concepts::PiecewiseFormulaBase< Real >::info ( std::ostream & os ) const [protected, virtual, inherited]

Returns information in an output stream.

Reimplemented from concepts::OutputOperator.

Reimplemented in concepts::BesselJ< n >, concepts::BesselY< n >, concepts::ParsedFormula< Real >, concepts::HField_CircularCoil, concepts::DivGradHField_CircularCoil, concepts::PiecewiseConstFormula< Real >, concepts::PiecewiseFormula< Real >, and concepts::PiecewiseFormulaFun< Real, Real >.

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

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

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

Evaluates the formula.

Parameters:

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

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

Definition at line 58 of file piecewiseFormula.hh.

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

Definition at line 52 of file piecewiseFormula.hh.

virtual Real concepts::FormulaLiCo::operator()	(	const Real3d &	p,
		const Real	t = `0.0`
	)		const `[inline, virtual]`

Application operator for three dimensions.

Implements concepts::Formula< Real >.

Definition at line 36 of file formulaLiCo.hh.

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