Class documentation of Concepts

Loading...
Searching...
No Matches
concepts::PiecewiseFormula< F > Class Template Referenceabstract

#include <formula.hh>

Inheritance diagram for concepts::PiecewiseFormula< F >:
concepts::PiecewiseFormulaBase< F > concepts::ElementFormula< F, concepts::Realtype< F >::type > concepts::Cloneable concepts::OutputOperator

Classes

class  FormulaFactor
 

Public Types

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

Public Member Functions

 PiecewiseFormula (const F dflt_value=0)
 
virtual PiecewiseFormula< F > * clone () const
 Virtual copy constructor.
 
virtualoperator() (const Connector &cell, const Real p, const Real t=0.0) const
 Gives the value in an particular cell.
 
virtualoperator() (const Connector &cell, const Real2d &p, const Real t=0.0) const
 
virtualoperator() (const Connector &cell, const Real3d &p, const Real t=0.0) const
 
void set (const uint attrib, const Formula< F > &formula)
 
void set (const uint attrib, const F a)
 
template<class H >
void multiply (const H &factor)
 Multiplies all values with this factor.
 
template<class H >
void multiply (const uint attrib, const H &factor)
 Multiply the formula with attribute attrib with this factor.
 
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.
 

Protected Member Functions

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

Protected Attributes

HashMap< FormulaFactorformula_
 Mapping from the elements on to the formula.
 

Detailed Description

template<typename F>
class concepts::PiecewiseFormula< F >

Piecewise defined function defined by attributes.

For an attribute and so an area a formula is given.

Author
Kersten Schmidt, 2005
Note
: a current limitation is that you cannot specify a formula for the attribute 0, it will be ignored.

Definition at line 218 of file formula.hh.

Member Typedef Documentation

◆ G

template<typename F >
typedef concepts::Realtype<F>::type concepts::PiecewiseFormulaBase< F >::G
inherited

Definition at line 45 of file piecewiseFormula.hh.

◆ value_type

typedef F concepts::ElementFormula< F, concepts::Realtype< F >::type >::value_type
inherited

Definition at line 37 of file elementFormula.hh.

Member Function Documentation

◆ clone()

template<typename F >
virtual PiecewiseFormula< F > * concepts::PiecewiseFormula< F >::clone ( ) const
virtual

Virtual copy constructor.

Implements concepts::PiecewiseFormulaBase< F >.

◆ 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<typename F >
virtual std::ostream & concepts::PiecewiseFormula< F >::info ( std::ostream &  os) const
protectedvirtual

Returns information in an output stream.

Reimplemented from concepts::PiecewiseFormulaBase< F >.

◆ multiply() [1/2]

template<typename F >
template<class H >
void concepts::PiecewiseFormula< F >::multiply ( const H &  factor)

Multiplies all values with this factor.

Definition at line 263 of file formula.hh.

◆ multiply() [2/2]

template<typename F >
template<class H >
void concepts::PiecewiseFormula< F >::multiply ( const uint  attrib,
const H &  factor 
)

Multiply the formula with attribute attrib with this factor.

Definition at line 271 of file formula.hh.

◆ operator()() [1/9]

template<typename F >
virtual F concepts::PiecewiseFormula< F >::operator() ( const Connector cell,
const Real  p,
const Real  t = 0.0 
) const
virtual

Gives the value in an particular cell.

Implements concepts::PiecewiseFormulaBase< F >.

◆ operator()() [2/9]

template<typename F >
virtual F concepts::PiecewiseFormula< F >::operator() ( const Connector cell,
const Real2d p,
const Real  t = 0.0 
) const
virtual

◆ operator()() [3/9]

template<typename F >
virtual F concepts::PiecewiseFormula< F >::operator() ( const Connector cell,
const Real3d p,
const Real  t = 0.0 
) const
virtual

◆ operator()() [4/9]

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

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

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

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

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

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.

◆ set()

template<typename F >
void concepts::PiecewiseFormula< F >::set ( const uint  attrib,
const Formula< F > &  formula 
)

Set the constant in an particular cell

Parameters
cellCell the value is to set
valueValue
recursiveIf flag is set all children get the same value.

Member Data Documentation

◆ formula_

template<typename F >
HashMap<FormulaFactor> concepts::PiecewiseFormula< F >::formula_
protected

Mapping from the elements on to the formula.

Definition at line 258 of file formula.hh.


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