Class documentation of Concepts

Loading...
Searching...
No Matches
concepts::FormulaLiCo Class Referenceabstract

#include <formulaLiCo.hh>

Inheritance diagram for concepts::FormulaLiCo:
concepts::Formula< Real > concepts::PiecewiseFormulaBase< F > concepts::ElementFormula< F, concepts::Realtype< F >::type > concepts::Cloneable concepts::OutputOperator

Public Types

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

Public Member Functions

 FormulaLiCo (const Formula< Real > &frmA, const Formula< Real > &frmB, Real cA, Real cB)
 
virtual Formula< Real > * clone () const
 Return a clone of this linear combination.
 
virtual Real operator() (const Real p, const Real t=0.0) const
 Application operator for one dimension.
 
virtual Real operator() (const Real2d &p, const Real t=0.0) const
 Application operator for two dimensions.
 
virtual Real operator() (const Real3d &p, const Real t=0.0) const
 Application operator for three dimensions.
 
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.
 
virtual Real operator() (const Connector &cntr, const Real p, const Real t=0.0) const
 
virtual Real operator() (const Connector &cntr, const Real2d &p, const Real t=0.0) const
 
virtual Real 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

Linear combination of two formulae. Calculates cA * frmA(x,t) + cB * frmB(x,t).

Author
Christoph Winkelmann, 2003

Definition at line 19 of file formulaLiCo.hh.

Member Typedef Documentation

◆ G

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

Definition at line 37 of file formula.hh.

◆ value_type

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

Definition at line 36 of file formula.hh.

Constructor & Destructor Documentation

◆ FormulaLiCo()

concepts::FormulaLiCo::FormulaLiCo ( const Formula< Real > &  frmA,
const Formula< Real > &  frmB,
Real  cA,
Real  cB 
)
inline

Constructor.

Parameters
frmAformula A
frmBformula B
cAcoefficient of frmA
cBcoefficient of frmB

Definition at line 27 of file formulaLiCo.hh.

Member Function Documentation

◆ clone()

virtual Formula< Real > * concepts::FormulaLiCo::clone ( ) const
inlinevirtual

Return a clone of this linear combination.

Implements concepts::Formula< Real >.

Definition at line 30 of file formulaLiCo.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<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]

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

Application operator for one dimension.

Implements concepts::Formula< Real >.

Definition at line 35 of file formulaLiCo.hh.

◆ operator()() [11/12]

virtual Real concepts::FormulaLiCo::operator() ( const Real2d p,
const Real  t = 0.0 
) const
inlinevirtual

Application operator for two dimensions.

Implements concepts::Formula< Real >.

Definition at line 39 of file formulaLiCo.hh.

◆ operator()() [12/12]

virtual Real concepts::FormulaLiCo::operator() ( const Real3d p,
const Real  t = 0.0 
) const
inlinevirtual

Application operator for three dimensions.

Implements concepts::Formula< Real >.

Definition at line 43 of file formulaLiCo.hh.


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