You are here: Concepts>Concepts Web>Class documentation

Class documentation of Concepts

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

#include <formula.hh>

Inheritance diagram for concepts::Formula< F >:
concepts::PiecewiseFormulaBase< F > concepts::ElementFormula< F, concepts::Realtype< F >::type > concepts::Cloneable concepts::OutputOperator concepts::ConstFormula< F > concepts::FormulaContainer< F > concepts::FormulaFromElementFormula< dim, F, G > concepts::FormulaPMLPowerSigma< F > concepts::FormulaPMLPowerSigma< F > concepts::FormulaPMLPowerSigma2D< F > concepts::FormulaPMLPowerSigma2D< F > concepts::FormulaPMLPowerSigmaB2D< F > concepts::FormulaPMLPowerSigmaB2D< F > concepts::Frm_Product< F, H, J > concepts::Frm_Sum< F, H, J >

Public Types

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

Public Member Functions

virtual Formula * clone () const =0
 Virtual copy constructor.
 
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.
 
virtual F operator() (const Real p, const Real t=0.0) const =0
 
virtual F operator() (const Real2d &p, const Real t=0.0) const =0
 
virtual F operator() (const Real3d &p, const Real t=0.0) const =0
 
virtual F operator() (const Connector &cntr, const Real p, const Real t=0.0) const
 
virtual F operator() (const Connector &cntr, const Real2d &p, const Real t=0.0) const
 
virtual F 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.
 

Detailed Description

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

Interface for a formula. A general formula would be $ f : R^n \mapsto R^m $. This class covers the possibilities $ f : R^n \mapsto R $ where n is 1, 2 or 3 in space and 0 or 1 in time. The image space is just one dimensional since higher dimensions can be simulated by taking a Formula in every component.

The application operators of this class evaluate the formula in a given point in space p and time t. If a specialization of this interface does not implement a time dependent formula, t is simply discarded.

ElementFormula is more general than Formula, it always takes an additional Element argument. Formula is derived from ElementFormula and will by default just ignore this argument.

Author
Philipp Frauenfelder, 2002

Definition at line 34 of file formula.hh.

Member Typedef Documentation

◆ G

template<typename F >
typedef Realtype<F>::type concepts::Formula< F >::G

Definition at line 37 of file formula.hh.

◆ value_type

template<typename F >
typedef F concepts::Formula< F >::value_type

Definition at line 36 of file formula.hh.

Member Function Documentation

◆ clone()

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

Virtual copy constructor.

Implements concepts::PiecewiseFormulaBase< F >.

Implemented in concepts::FormulaExpImag1D, concepts::FormulaExpImag2D, concepts::FormulaExpImag2DRadialDer, concepts::FormulaExpImag2DGrad, concepts::FormulaPMLPowerSigma< F >, concepts::FormulaPMLPowerSigma2D< F >, concepts::FormulaPMLPowerSigmaB2D< F >, concepts::BesselJ< n >, concepts::BesselY< n >, concepts::ConstFormula< F >, concepts::FormulaContainer< F >, concepts::FormulaLiCo, concepts::Exp_i_n_phi, concepts::Cos_n_phi, concepts::Sin_n_phi, concepts::Exp_i_n_x, concepts::Cos_n_x, concepts::Sin_n_x, concepts::Exp_i_n_y, concepts::Cos_n_y, concepts::Sin_n_y, concepts::Frm_Product< F, H, J >, concepts::Frm_Sum< F, H, J >, concepts::ParsedFormula< Real >, concepts::ParsedFormula< Cmplx >, concepts::ParsedFormula< Real2d >, concepts::SphericalFormula< Real >, concepts::SphericalFormula< Real2d >, concepts::VectorFormula< F, dim >, concepts::FormulaFromElementFormula< dim, F, G >, concepts::Wsym_x< dim >, concepts::Wsym_y< dim >, concepts::Wunsym_x< dim >, concepts::Wunsym_y< dim >, concepts::FormulaPMLPowerSigma< F >, concepts::FormulaPMLPowerSigma2D< F >, concepts::FormulaPMLPowerSigmaB2D< F >, concepts::FormulaExpImag1D, concepts::FormulaExpImag2D, concepts::FormulaExpImag2DRadialDer, concepts::FormulaExpImag2DGrad, concepts::FormulaLayerPlaneWaveSource, concepts::FormulaLayerPlaneWaveSourceGrad, concepts::FormulaLayerPlaneWaveLayer, and concepts::FormulaLayerPlaneWaveLayerGrad.

◆ 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 >
std::ostream & concepts::PiecewiseFormulaBase< F >::info ( std::ostream &  os) const
protectedvirtualinherited

Returns information in an output stream.

Reimplemented from concepts::OutputOperator.

