Inheritance diagram for concepts::FormulaPMLPowerSigma< F >:

Public Types
typedef F	value_type

typedef Realtype< F >::type	G

Public Member Functions
	FormulaPMLPowerSigma (const Real offset, const int power=2, const F sigma0=5.0, const Real center=0)

virtual FormulaPMLPowerSigma *	clone () const
	Virtual copy constructor.

bool	inPMLregion (const concepts::Real p, const Real t=0.0)

virtual F	operator() (const Real p, const Real t=0.0) const

virtual F	operator() (const concepts::Real2d &p, const Real t=0.0) const

virtual F	operator() (const concepts::Real3d &p, const Real t=0.0) const

	FormulaPMLPowerSigma (const Real offset, const int power=2, const F sigma0=5.0, const Real center=0)

virtual FormulaPMLPowerSigma *	clone () const
	Virtual copy constructor.

bool	inPMLregion (const Real p, const Real t=0.0)

virtual F	operator() (const Real p, const Real t=0.0) const

virtual F	operator() (const Real2d &p, const Real t=0.0) const

virtual F	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.


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

Static Public Member Functions
template<typename Real >
static Real	powi (Real x, int power)

template<typename Real >
static Real	powi (Real x, int powercoeff)

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

template<typename F = Real>
class concepts::FormulaPMLPowerSigma< F >

Definition at line 488 of file pml_formula.h.

Member Typedef Documentation

◆ G

template<typename F >

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

inherited

Definition at line 37 of file formula.hh.

◆ value_type

template<typename F >

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

inherited

Definition at line 36 of file formula.hh.

Constructor & Destructor Documentation

◆ FormulaPMLPowerSigma() [1/2]

template<typename F = Real>

concepts::FormulaPMLPowerSigma< F >::FormulaPMLPowerSigma	(	const Real	offset,
		const int	power = `2`,
		const F	sigma0 = `5.0`,
		const Real	center = `0`
	)

inline

Definition at line 490 of file pml_formula.h.

◆ FormulaPMLPowerSigma() [2/2]

template<typename F = Real>

concepts::FormulaPMLPowerSigma< F >::FormulaPMLPowerSigma	(	const Real	offset,
		const int	power = `2`,
		const F	sigma0 = `5.0`,
		const Real	center = `0`
	)

inline

Definition at line 41 of file pml_formula.hh.

Member Function Documentation

◆ clone() [1/2]

template<typename F = Real>

virtual FormulaPMLPowerSigma * concepts::FormulaPMLPowerSigma< F >::clone ( ) const

inlinevirtual

Virtual copy constructor.

Implements concepts::Formula< F >.

Definition at line 498 of file pml_formula.h.

◆ clone() [2/2]

template<typename F = Real>

virtual FormulaPMLPowerSigma * concepts::FormulaPMLPowerSigma< F >::clone ( ) const

inlinevirtual

Virtual copy constructor.

Implements concepts::Formula< F >.

Definition at line 49 of file pml_formula.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]

template<typename F = Real>

virtual std::ostream & concepts::FormulaPMLPowerSigma< F >::info ( std::ostream & os ) const

inlineprotectedvirtual

Returns information in an output stream.

Reimplemented from concepts::PiecewiseFormulaBase< F >.

Definition at line 537 of file pml_formula.h.

◆ info() [2/2]

template<typename F = Real>

virtual std::ostream & concepts::FormulaPMLPowerSigma< F >::info ( std::ostream & os ) const

inlineprotectedvirtual

Returns information in an output stream.

Reimplemented from concepts::PiecewiseFormulaBase< F >.

Definition at line 87 of file pml_formula.hh.

◆ inPMLregion() [1/2]

template<typename F = Real>

bool concepts::FormulaPMLPowerSigma< F >::inPMLregion	(	const concepts::Real	p,
		const Real	t = `0.0`
	)

inline

Definition at line 502 of file pml_formula.h.

◆ inPMLregion() [2/2]

template<typename F = Real>

