You are here: Concepts>Concepts Web>Class documentation

Class documentation of Concepts

Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
concepts::PiecewiseConstImportFormula< F > Class Template Referenceabstract

#include <formula.hh>

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

Public Types

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

Public Member Functions

 PiecewiseConstImportFormula (const std::string material, const uint idxStart=1, const F dflt_value=0)
 
virtual PiecewiseConstFormula< F > * clone () const
 Virtual copy constructor.
 
virtual F operator() (const Connector &cell, const Real p, const Real t=0.0) const
 Gives the constant in an particular cell.
 
virtual F operator() (const Connector &cell, const Real2d &p, const Real t=0.0) const
 
virtual F operator() (const Connector &cell, const Real3d &p, const Real t=0.0) const
 
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 & operator[] (const uint attrib) const
 
virtual F & operator[] (const uint attrib)
 
template<class H >
PiecewiseConstFormula< F > & operator*= (const H &factor)
 
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< F > formula_
 Mapping from the elements on to the constants.
 

Detailed Description

template<typename F = Real>
class concepts::PiecewiseConstImportFormula< F >

Piecewise constant function defined by attributes, imported from a file.

Format is 

1 3 1.4
2 4 1.5
3 5 1.6

, where in the first column is the consecutive numbering, in the second the attribute, and in the following the contribution to the constants.

Format for the constants: 

bool:   0 = false, else true
     Real:   1.4 or 1.4e7
     Cmplx:  (1.0,0.0)
Author
Kersten Schmidt, 2004

Definition at line 166 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 = Real>
virtual PiecewiseConstFormula< F > * concepts::PiecewiseConstFormula< F >::clone ( ) const
virtualinherited

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 = Real>
virtual std::ostream & concepts::PiecewiseConstFormula< F >::info ( std::ostream &  os) const
protectedvirtualinherited

Returns information in an output stream.

Reimplemented from concepts::PiecewiseFormulaBase< F >.

◆ operator()() [1/9]

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

Gives the constant in an particular cell.

Implements concepts::PiecewiseFormulaBase< F >.

Definition at line 100 of file formula.hh.

◆ operator()() [2/9]

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

Implements concepts::PiecewiseFormulaBase< F >.

Definition at line 104 of file formula.hh.

◆ operator()() [3/9]

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

Implements concepts::PiecewiseFormulaBase< F >.

Definition at line 117 of file formula.hh.

◆ 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.

◆ operator*=()

template<typename F >
template<class H >
PiecewiseConstFormula< F > & concepts::PiecewiseConstFormula< F >::operator*= ( const H &  factor)
inherited

Definition at line 139 of file formula.hh.

◆ operator[]()

template<typename F = Real>
virtual F & concepts::PiecewiseConstFormula< F >::operator[] ( const uint  attrib)
virtualinherited

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 = Real>
HashMap<F> concepts::PiecewiseConstFormula< F >::formula_
protectedinherited

Mapping from the elements on to the constants.

Definition at line 133 of file formula.hh.

The documentation for this class was generated from the following file:
Generated on Wed Sep 13 2023 21:06:43 for Concepts by doxygen 1.9.8