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::SphericalFormula< Real2d > Class Referenceabstract

#include <sphericalFormula.hh>

Inheritance diagram for concepts::SphericalFormula< Real2d >:
concepts::ParsedFormula< Real2d > concepts::Formula< Real2d > concepts::ParsedFormulaBase< 2 > concepts::PiecewiseFormulaBase< F > concepts::ElementFormula< F, concepts::Realtype< F >::type > concepts::Cloneable concepts::OutputOperator

Public Types

typedef Real2d value_type
 
typedef Realtype< Real2d >::type G
 
typedef concepts::Sequence< std::pair< std::string, std::string > > RepSeq
 

Public Member Functions

 SphericalFormula (const std::string formula1, const std::string formula2)
 Constructor.
 
virtual SphericalFormula< Real2d > * clone () const
 Virtual copy constructor.
 
virtual Real2d operator() (const Real p, const Real t=0.0) const
 
virtual Real2d operator() (const Real2d &p, const Real t=0.0) const
 
virtual Real2d operator() (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 & dflt_value () const
 Gives default value.
 
virtual F & dflt_value ()
 Gives default value.
 
void set (const std::string formula, uint i=0, RepSeq rep=RepSeq())
 Sets the i th formula.
 
virtual Real2d operator() (const Connector &cntr, const Real p, const Real t=0.0) const
 
virtual Real2d operator() (const Connector &cntr, const Real2d &p, const Real t=0.0) const
 
virtual Real2d 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.
 
Real process_ (const Real3d &p, const Real t=0.0, uint i=0) const
 Processing the i th formula (with time-dependency variable)
 

Protected Attributes

std::string formula_ [dim]
 The original formula.
 

Detailed Description

Class representing SphericalFormulas in two in 2 components.

Author
Robert Gruhlke, 2013

Definition at line 61 of file sphericalFormula.hh.

Member Typedef Documentation

◆ G

typedef Realtype<Real2d >::type concepts::Formula< Real2d >::G
inherited

Definition at line 37 of file formula.hh.

◆ RepSeq

typedef concepts::Sequence<std::pair<std::string,std::string> > concepts::ParsedFormulaBase< dim >::RepSeq
inherited

Definition at line 62 of file parsedFormula.hh.

◆ value_type

typedef Real2d concepts::Formula< Real2d >::value_type
inherited

Definition at line 36 of file formula.hh.

Constructor & Destructor Documentation

◆ SphericalFormula()

concepts::SphericalFormula< Real2d >::SphericalFormula ( const std::string  formula1,
const std::string  formula2 
)
inline

Constructor.

Definition at line 64 of file sphericalFormula.hh.

Member Function Documentation

◆ clone()

virtual SphericalFormula< Real2d > * concepts::SphericalFormula< Real2d >::clone ( ) const
virtual

Virtual copy constructor.

Reimplemented from concepts::ParsedFormula< Real2d >.

◆ 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()

virtual std::ostream & concepts::SphericalFormula< Real2d >::info ( std::ostream &  os) const
protectedvirtual

Returns information in an output stream.

Reimplemented from concepts::ParsedFormula< Real2d >.

◆ operator()() [1/12]

virtual Real2d concepts::Formula< Real2d >::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 >.

Definition at line 53 of file formula.hh.

◆ operator()() [2/12]

virtual Real2d concepts::Formula< Real2d >::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]

virtual Real2d concepts::Formula< Real2d >::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]

virtual Real2d concepts::SphericalFormula< Real2d >::operator() ( const Real  p,
const Real  t = 0.0 
) const
virtual

Application operator. Evaluates the formula.

Parameters
pPoint in space
tPoint in time

Reimplemented from concepts::ParsedFormula< Real2d >.

◆ operator()() [11/12]

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

Reimplemented from concepts::ParsedFormula< Real2d >.

◆ operator()() [12/12]

virtual Real2d concepts::SphericalFormula< Real2d >::operator() ( const Real3d &  p,
const Real  t = 0.0 
) const
virtual

Reimplemented from concepts::ParsedFormula< Real2d >.

Member Data Documentation

◆ formula_

std::string concepts::ParsedFormulaBase< dim >::formula_[dim]
protectedinherited

The original formula.

Definition at line 85 of file parsedFormula.hh.

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