Class documentation of Concepts

Loading...
Searching...
No Matches
concepts::FormulaPMLCart Class Referenceabstract

#include <pml_formula.hh>

Inheritance diagram for concepts::FormulaPMLCart:
concepts::ElementFormula< Cmplx > concepts::ElementFormula< Cmplx > concepts::Cloneable concepts::OutputOperator concepts::Cloneable concepts::OutputOperator

Public Types

enum  PMLMode {
  DXDX , DYDY , IDENT , DX ,
  DY , DXDX , DYDY , IDENT ,
  DX , DY
}
 
enum  PMLMode {
  DXDX , DYDY , IDENT , DX ,
  DY , DXDX , DYDY , IDENT ,
  DX , DY
}
 
typedef Cmplx value_type
 

Public Member Functions

 FormulaPMLCart (RCP< const ElementFormula< Cmplx > > coeff_a, RCP< const ElementFormula< Cmplx > > coeff_b, RCP< concepts::Formula< Real > > sigma_x, RCP< concepts::Formula< Real > > sigma_y, PMLMode mode, double omega)
 
virtual FormulaPMLCartclone () const
 Virtual copy constructor.
 
virtual Cmplx operator() (const ElementWithCell< Real > &elm, const Real3d &p, const Real t=0.0) const
 
virtual Cmplx operator() (const ElementWithCell< Real > &elm, const Real2d &p, const Real t=0.0) const
 
virtual Cmplx operator() (const ElementWithCell< Real > &elm, const Real p, const Real t=0.0) const
 
Cmplx gammaX (Real x) const
 
Cmplx gammaY (Real y) const
 
template<class RealNd >
Cmplx operator() (const ElementWithCell< Real > &elm, const RealNd &p, Real2d px, const Real t=0.0) const
 
 FormulaPMLCart (const ElementFormulaContainer< Cmplx > coeff_a, const ElementFormulaContainer< Cmplx > coeff_b, RCP< Formula< Real > > sigma_x, RCP< Formula< Real > > sigma_y, PMLMode mode, double omega)
 
virtual FormulaPMLCartclone () const
 Virtual copy constructor.
 
virtual Cmplx operator() (const ElementWithCell< Real > &elm, const Real3d &p, const Real t=0.0) const
 
virtual Cmplx operator() (const ElementWithCell< Real > &elm, const Real2d &p, const Real t=0.0) const
 
virtual Cmplx operator() (const ElementWithCell< Real > &elm, const Real p, const Real t=0.0) const
 
Cmplx gammaX (Real x) const
 
Cmplx gammaY (Real y) const
 
template<class RealNd >
Cmplx operator() (const ElementWithCell< Real > &elm, const RealNd &p, Real2d px, const Real t=0.0) const
 
virtual Cmplx operator() (const ElementWithCell< typename Realtype< Cmplx >::type > &elm, const Real p, const Real t=0.0) const=0
 
virtual Cmplx operator() (const ElementWithCell< typename Realtype< Cmplx >::type > &elm, const Real2d &p, const Real t=0.0) const=0
 
virtual Cmplx operator() (const ElementWithCell< typename Realtype< Cmplx >::type > &elm, const Real3d &p, const Real t=0.0) const=0
 

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

Class for Cartesian PML, see Collino & Monk

Definition at line 674 of file pml_formula.h.

Member Typedef Documentation

◆ value_type

typedef Cmplx concepts::ElementFormula< Cmplx , typename Realtype<Cmplx >::type >::value_type
inherited

Definition at line 37 of file elementFormula.hh.

Member Enumeration Documentation

◆ PMLMode [1/2]

enum concepts::FormulaPMLCart::PMLMode

Definition at line 676 of file pml_formula.h.

◆ PMLMode [2/2]

enum concepts::FormulaPMLCart::PMLMode

Definition at line 281 of file pml_formula.hh.

Constructor & Destructor Documentation

◆ FormulaPMLCart() [1/2]

concepts::FormulaPMLCart::FormulaPMLCart ( RCP< const ElementFormula< Cmplx > >  coeff_a,
RCP< const ElementFormula< Cmplx > >  coeff_b,
RCP< concepts::Formula< Real > >  sigma_x,
RCP< concepts::Formula< Real > >  sigma_y,
PMLMode  mode,
double  omega 
)
inline

Definition at line 678 of file pml_formula.h.

◆ FormulaPMLCart() [2/2]

concepts::FormulaPMLCart::FormulaPMLCart ( const ElementFormulaContainer< Cmplx coeff_a,
const ElementFormulaContainer< Cmplx coeff_b,
RCP< Formula< Real > >  sigma_x,
RCP< Formula< Real > >  sigma_y,
PMLMode  mode,
double  omega 
)
inline

Definition at line 283 of file pml_formula.hh.

Member Function Documentation

◆ clone() [1/2]

virtual FormulaPMLCart * concepts::FormulaPMLCart::clone ( ) const
inlinevirtual

Virtual copy constructor.

Implements concepts::ElementFormula< Cmplx >.

