concepts::FormulaPMLPowerSigma< F > Class Template Reference

#include <pml_formula.h>

Inheritance diagram for concepts::FormulaPMLPowerSigma< F >:

Collaboration diagram for concepts::FormulaPMLPowerSigma< F >:

List of all members.

Public Types
typedef Realtype< F >::type	G
typedef F	value_type
Public Member Functions
virtual FormulaPMLPowerSigma *	clone () const
	Virtual copy constructor.
virtual FormulaPMLPowerSigma *	clone () const
	Virtual copy constructor.
virtual const F &	dflt_value () const
	Gives default value.
virtual F &	dflt_value ()
	Gives default value.
	FormulaPMLPowerSigma (const Real offset, const int power=2, const F sigma0=5.0, const Real center=0)
	FormulaPMLPowerSigma (const Real offset, const int power=2, const F sigma0=5.0, const Real center=0)
bool	inPMLregion (const Real p, const Real t=0.0)
bool	inPMLregion (const concepts::Real p, const Real t=0.0)
virtual F	operator() (const ElementWithCell< G > &elm, const Real p, const Real t=0.0) const
virtual F	operator() (const Real3d &p, const Real t=0.0) const
	Application operator.
virtual F	operator() (const Real2d &p, const Real t=0.0) const
	Application operator.
virtual F	operator() (const concepts::Real2d &p, const Real t=0.0) const
	Application operator.
virtual F	operator() (const ElementWithCell< concepts::Realtype< F >::type > &elm, const Real3d &p, const Real t=0.0) const =0
virtual F	operator() (const Real p, const Real t=0.0) const
	Application operator.
virtual F	operator() (const ElementWithCell< concepts::Realtype< F >::type > &elm, const Real p, const Real t=0.0) const =0
	Evaluates the formula.
virtual F	operator() (const concepts::Real3d &p, const Real t=0.0) const
	Application operator.
virtual F	operator() (const Real p, const Real t=0.0) const
	Application operator.
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< 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 Connector &cntr, const Real p, const Real t=0.0) const
	Convenience implementation, that by default ignores its elm param.
virtual F	operator() (const Connector &cntr, const Real2d &p, const Real t=0.0) const
	Convenience implementation, that by default ignores its elm param.
virtual F	operator() (const Connector &cntr, const Real3d &p, const Real t=0.0) const
	Convenience implementation, that by default ignores its elm param.
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.
Private Attributes
const Real	center
const Real	center_
const Real	offset
const Real	offset_
const int	power
const int	power_
const F	sigma0
const F	sigma0_

---

Detailed Description

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

Definition at line 477 of file pml_formula.h.

---

Member Typedef Documentation

template<typename F>

typedef Realtype<F>::type concepts::Formula< F >::G [inherited]

Reimplemented from concepts::PiecewiseFormulaBase< F >.

Definition at line 35 of file formula.hh.

template<typename F>

typedef F concepts::Formula< F >::value_type [inherited]

Reimplemented from concepts::ElementFormula< F, concepts::Realtype< F >::type >.

Reimplemented in concepts::VectorFormula< F, dim >.

Definition at line 34 of file formula.hh.

---

Constructor & Destructor Documentation

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 479 of file pml_formula.h.

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 37 of file pml_formula.hh.

---

Member Function Documentation

template<typename F = Real>

virtual FormulaPMLPowerSigma* concepts::FormulaPMLPowerSigma< F >::clone

(

)

const [inline, virtual]

Virtual copy constructor.

Implements concepts::Formula< F >.

Definition at line 487 of file pml_formula.h.

Here is the call graph for this function:

template<typename F = Real>

virtual FormulaPMLPowerSigma* concepts::FormulaPMLPowerSigma< F >::clone

(

)

const [inline, virtual]

Virtual copy constructor.

Implements concepts::Formula< F >.

Definition at line 45 of file pml_formula.hh.

Here is the call graph for this function:

template<typename F>

virtual const F& concepts::PiecewiseFormulaBase< F >::dflt_value

(

)

const [inline, virtual, inherited]

Gives default value.

Definition at line 76 of file piecewiseFormula.hh.

template<typename F>

virtual F& concepts::PiecewiseFormulaBase< F >::dflt_value

(

)

[inline, virtual, inherited]

Gives default value.

Definition at line 78 of file piecewiseFormula.hh.

template<typename F = Real>

virtual std::ostream& concepts::FormulaPMLPowerSigma< F >::info

(

std::ostream &

os

)

const [inline, protected, virtual]

Returns information in an output stream.

Reimplemented from concepts::PiecewiseFormulaBase< F >.

Definition at line 526 of file pml_formula.h.

template<typename F = Real>

virtual std::ostream& concepts::FormulaPMLPowerSigma< F >::info

(

std::ostream &

os

)

const [inline, protected, virtual]

Returns information in an output stream.

Reimplemented from concepts::PiecewiseFormulaBase< F >.

Definition at line 83 of file pml_formula.hh.

template<typename F = Real>

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

Definition at line 491 of file pml_formula.h.

Here is the call graph for this function:

