Class documentation of Concepts

Loading...
Searching...
No Matches
concepts::Frm_Product< F, H, J > Class Template Referenceabstract

#include <frm_product.hh>

Inheritance diagram for concepts::Frm_Product< F, H, J >:
concepts::Formula< F > concepts::PiecewiseFormulaBase< F > concepts::ElementFormula< F, concepts::Realtype< F >::type > concepts::Cloneable concepts::OutputOperator

Public Types

typedefvalue_type
 
typedef Realtype< F >::type G
 

Public Member Functions

 Frm_Product (const FormulaContainer< H > frm1, const FormulaContainer< J > frm2)
 
virtualoperator() (const Real p, const Real t=0.0) const
 
virtualoperator() (const Real2d &p, const Real t=0.0) const
 
virtualoperator() (const Real3d &p, const Real t=0.0) const
 
virtual Frm_Product< F, H, J > * clone () const
 Virtual copy constructor.
 
virtualoperator() (const ElementWithCell< G > &elm, const Real 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
 
virtualoperator() (const ElementWithCell< concepts::Realtype< F >::type > &elm, const Real p, const Real t=0.0) const=0
 
virtualoperator() (const ElementWithCell< concepts::Realtype< F >::type > &elm, const Real2d &p, const Real t=0.0) const=0
 
virtualoperator() (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.
 
virtualoperator() (const Connector &cntr, const Real p, const Real t=0.0) const
 
virtualoperator() (const Connector &cntr, const Real2d &p, const Real t=0.0) const
 
virtualoperator() (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 H = F, class J = F>
class concepts::Frm_Product< F, H, J >

Class for a product of formula.

Result of formula is product of the results of the formulas.

Generalisation of the former class ComposeFormula.

Author
Kersten Schmidt, 2010, 2017

Definition at line 31 of file frm_product.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

◆ Frm_Product()

template<class F , class H = F, class J = F>
concepts::Frm_Product< F, H, J >::Frm_Product ( const FormulaContainer< H >  frm1,
const FormulaContainer< J >  frm2 
)
inline

Definition at line 33 of file frm_product.hh.

Member Function Documentation

◆ clone()

template<class F , class H = F, class J = F>
virtual Frm_Product< F, H, J > * concepts::Frm_Product< F, H, J >::clone ( ) const
inlinevirtual

Virtual copy constructor.

Implements concepts::Formula< F >.

Definition at line 49 of file frm_product.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.

◆ info()

template<class F , class H = F, class J = F>
virtual std::ostream & concepts::Frm_Product< F, H, J >::info ( std::ostream &  os) const
inlineprotectedvirtual

Returns information in an output stream.

Reimplemented from concepts::PiecewiseFormulaBase< F >.

Definition at line 53 of file frm_product.hh.

◆ 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
elmElement
pPoint in space in local element coordinates
tPoint 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
elmElement
pPoint in space in local element coordinates
tPoint 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
elmElement
pPoint in space in local element coordinates
tPoint 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 , class H = F, class J = F>
virtual F concepts::Frm_Product< F, H, J >::operator() ( const Real  p,
const Real  t = 0.0 
) const
inlinevirtual

Application operator. Evaluates the formula.

Parameters
pPoint in space
tPoint in time

Implements concepts::Formula< F >.

Definition at line 40 of file frm_product.hh.

◆ operator()() [11/12]

template<class F , class H = F, class J = F>
virtual F concepts::Frm_Product< F, H, J >::operator() ( const Real2d p,
const Real  t = 0.0 
) const
inlinevirtual

Implements concepts::Formula< F >.

Definition at line 43 of file frm_product.hh.

◆ operator()() [12/12]

template<class F , class H = F, class J = F>
virtual F concepts::Frm_Product< F, H, J >::operator() ( const Real3d p,
const Real  t = 0.0 
) const
inlinevirtual

Implements concepts::Formula< F >.

Definition at line 46 of file frm_product.hh.


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