#include <sphericalFormula.hh>

Inheritance diagram for concepts::SphericalFormula< Real >:

Public Types
typedef Real	value_type

typedef Realtype< Real >::type	G

typedef concepts::Sequence< std::pair< std::string, std::string > >	RepSeq

Public Member Functions
	SphericalFormula (const std::string formula)
	Constructor.

	SphericalFormula (const SphericalFormula &frm)
	Copy Constructor.

virtual SphericalFormula< Real > *	clone () const
	Virtual copy constructor.

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

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

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

void	set (const std::string formula, uint i=0, RepSeq rep=RepSeq())
	Sets the `i` th formula.


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.

Real	process_ (const Real3d &p, const Real t=0.0, uint i=0) const
	Processing the `i` th formula (with time-dependency variable)

Protected Attributes
std::string	formula_ [dim]
	The original formula.

Detailed Description

Formula in spherical polar coordinates. In such a formula, x has the meaning of the radius, y has the meaning of the angle phi and z has the meaning of the angle theta. The input parameters of the application operators has to be given in Kartesian coordinates.

$r^2 = x^2 + y^2 + z^2, \tan \phi = \frac{y}{x}, \cos \theta = \frac{z}{r},$

where $\phi \in (-\pi, \pi)$ and $\theta \in (0,\pi)$ .

Author: Philipp Frauenfelder, 2002, Robert 2013

Definition at line 33 of file sphericalFormula.hh.

Member Typedef Documentation

◆ G

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

inherited

Definition at line 37 of file formula.hh.

◆ RepSeq

typedef concepts::Sequence<std::pair<std::string,std::string> > concepts::ParsedFormulaBase< dim >::RepSeq

inherited

Definition at line 62 of file parsedFormula.hh.

◆ value_type

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

inherited

Definition at line 36 of file formula.hh.

Constructor & Destructor Documentation

◆ SphericalFormula() [1/2]

concepts::SphericalFormula< Real >::SphericalFormula ( const std::string formula )

inline

Constructor.

Definition at line 36 of file sphericalFormula.hh.

◆ SphericalFormula() [2/2]

concepts::SphericalFormula< Real >::SphericalFormula ( const SphericalFormula< Real > & frm )

inline

Copy Constructor.

Definition at line 38 of file sphericalFormula.hh.

Member Function Documentation

◆ clone()

virtual SphericalFormula< Real > * concepts::SphericalFormula< Real >::clone ( ) const

virtual

Virtual copy constructor.

Reimplemented from concepts::ParsedFormula< Real >.

◆ 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()

virtual std::ostream & concepts::SphericalFormula< Real >::info ( std::ostream & os ) const

protectedvirtual

Returns information in an output stream.

Reimplemented from concepts::ParsedFormula< Real >.

◆ 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

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

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

elm	Element
p	Point in space in local element coordinates
t	Point 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::SphericalFormula< Real >::operator()	(	const Real	p,
		const Real	t = `0.0`
	)		const

virtual

Application operator. Evaluates the formula.

Parameters

p	Point in space
t	Point in time

Reimplemented from concepts::ParsedFormula< Real >.

◆ operator()() [11/12]

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

virtual

Reimplemented from concepts::ParsedFormula< Real >.

◆ operator()() [12/12]

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

virtual

Reimplemented from concepts::ParsedFormula< Real >.

Member Data Documentation

◆ formula_

std::string concepts::ParsedFormulaBase< dim >::formula_[dim]

protectedinherited

The original formula.

Definition at line 85 of file parsedFormula.hh.

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

formula/sphericalFormula.hh

Class documentation of Concepts

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ G

◆ RepSeq

◆ value_type

Constructor & Destructor Documentation

◆ SphericalFormula() [1/2]

◆ SphericalFormula() [2/2]

Member Function Documentation

◆ clone()

◆ dflt_value() [1/2]

◆ dflt_value() [2/2]

◆ info()

◆ operator()() [1/12]

◆ operator()() [2/12]

◆ operator()() [3/12]

◆ operator()() [4/12]

◆ operator()() [5/12]

◆ operator()() [6/12]

◆ operator()() [7/12]

◆ operator()() [8/12]

◆ operator()() [9/12]

◆ operator()() [10/12]

◆ operator()() [11/12]

◆ operator()() [12/12]

Member Data Documentation

◆ formula_