Public Types | Public Member Functions | Protected Attributes | List of all members

concepts::FormulaLayerPlaneWaveLayer Class Referenceabstract

Formula for plane wave source in layered structure. More...

#include <sources.hh>

Inheritance diagram for concepts::FormulaLayerPlaneWaveLayer:
concepts::Formula< Cmplx >

Public Types

typedef Realtype< Cmplx >::type G
 
typedef Cmplx value_type
 

Public Member Functions

FormulaLayerPlaneWaveLayer * clone () const
 
virtual Formula * clone () const=0
 
 FormulaLayerPlaneWaveLayer (const Cmplx a, const Cmplx b, const Real kx, const Real ky, const int layer_label=0)
 
 FormulaLayerPlaneWaveLayer (const FormulaLayerPlaneWaveLayer &other)
 
std::ostream & info (std::ostream &os) const
 
Cmplx operator() (const Real p, const Real t=0.0) const
 Application operator. More...
 
Cmplx operator() (const Real2d &p, const Real t=0.0) const
 Application operator. More...
 
Cmplx operator() (const Real3d &p, const Real t=0.0) const
 Application operator. More...
 
 ~FormulaLayerPlaneWaveLayer ()
 

Protected Attributes

Cmplx a_
 Complex coefficient associated to the plane wave $\exp(\imath(k_x x + k_y y))$. More...
 
Cmplx b_
 Complex coefficient associated to the plane wave $\exp(\imath(k_x x - k_y y))$. More...
 
Real kx_
 Wave number in the $x$-direction. More...
 
Real ky_
 Wave number in the $y$-direction. More...
 
int layer_label_
 Layer label. More...
 

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

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

Definition at line 981 of file sources.hh.

◆ clone() [2/2]

virtual Formula* concepts::Formula< Cmplx >::clone ( ) const
pure virtualinherited

◆ info()

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

Definition at line 1003 of file sources.hh.

◆ operator()() [1/6]

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.

Definition at line 53 of file formula.hh.

◆ operator()() [2/6]

virtual Cmplx concepts::Formula< Cmplx >::operator() ( const Connector &  cntr,
const Real2d &  p,
const Real  t = 0.0 
) const
inlinevirtualinherited

Convenience implementation, that by default ignores its elm param.

Definition at line 56 of file formula.hh.

◆ operator()() [3/6]

virtual Cmplx concepts::Formula< Cmplx >::operator() ( const Connector &  cntr,
const Real3d &  p,
const Real  t = 0.0 
) const
inlinevirtualinherited

Convenience implementation, that by default ignores its elm param.

Definition at line 59 of file formula.hh.

◆ operator()() [4/6]

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

Definition at line 997 of file sources.hh.

◆ operator()() [5/6]

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

Application operator.

Evaluates the formula.

Parameters
pPoint in space
tPoint in time

Implements concepts::Formula< Cmplx >.

Definition at line 991 of file sources.hh.

◆ operator()() [6/6]

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

Application operator.

Evaluates the formula.

Parameters
pPoint in space
tPoint in time

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 $x$-direction.

Definition at line 966 of file sources.hh.

◆ ky_

Real concepts::FormulaLayerPlaneWaveLayer::ky_
protected

Wave number in the $y$-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:
Page URL: http://wiki.math.ethz.ch/bin/view/Concepts/WebHome
21 August 2020
© 2020 Eidgenössische Technische Hochschule Zürich