#include <sources.hh>

Inheritance diagram for concepts::FormulaLayerPlaneWaveLayer:

Public Types
typedef Cmplx	value_type

typedef Realtype< Cmplx >::type	G

Public Member Functions
	FormulaLayerPlaneWaveLayer (const Cmplx a, const Cmplx b, const Real kx, const Real ky, const int layer_label=0)

	FormulaLayerPlaneWaveLayer (const FormulaLayerPlaneWaveLayer &other)

FormulaLayerPlaneWaveLayer *	clone () const
	Virtual copy constructor.

Cmplx	operator() (const Real3d &p, const Real t=0.0) const

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

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

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

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 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

Protected Attributes
Cmplx	a_
	Complex coefficient associated to the plane wave $\exp(\imath(k_x x + k_y y))$ .

Cmplx	b_
	Complex coefficient associated to the plane wave $\exp(\imath(k_x x - k_y y))$ .

Real	kx_
	Wave number in the -direction.

Real	ky_
	Wave number in the -direction.

int	layer_label_
	Layer label.

Detailed Description

Formula for plane wave source in layered structure.

This formula build the layered plane wave source for one layer, given the coefficients of this layer.

Author: Adrien Semin, 2016

Definition at line 958 of file sources.hh.

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

◆ FormulaLayerPlaneWaveLayer() [1/2]

concepts::FormulaLayerPlaneWaveLayer::FormulaLayerPlaneWaveLayer	(	const Cmplx	a,
		const Cmplx	b,
		const Real	kx,
		const Real	ky,
		const int	layer_label = `0`
	)

inline

Definition at line 973 of file sources.hh.

◆ FormulaLayerPlaneWaveLayer() [2/2]

concepts::FormulaLayerPlaneWaveLayer::FormulaLayerPlaneWaveLayer ( const FormulaLayerPlaneWaveLayer & other )

inline

Definition at line 976 of file sources.hh.

◆ ~FormulaLayerPlaneWaveLayer()

concepts::FormulaLayerPlaneWaveLayer::~FormulaLayerPlaneWaveLayer ( )

inline

Definition at line 979 of file sources.hh.

Member Function Documentation

◆ clone()

FormulaLayerPlaneWaveLayer * concepts::FormulaLayerPlaneWaveLayer::clone ( ) const

inlinevirtual

Virtual copy constructor.

Implements concepts::Formula< Cmplx >.

Definition at line 981 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()

std::ostream & concepts::FormulaLayerPlaneWaveLayer::info ( std::ostream & os ) const

inlinevirtual

Returns information in an output stream.

Reimplemented from concepts::PiecewiseFormulaBase< F >.

Definition at line 1003 of file sources.hh.

◆ operator()() [1/12]

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

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

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

Cmplx concepts::FormulaLayerPlaneWaveLayer::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< Cmplx >.

Definition at line 997 of file sources.hh.

◆ operator()() [11/12]

Cmplx concepts::FormulaLayerPlaneWaveLayer::operator()	(	const Real2d &	p,
		const Real	t = `0.0`
	)		const

inlinevirtual

Implements concepts::Formula< Cmplx >.

Definition at line 991 of file sources.hh.

◆ operator()() [12/12]

Cmplx concepts::FormulaLayerPlaneWaveLayer::operator()	(	const Real3d &	p,
		const Real	t = `0.0`
	)		const

inlinevirtual

Implements concepts::Formula< Cmplx >.

Definition at line 985 of file sources.hh.

Member Data Documentation

◆ a_

Cmplx concepts::FormulaLayerPlaneWaveLayer::a_

protected

Complex coefficient associated to the plane wave $\exp(\imath(k_x x + k_y y))$ .

Definition at line 962 of file sources.hh.

◆ b_

Cmplx concepts::FormulaLayerPlaneWaveLayer::b_

protected

Complex coefficient associated to the plane wave $\exp(\imath(k_x x - k_y y))$ .

Definition at line 964 of file sources.hh.

◆ kx_

Real concepts::FormulaLayerPlaneWaveLayer::kx_

protected

Wave number in the -direction.

Definition at line 966 of file sources.hh.

◆ ky_

Real concepts::FormulaLayerPlaneWaveLayer::ky_

protected

Wave number in the -direction.

Definition at line 968 of file sources.hh.

◆ layer_label_

int concepts::FormulaLayerPlaneWaveLayer::layer_label_

protected

Layer label.

Definition at line 970 of file sources.hh.

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

waveprop/sources.hh

Class documentation of Concepts

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ G

◆ value_type

Constructor & Destructor Documentation

◆ FormulaLayerPlaneWaveLayer() [1/2]

◆ FormulaLayerPlaneWaveLayer() [2/2]

◆ ~FormulaLayerPlaneWaveLayer()

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

◆ a_

◆ b_

◆ kx_

◆ ky_

◆ layer_label_