Definition at line 693 of file pml_formula.h.

◆ clone() [2/2]

virtual FormulaPMLCart * concepts::FormulaPMLCart::clone ( ) const
inlinevirtual

Virtual copy constructor.

Implements concepts::ElementFormula< Cmplx >.

Definition at line 298 of file pml_formula.hh.

◆ gammaX() [1/2]

Cmplx concepts::FormulaPMLCart::gammaX ( Real  x) const
inline

Definition at line 714 of file pml_formula.h.

◆ gammaX() [2/2]

Cmplx concepts::FormulaPMLCart::gammaX ( Real  x) const
inline

Definition at line 318 of file pml_formula.hh.

◆ gammaY() [1/2]

Cmplx concepts::FormulaPMLCart::gammaY ( Real  y) const
inline

Definition at line 718 of file pml_formula.h.

◆ gammaY() [2/2]

Cmplx concepts::FormulaPMLCart::gammaY ( Real  y) const
inline

Definition at line 322 of file pml_formula.hh.

◆ info() [1/2]

virtual std::ostream & concepts::FormulaPMLCart::info ( std::ostream &  os) const
inlineprotectedvirtual

Returns information in an output stream.

Reimplemented from concepts::OutputOperator.

Definition at line 740 of file pml_formula.h.

◆ info() [2/2]

virtual std::ostream & concepts::FormulaPMLCart::info ( std::ostream &  os) const
inlineprotectedvirtual

Returns information in an output stream.

Reimplemented from concepts::OutputOperator.

Definition at line 342 of file pml_formula.hh.

◆ operator()() [1/11]

virtual Cmplx concepts::FormulaPMLCart::operator() ( const ElementWithCell< Real > &  elm,
const Real  p,
const Real  t = 0.0 
) const
inlinevirtual

Definition at line 708 of file pml_formula.h.

◆ operator()() [2/11]

virtual Cmplx concepts::FormulaPMLCart::operator() ( const ElementWithCell< Real > &  elm,
const Real  p,
const Real  t = 0.0 
) const
inlinevirtual

Definition at line 312 of file pml_formula.hh.

◆ operator()() [3/11]

virtual Cmplx concepts::FormulaPMLCart::operator() ( const ElementWithCell< Real > &  elm,
const Real2d p,
const Real  t = 0.0 
) const
inlinevirtual

Definition at line 703 of file pml_formula.h.

◆ operator()() [4/11]

virtual Cmplx concepts::FormulaPMLCart::operator() ( const ElementWithCell< Real > &  elm,
const Real2d p,
const Real  t = 0.0 
) const
inlinevirtual

Definition at line 307 of file pml_formula.hh.

◆ operator()() [5/11]

virtual Cmplx concepts::FormulaPMLCart::operator() ( const ElementWithCell< Real > &  elm,
const Real3d p,
const Real  t = 0.0 
) const
inlinevirtual

Definition at line 698 of file pml_formula.h.

◆ operator()() [6/11]

virtual Cmplx concepts::FormulaPMLCart::operator() ( const ElementWithCell< Real > &  elm,
const Real3d p,
const Real  t = 0.0 
) const
inlinevirtual

Definition at line 302 of file pml_formula.hh.

◆ operator()() [7/11]

template<class RealNd >
Cmplx concepts::FormulaPMLCart::operator() ( const ElementWithCell< Real > &  elm,
const RealNd p,
Real2d  px,
const Real  t = 0.0 
) const
inline

Definition at line 725 of file pml_formula.h.

◆ operator()() [8/11]

template<class RealNd >
Cmplx concepts::FormulaPMLCart::operator() ( const ElementWithCell< Real > &  elm,
const RealNd p,
Real2d  px,
const Real  t = 0.0 
) const
inline

Definition at line 327 of file pml_formula.hh.

◆ operator()() [9/11]

virtual Cmplx concepts::ElementFormula< Cmplx , typename Realtype<Cmplx >::type >::operator() ( const ElementWithCell< typename Realtype<Cmplx >::type > &  elm,
const Real  p,
const Real  t = 0.0 
) const
pure virtualinherited

Evaluates the formula.

Parameters
elmElement
pPoint in space in local element coordinates
tPoint in time

◆ operator()() [10/11]

virtual Cmplx concepts::ElementFormula< Cmplx , typename Realtype<Cmplx >::type >::operator() ( const ElementWithCell< typename Realtype<Cmplx >::type > &  elm,
const Real2d p,
const Real  t = 0.0 
) const
pure virtualinherited

Evaluates the formula.

Parameters
elmElement
pPoint in space in local element coordinates
tPoint in time

◆ operator()() [11/11]

virtual Cmplx concepts::ElementFormula< Cmplx , typename Realtype<Cmplx >::type >::operator() ( const ElementWithCell< typename Realtype<Cmplx >::type > &  elm,
const Real3d p,
const Real  t = 0.0 
) const
pure virtualinherited

Evaluates the formula.

Parameters
elmElement
pPoint in space in local element coordinates
tPoint in time

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