Class documentation of Concepts

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

#include <pml_formula.h>

Inheritance diagram for concepts::FormulaExpImag2DGrad:
concepts::Formula< concepts::Point< Cmplx, 2 > > concepts::Formula< Point< Cmplx, 2 > > 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 concepts::Point< Cmplx, 2 > value_type
 
typedef Realtype< concepts::Point< Cmplx, 2 > >::type G
 
typedef Point< Cmplx, 2 > value_type
 
typedef Realtype< Point< Cmplx, 2 > >::type G
 

Public Member Functions

 FormulaExpImag2DGrad (const Real2d k, const Cmplx u=1.0, Real2d x0=Real2d(0, 0))
 
virtual FormulaExpImag2DGradclone () const
 Virtual copy constructor.
 
virtual Cmplx2d operator() (const Real p, const Real t=0.0) const
 
virtual Cmplx2d operator() (const concepts::Real2d &p, const Real t=0.0) const
 
virtual Cmplx2d operator() (const concepts::Real3d &p, const Real t=0.0) const
 
 FormulaExpImag2DGrad (const Real2d k, const Cmplx u=1.0, Real2d x0=Real2d(0, 0))
 
virtual FormulaExpImag2DGradclone () const
 Virtual copy constructor.
 
virtual Cmplx2d operator() (const Real p, const Real t=0.0) const
 
virtual Cmplx2d operator() (const Real2d &p, const Real t=0.0) const
 
virtual Cmplx2d 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 concepts::Point< Cmplx, 2 > operator() (const Connector &cntr, const Real p, const Real t=0.0) const
 
virtual concepts::Point< Cmplx, 2 > operator() (const Connector &cntr, const Real2d &p, const Real t=0.0) const
 
virtual concepts::Point< Cmplx, 2 > operator() (const Connector &cntr, const Real3d &p, const Real t=0.0) const
 
virtual Point< Cmplx, 2 > operator() (const Connector &cntr, const Real p, const Real t=0.0) const
 
virtual Point< Cmplx, 2 > operator() (const Connector &cntr, const Real2d &p, const Real t=0.0) const
 
virtual Point< Cmplx, 2 > 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 gradient of a plane wave. I.e, formula for $ \nabla_x u \mathrm{exp}(ik(x-x_0)) $.

Definition at line 136 of file pml_formula.h.

Member Typedef Documentation

◆ G [1/2]

Definition at line 37 of file formula.hh.

◆ G [2/2]

typedef Realtype<Point< Cmplx, 2 > >::type concepts::Formula< Point< Cmplx, 2 > >::G
inherited

Definition at line 37 of file formula.hh.

◆ value_type [1/2]

typedef concepts::Point< Cmplx, 2 > concepts::Formula< concepts::Point< Cmplx, 2 > >::value_type
inherited

Definition at line 36 of file formula.hh.

◆ value_type [2/2]

typedef Point< Cmplx, 2 > concepts::Formula< Point< Cmplx, 2 > >::value_type
inherited

Definition at line 36 of file formula.hh.

Constructor & Destructor Documentation

◆ FormulaExpImag2DGrad() [1/2]

concepts::FormulaExpImag2DGrad::FormulaExpImag2DGrad ( const Real2d  k,
const Cmplx  u = 1.0,
Real2d  x0 = Real2d(0,0) 
)
inline

Definition at line 139 of file pml_formula.h.

◆ FormulaExpImag2DGrad() [2/2]

concepts::FormulaExpImag2DGrad::FormulaExpImag2DGrad ( const Real2d  k,
const Cmplx  u = 1.0,
Real2d  x0 = Real2d(0,0) 
)
inline

Definition at line 166 of file sources.hh.

Member Function Documentation

◆ clone() [1/2]

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

Virtual copy constructor.

Implements concepts::Formula< concepts::Point< Cmplx, 2 > >.

Definition at line 143 of file pml_formula.h.

◆ clone() [2/2]

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

Virtual copy constructor.

Implements concepts::Formula< concepts::Point< Cmplx, 2 > >.

Definition at line 170 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::FormulaExpImag2DGrad::info ( std::ostream &  os) const
inlineprotectedvirtual

Returns information in an output stream.

Reimplemented from concepts::PiecewiseFormulaBase< F >.

Definition at line 170 of file pml_formula.h.

◆ info() [2/2]

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

Returns information in an output stream.

Reimplemented from concepts::PiecewiseFormulaBase< F >.

Definition at line 197 of file sources.hh.

◆ operator()() [1/18]

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

Implements concepts::Formula< concepts::Point< Cmplx, 2 > >.

Definition at line 151 of file pml_formula.h.

◆ operator()() [2/18]

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

Implements concepts::Formula< concepts::Point< Cmplx, 2 > >.

Definition at line 165 of file pml_formula.h.

◆ operator()() [3/18]

virtual Point< Cmplx, 2 > concepts::Formula< Point< Cmplx, 2 > >::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/18]

virtual concepts::Point< Cmplx, 2 > concepts::Formula< concepts::Point< Cmplx, 2 > >::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()() [5/18]

virtual Point< Cmplx, 2 > concepts::Formula< Point< Cmplx, 2 > >::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()() [6/18]

virtual concepts::Point< Cmplx, 2 > concepts::Formula< concepts::Point< Cmplx, 2 > >::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()() [7/18]

virtual concepts::Point< Cmplx, 2 > concepts::Formula< concepts::Point< Cmplx, 2 > >::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()() [8/18]

virtual Point< Cmplx, 2 > concepts::Formula< Point< Cmplx, 2 > >::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()() [9/18]

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

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

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

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

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

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

virtual Cmplx2d concepts::FormulaExpImag2DGrad::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< concepts::Point< Cmplx, 2 > >.

Definition at line 147 of file pml_formula.h.

◆ operator()() [16/18]

virtual Cmplx2d concepts::FormulaExpImag2DGrad::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< concepts::Point< Cmplx, 2 > >.

Definition at line 174 of file sources.hh.

◆ operator()() [17/18]

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

Implements concepts::Formula< concepts::Point< Cmplx, 2 > >.

Definition at line 178 of file sources.hh.

◆ operator()() [18/18]

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

Implements concepts::Formula< concepts::Point< Cmplx, 2 > >.

Definition at line 192 of file sources.hh.

Member Data Documentation

◆ k

const Real2d concepts::FormulaExpImag2DGrad::k

Definition at line 174 of file pml_formula.h.

◆ u

const Cmplx concepts::FormulaExpImag2DGrad::u

Definition at line 175 of file pml_formula.h.

◆ x0

const Real2d concepts::FormulaExpImag2DGrad::x0

Definition at line 174 of file pml_formula.h.


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