Class documentation of Concepts

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

#include <pml_edge.hh>

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

Public Types

enum class  Mode : int {
  A11 , A22 , A12 , A21 ,
  M11 , M22 , M12 , M21 ,
  N11 , N22 , N12 , N21 ,
  IDENT , ROTROT
}
 
typedef Cmplx value_type
 

Public Member Functions

 FormulaPMLEdgeRadia ()
 
 FormulaPMLEdgeRadia (RCP< Formula< Real > > sigma, RCP< Formula< Real > > sigmaB, Mode mode, const Real2d &center=Real2d(0, 0))
 
virtual FormulaPMLEdgeRadiaclone () const
 Virtual copy constructor.
 
virtual Cmplx operator() (const ElementWithCell< Real > &elm, const Real 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 Real3d &p, const Real t=0.0) const
 
RCP< Formula< Real > > sigma () const
 
RCP< Formula< Real > > sigmaB () 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.
 

Detailed Description

Class for radial PML in polar coordinates.

The class provides formulas for radial PML in polar coordinates, which are determined by one of the following modes:

IDENT The term for the (scalar) identity. ROTROT The term for the curl-curl. Aij The i-j-enty of the matrix function A. Mij The i-j-enty of the matrix function M. Nij The i-j-enty of the matrix function N.

Author
Vinh Tho Ma, 2016

Definition at line 30 of file pml_edge.hh.

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

◆ Mode

enum class concepts::FormulaPMLEdgeRadia::Mode : int
strong

Definition at line 32 of file pml_edge.hh.

Constructor & Destructor Documentation

◆ FormulaPMLEdgeRadia()

concepts::FormulaPMLEdgeRadia::FormulaPMLEdgeRadia ( )

Constructor

Parameters
sigmaFunction $\sigma: \mathbb{R}^2\to\mathbb{R}$
sigmaBFunction $\overline{\sigma}: \mathbb{R}^2\to\mathbb{R}$
modeOne of the four modes

Member Function Documentation

◆ clone()

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

Virtual copy constructor.

Implements concepts::ElementFormula< Cmplx >.

Definition at line 60 of file pml_edge.hh.

◆ info()

virtual std::ostream & concepts::FormulaPMLEdgeRadia::info ( std::ostream &  os) const
protectedvirtual

Returns information in an output stream.

Reimplemented from concepts::OutputOperator.

◆ operator()() [1/3]

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

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

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

◆ sigma()

RCP< Formula< Real > > concepts::FormulaPMLEdgeRadia::sigma ( ) const
inline

Definition at line 71 of file pml_edge.hh.

◆ sigmaB()

RCP< Formula< Real > > concepts::FormulaPMLEdgeRadia::sigmaB ( ) const
inline

Definition at line 74 of file pml_edge.hh.


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