bool concepts::FormulaPMLPowerSigma< F >::inPMLregion	(	const Real	p,
		const Real	t = `0.0`
	)

inline

Definition at line 53 of file pml_formula.hh.

◆ operator()() [1/15]

template<typename F = Real>

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

inlinevirtual

Implements concepts::Formula< F >.

Definition at line 517 of file pml_formula.h.

◆ operator()() [2/15]

template<typename F = Real>

virtual F concepts::FormulaPMLPowerSigma< F >::operator()	(	const concepts::Real3d &	p,
		const Real	t = `0.0`
	)		const

inlinevirtual

Implements concepts::Formula< F >.

Definition at line 521 of file pml_formula.h.

◆ operator()() [3/15]

template<typename F >

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

Reimplemented in concepts::FormulaFromElementFormula< dim, F, G >.

Definition at line 53 of file formula.hh.

◆ operator()() [4/15]

template<typename F >

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

template<typename F >

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

elm	Element
p	Point in space in local element coordinates
t	Point 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

elm	Element
p	Point in space in local element coordinates
t	Point 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

elm	Element
p	Point in space in local element coordinates
t	Point 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]

template<typename F = Real>

virtual F concepts::FormulaPMLPowerSigma< F >::operator()	(	const Real	p,
		const Real	t = `0.0`
	)		const

inlinevirtual

Application operator. Evaluates the formula.

Parameters

p	Point in space
t	Point in time

Implements concepts::Formula< F >.

Definition at line 509 of file pml_formula.h.

◆ operator()() [13/15]

template<typename F = Real>

virtual F concepts::FormulaPMLPowerSigma< F >::operator()	(	const Real	p,
		const Real	t = `0.0`
	)		const

inlinevirtual

Application operator. Evaluates the formula.

Parameters

p	Point in space
t	Point in time

Implements concepts::Formula< F >.

Definition at line 60 of file pml_formula.hh.

◆ operator()() [14/15]

template<typename F = Real>

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

inlinevirtual

Implements concepts::Formula< F >.

Definition at line 67 of file pml_formula.hh.

◆ operator()() [15/15]

template<typename F = Real>

virtual F concepts::FormulaPMLPowerSigma< F >::operator()	(	const Real3d &	p,
		const Real	t = `0.0`
	)		const

inlinevirtual

Implements concepts::Formula< F >.

Definition at line 71 of file pml_formula.hh.

◆ powi() [1/2]

template<typename F = Real>

template<typename Real >

static Real concepts::FormulaPMLPowerSigma< F >::powi	(	Real	x,
		int	power
	)

inlinestatic

Definition at line 525 of file pml_formula.h.

◆ powi() [2/2]

template<typename F = Real>

template<typename Real >

static Real concepts::FormulaPMLPowerSigma< F >::powi	(	Real	x,
		int	powercoeff
	)

inlinestatic

Definition at line 75 of file pml_formula.hh.

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

applications/pml_formula.h
waveprop/pml_formula.hh

Class documentation of Concepts

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ G

◆ value_type

Constructor & Destructor Documentation

◆ FormulaPMLPowerSigma() [1/2]

◆ FormulaPMLPowerSigma() [2/2]

Member Function Documentation

◆ clone() [1/2]

◆ clone() [2/2]

◆ dflt_value() [1/2]

◆ dflt_value() [2/2]

◆ info() [1/2]

◆ info() [2/2]

◆ inPMLregion() [1/2]

◆ inPMLregion() [2/2]

◆ operator()() [1/15]

◆ operator()() [2/15]

◆ operator()() [3/15]

◆ operator()() [4/15]

◆ operator()() [5/15]

◆ operator()() [6/15]

◆ operator()() [7/15]

◆ operator()() [8/15]

◆ operator()() [9/15]

◆ operator()() [10/15]

◆ operator()() [11/15]

◆ operator()() [12/15]

◆ operator()() [13/15]

◆ operator()() [14/15]

◆ operator()() [15/15]

◆ powi() [1/2]

◆ powi() [2/2]