Class documentation of Concepts

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

#include <pml_formula.h>

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

Public Types

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

Public Member Functions

 FormulaExpImag2D (const Real2d k, const Cmplx u=1.0, Real2d x0=0.0)
 
virtual FormulaExpImag2Dclone () const
 Virtual copy constructor.
 
virtual Cmplx operator() (const Real p, const Real t=0.0) const
 
virtual Cmplx operator() (const concepts::Real2d &p, const Real t=0.0) const
 
virtual Cmplx operator() (const concepts::Real3d &p, const Real t=0.0) const
 
 FormulaExpImag2D (const Real2d k, const Cmplx u=1.0, Real2d x0=0.0)
 
virtual FormulaExpImag2Dclone () const
 Virtual copy constructor.
 
virtual Cmplx operator() (const Real p, const Real t=0.0) const
 
virtual Cmplx operator() (const Real2d &p, const Real t=0.0) const
 
virtual Cmplx operator() (const Real3d &p, const Real t=0.0) const
 
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 Cmplx operator() (const Connector &cntr, const Real p, const Real t=0.0) const
 
virtual Cmplx operator() (const Connector &cntr, const Real2d &p, const Real t=0.0) const
 
virtual Cmplx operator() (const Connector &cntr, const Real3d &p, const Real t=0.0) const
 

Public Attributes

const Real2d k
 
const Real2d x0
 
const Cmplx u
 

Protected Member Functions

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

Detailed Description

Formula for $u \mathrm{exp}(ik(x-x_0))$.

Definition at line 54 of file pml_formula.h.

Member Typedef Documentation

◆ G

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

Definition at line 37 of file formula.hh.

◆ value_type

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

Definition at line 36 of file formula.hh.

Constructor & Destructor Documentation

◆ FormulaExpImag2D() [1/2]

concepts::FormulaExpImag2D::FormulaExpImag2D ( const Real2d  k,
const Cmplx  u = 1.0,
Real2d  x0 = 0.0 
)
inline

Definition at line 56 of file pml_formula.h.

◆ FormulaExpImag2D() [2/2]

concepts::FormulaExpImag2D::FormulaExpImag2D ( const Real2d  k,
const Cmplx  u = 1.0,
Real2d  x0 = 0.0 
)
inline

Definition at line 85 of file sources.hh.

Member Function Documentation

◆ clone() [1/2]

virtual FormulaExpImag2D * concepts::FormulaExpImag2D::clone ( ) const
inlinevirtual

Virtual copy constructor.

Implements concepts::Formula< Cmplx >.

Definition at line 59 of file pml_formula.h.

◆ clone() [2/2]

virtual FormulaExpImag2D * concepts::FormulaExpImag2D::clone ( ) const
inlinevirtual

Virtual copy constructor.

Implements concepts::Formula< Cmplx >.

Definition at line 88 of file sources.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() [1/2]

virtual std::ostream & concepts::FormulaExpImag2D::info ( std::ostream &  os) const
inlineprotectedvirtual

Returns information in an output stream.

Reimplemented from concepts::PiecewiseFormulaBase< F >.

Definition at line 79 of file pml_formula.h.

◆ info() [2/2]

virtual std::ostream & concepts::FormulaExpImag2D::info ( std::ostream &  os) const
inlineprotectedvirtual

Returns information in an output stream.

Reimplemented from concepts::PiecewiseFormulaBase< F >.

Definition at line 108 of file sources.hh.

◆ operator()() [1/15]

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

Implements concepts::Formula< Cmplx >.

Definition at line 67 of file pml_formula.h.

◆ operator()() [2/15]

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

Implements concepts::Formula< Cmplx >.

Definition at line 75 of file pml_formula.h.

◆ operator()() [3/15]

virtual Cmplx concepts::Formula< Cmplx >::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()() [4/15]

virtual Cmplx concepts::Formula< Cmplx >::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()() [5/15]

virtual Cmplx concepts::Formula< Cmplx >::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()() [6/15]

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()() [7/15]

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()() [8/15]

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()() [9/15]

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()() [10/15]

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()() [11/15]

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()() [12/15]

virtual Cmplx concepts::FormulaExpImag2D::operator() ( const Real  p,
const Real  t = 0.0 
) const
inlinevirtual

Application operator. Evaluates the formula.

Parameters
pPoint in space
tPoint in time

Implements concepts::Formula< Cmplx >.

Definition at line 63 of file pml_formula.h.

◆ operator()() [13/15]

virtual Cmplx concepts::FormulaExpImag2D::operator() ( const Real  p,
const Real  t = 0.0 
) const
inlinevirtual

Application operator. Evaluates the formula.

Parameters
pPoint in space
tPoint in time

Implements concepts::Formula< Cmplx >.

Definition at line 92 of file sources.hh.

◆ operator()() [14/15]

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

Implements concepts::Formula< Cmplx >.

Definition at line 96 of file sources.hh.

◆ operator()() [15/15]

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

Implements concepts::Formula< Cmplx >.

Definition at line 104 of file sources.hh.

Member Data Documentation

◆ k

const Real2d concepts::FormulaExpImag2D::k

Definition at line 83 of file pml_formula.h.

◆ u

const Cmplx concepts::FormulaExpImag2D::u

Definition at line 84 of file pml_formula.h.

◆ x0

const Real2d concepts::FormulaExpImag2D::x0

Definition at line 83 of file pml_formula.h.


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