template<typename F = Real>

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

Definition at line 49 of file pml_formula.hh.

Here is the call graph for this function:

template<typename F>

virtual F concepts::PiecewiseFormulaBase< F >::operator()	(	const ElementWithCell< G > &	elm,
		const Real	p,
		const Real	t = 0.0
	)		const [inline, virtual, inherited]

Definition at line 47 of file piecewiseFormula.hh.

template<typename F>

virtual F concepts::Formula< F >::operator()	(	const Connector &	cntr,
		const Real3d &	p,
		const Real	t = 0.0
	)		const [inline, virtual, inherited]

Convenience implementation, that by default ignores its elm param.

Implements concepts::PiecewiseFormulaBase< F >.

Definition at line 57 of file formula.hh.

template<typename F>

virtual F concepts::Formula< F >::operator()	(	const Connector &	cntr,
		const Real2d &	p,
		const Real	t = 0.0
	)		const [inline, virtual, inherited]

Convenience implementation, that by default ignores its elm param.

Implements concepts::PiecewiseFormulaBase< F >.

Definition at line 54 of file formula.hh.

template<typename F>

virtual F concepts::Formula< F >::operator()	(	const Connector &	cntr,
		const Real	p,
		const Real	t = 0.0
	)		const [inline, virtual, inherited]

Convenience implementation, that by default ignores its elm param.

Implements concepts::PiecewiseFormulaBase< F >.

Definition at line 51 of file formula.hh.

template<typename F = Real>

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

Application operator.

Evaluates the formula.

Parameters:

p	Point in space
t	Point in time

Implements concepts::Formula< F >.

Definition at line 498 of file pml_formula.h.

Here is the call graph for this function:

template<typename F>

virtual F concepts::PiecewiseFormulaBase< F >::operator()	(	const ElementWithCell< G > &	elm,
		const Real2d &	p,
		const Real	t = 0.0
	)		const [inline, virtual, inherited]

Definition at line 52 of file piecewiseFormula.hh.

template<typename F>

virtual F concepts::PiecewiseFormulaBase< F >::operator()	(	const ElementWithCell< G > &	elm,
		const Real3d &	p,
		const Real	t = 0.0
	)		const [inline, virtual, inherited]

Definition at line 58 of file piecewiseFormula.hh.

template<typename F = Real>

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

Application operator.

Evaluates the formula.

Parameters:

p	Point in space
t	Point in time

Implements concepts::Formula< F >.

Definition at line 63 of file pml_formula.hh.

template<typename F = Real>

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

Application operator.

Evaluates the formula.

Parameters:

p	Point in space
t	Point in time

Implements concepts::Formula< F >.

Definition at line 56 of file pml_formula.hh.

Here is the call graph for this function:

template<typename F = Real>

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

Application operator.

Evaluates the formula.

Parameters:

p	Point in space
t	Point in time

Implements concepts::Formula< F >.

Definition at line 506 of file pml_formula.h.

template<typename F = Real>

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

Application operator.

Evaluates the formula.

Parameters:

p	Point in space
t	Point in time

Implements concepts::Formula< F >.

Definition at line 67 of file pml_formula.hh.

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 virtual, inherited]

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 virtual, inherited]

template<typename F = Real>

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

Application operator.

Evaluates the formula.

Parameters:

p	Point in space
t	Point in time

Implements concepts::Formula< F >.

Definition at line 510 of file pml_formula.h.

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 virtual, inherited]

Evaluates the formula.

Parameters:

elm	Element
p	Point in space in local element coordinates
t	Point in time

template<typename F = Real>

template<typename Real >

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

Definition at line 514 of file pml_formula.h.

template<typename F = Real>

template<typename Real >

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

Definition at line 71 of file pml_formula.hh.

---

Member Data Documentation

template<typename F = Real>

const Real concepts::FormulaPMLPowerSigma< F >::center [private]

Definition at line 532 of file pml_formula.h.

template<typename F = Real>

const Real concepts::FormulaPMLPowerSigma< F >::center_ [private]

Definition at line 89 of file pml_formula.hh.

template<typename F = Real>

const Real concepts::FormulaPMLPowerSigma< F >::offset [private]

Definition at line 531 of file pml_formula.h.

template<typename F = Real>

const Real concepts::FormulaPMLPowerSigma< F >::offset_ [private]

Definition at line 88 of file pml_formula.hh.

template<typename F = Real>

const int concepts::FormulaPMLPowerSigma< F >::power [private]

Definition at line 533 of file pml_formula.h.

template<typename F = Real>

const int concepts::FormulaPMLPowerSigma< F >::power_ [private]

Definition at line 90 of file pml_formula.hh.

template<typename F = Real>

const F concepts::FormulaPMLPowerSigma< F >::sigma0 [private]

Definition at line 534 of file pml_formula.h.

template<typename F = Real>

const F concepts::FormulaPMLPowerSigma< F >::sigma0_ [private]

Definition at line 91 of file pml_formula.hh.

---

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

• app-bholger/pml/pml_formula.h
• waveprop/pml_formula.hh