Reimplemented in concepts::FormulaExpImag1D, concepts::FormulaExpImag2D, concepts::FormulaExpImag2DRadialDer, concepts::FormulaExpImag2DGrad, concepts::FormulaPMLPowerSigma< F >, concepts::FormulaPMLPowerSigma2D< F >, concepts::FormulaPMLPowerSigmaB2D< F >, concepts::ExplicitResidual< F >, estimator::PolynomialDegrees< dim >, estimator::KeysInfo< F >, concepts::BesselJ< n >, concepts::BesselY< n >, concepts::ConstFormula< F >, concepts::FormulaContainer< F >, concepts::Exp_i_n_phi, concepts::Cos_n_phi, concepts::Sin_n_phi, concepts::Exp_i_n_x, concepts::Cos_n_x, concepts::Sin_n_x, concepts::Exp_i_n_y, concepts::Cos_n_y, concepts::Sin_n_y, concepts::Frm_Product< F, H, J >, concepts::Frm_Sum< F, H, J >, concepts::ParsedFormula< Real >, concepts::ParsedFormula< Cmplx >, concepts::ParsedFormula< Real2d >, concepts::SphericalFormula< Real >, concepts::SphericalFormula< Real2d >, concepts::VectorFormula< F, dim >, concepts::PiecewiseFormula0< F >, concepts::PiecewiseConstFormula< F >, concepts::PiecewiseConstFormula< concepts::Point >, concepts::PiecewiseConstFormula< Real >, concepts::PiecewiseConstDynArrayFormula< F >, concepts::PiecewiseFormula< F >, concepts::PiecewiseFormula< Cmplx >, concepts::PiecewiseFormula< Cmplx2d >, concepts::PiecewiseFormula< concepts::Point >, concepts::PiecewiseFormula< Real >, concepts::PiecewiseFormulaFun< F, G >, concepts::PiecewiseFormulaFun< Cmplx, Real >, concepts::PiecewiseFormulaFun< Real, Real >, concepts::PiecewiseFormulaCombine< F, G, H, I >, concepts::FormulaFromElementFormula< dim, F, G >, concepts::Wsym_x< dim >, concepts::Wsym_y< dim >, concepts::Wunsym_x< dim >, concepts::Wunsym_y< dim >, concepts::FormulaPMLPowerSigma< F >, concepts::FormulaPMLPowerSigma2D< F >, concepts::FormulaPMLPowerSigmaB2D< F >, concepts::FormulaExpImag1D, concepts::FormulaExpImag2D, concepts::FormulaExpImag2DRadialDer, concepts::FormulaExpImag2DGrad, concepts::FormulaLayerPlaneWaveSource, concepts::FormulaLayerPlaneWaveSourceGrad, concepts::FormulaLayerPlaneWaveLayer, concepts::FormulaLayerPlaneWaveLayerGrad, and concepts::LocalEstimator< F >.

Definition at line 100 of file piecewiseFormula.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
inlinevirtual

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
inlinevirtual

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
inlinevirtual

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<typename F >
virtual F concepts::Formula< F >::operator() ( const Real  p,
const Real  t = 0.0 
) const
pure virtual

Application operator. Evaluates the formula.

Parameters
pPoint in space
tPoint in time

Implemented in concepts::FormulaExpImag1D, concepts::FormulaExpImag2D, concepts::FormulaExpImag2DRadialDer, concepts::FormulaExpImag2DGrad, concepts::FormulaPMLPowerSigma< F >, concepts::FormulaPMLPowerSigma2D< F >, concepts::FormulaPMLPowerSigmaB2D< F >, concepts::BesselJ< n >, concepts::BesselY< n >, concepts::ConstFormula< F >, concepts::FormulaContainer< F >, concepts::FormulaLiCo, concepts::Exp_i_n_phi, concepts::Cos_n_phi, concepts::Sin_n_phi, concepts::Exp_i_n_x, concepts::Cos_n_x, concepts::Sin_n_x, concepts::Exp_i_n_y, concepts::Cos_n_y, concepts::Sin_n_y, concepts::Frm_Product< F, H, J >, concepts::Frm_Sum< F, H, J >, concepts::ParsedFormula< Real >, concepts::ParsedFormula< Cmplx >, concepts::ParsedFormula< Real2d >, concepts::SphericalFormula< Real >, concepts::SphericalFormula< Real2d >, concepts::VectorFormula< F, dim >, concepts::FormulaFromElementFormula< dim, F, G >, concepts::Wsym_x< dim >, concepts::Wsym_y< dim >, concepts::Wunsym_x< dim >, concepts::Wunsym_y< dim >, concepts::FormulaPMLPowerSigma< F >, concepts::FormulaPMLPowerSigma2D< F >, concepts::FormulaPMLPowerSigmaB2D< F >, concepts::FormulaExpImag1D, concepts::FormulaExpImag2D, concepts::FormulaExpImag2DRadialDer, concepts::FormulaExpImag2DGrad, concepts::FormulaLayerPlaneWaveSource, concepts::FormulaLayerPlaneWaveSourceGrad, concepts::FormulaLayerPlaneWaveLayer, and concepts::FormulaLayerPlaneWaveLayerGrad.

◆ operator()() [11/12]

template<typename F >
virtual F concepts::Formula< F >::operator() ( const Real2d &  p,
const Real  t = 0.0 
) const
pure virtual

Implemented in concepts::FormulaLiCo.

◆ operator()() [12/12]

template<typename F >
virtual F concepts::Formula< F >::operator() ( const Real3d &  p,
const Real  t = 0.0 
) const
pure virtual

Implemented in concepts::FormulaLiCo.

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