IC::Trig Class Reference

#include <Trig.H>

Inheritance diagram for IC::Trig:

Public Member Functions
	Trig (amrex::Vector< amrex::Geometry > &_geom, Set::Scalar _alpha=1.0, AMREX_D_DECL(std::complex< int > _n1=0, std::complex< int > _n2=0, std::complex< int > _n3=0), int _dim=AMREX_SPACEDIM)
	Trig (amrex::Vector< amrex::Geometry > &_geom, IO::ParmParse &pp, std::string name)
void	Define (Set::Scalar _alpha=1.0, AMREX_D_DECL(std::complex< int > _n1=0, std::complex< int > _n2=0, std::complex< int > _n3=0), int _dim=AMREX_SPACEDIM)
virtual void	Add (const int &lev, Set::Field< Set::Scalar > &a_field, Set::Scalar) override
virtual void	Add (const int &lev, Set::Field< Set::Vector > &a_field, Set::Scalar) override
Public Member Functions inherited from IC::IC< Set::Scalar >
	IC (amrex::Vector< amrex::Geometry > &_geom)
virtual	~IC ()
void	Add (const int &lev, Set::Field< Set::Scalar > &field)
void	Initialize (const int &a_lev, Set::Field< Set::Scalar > &a_field, Set::Scalar a_time=0.0)
void	Initialize (const int &a_lev, Set::Field< Set::Scalar > &a_field, Set::Scalar a_time=0.0)
virtual void	SetComp (int a_comp) final
Public Member Functions inherited from IC::IC< Set::Vector >
	IC (amrex::Vector< amrex::Geometry > &_geom)
virtual	~IC ()
void	Add (const int &lev, Set::Field< Set::Vector > &field)
void	Initialize (const int &a_lev, Set::Field< Set::Vector > &a_field, Set::Scalar a_time=0.0)
void	Initialize (const int &a_lev, Set::Field< Set::Vector > &a_field, Set::Scalar a_time=0.0)
virtual void	SetComp (int a_comp) final

Static Public Member Functions
static void	Parse (Trig &value, IO::ParmParse &pp)

Static Public Attributes
static constexpr const char *	name = "trig"

Private Member Functions
std::complex< int >	AMREX_D_DECL (n1, n2, n3)
Set::Scalar	AMREX_D_DECL (phi1=0.0, phi2=0.0, phi3=0.0)

Private Attributes
int	dim = AMREX_SPACEDIM
Set::Scalar	alpha = 1.0

Additional Inherited Members
Protected Attributes inherited from IC::IC< Set::Scalar >
amrex::Vector< amrex::Geometry > &	geom
int	comp
Protected Attributes inherited from IC::IC< Set::Vector >
amrex::Vector< amrex::Geometry > &	geom
int	comp

Detailed Description

Definition at line 22 of file Trig.H.

Constructor & Destructor Documentation

Trig() [1/2]

IC::Trig::Trig ( amrex::Vector< amrex::Geometry > &  _geom, Set::Scalar  _alpha = 1.0, AMREX_D_DECL(std::complex< int > _n1=0, std::complex< int > _n2=0, std::complex< int > _n3=0)  , int  _dim = AMREX_SPACEDIM  )

inline

Definition at line 26 of file Trig.H.

Trig() [2/2]

IC::Trig::Trig ( amrex::Vector< amrex::Geometry > &  _geom, IO::ParmParse &  pp, std::string  name  )

inline

Definition at line 36 of file Trig.H.

Member Function Documentation

Add() [1/2]

virtual void IC::Trig::Add ( const int &  lev, Set::Field< Set::Scalar > &  a_field, Set::Scalar    )

inlineoverridevirtual

Implements IC::IC< Set::Scalar >.

Definition at line 56 of file Trig.H.

Add() [2/2]

virtual void IC::Trig::Add ( const int &  lev, Set::Field< Set::Vector > &  a_field, Set::Scalar    )

inlineoverridevirtual

Implements IC::IC< Set::Vector >.

Definition at line 110 of file Trig.H.

AMREX_D_DECL() [1/2]

std::complex< int > IC::Trig::AMREX_D_DECL ( n1  , n2  , n3    )

private

AMREX_D_DECL() [2/2]

Set::Scalar IC::Trig::AMREX_D_DECL ( phi1  = 0.0, phi2  = 0.0, phi3  = 0.0  )

private

Define()

void IC::Trig::Define ( Set::Scalar  _alpha = 1.0, AMREX_D_DECL(std::complex< int > _n1=0, std::complex< int > _n2=0, std::complex< int > _n3=0)  , int  _dim = AMREX_SPACEDIM  )

inline

Definition at line 41 of file Trig.H.

Parse()

static void IC::Trig::Parse ( Trig &  value, IO::ParmParse &  pp  )

inlinestatic

Definition at line 166 of file Trig.H.

Field Documentation

alpha

Set::Scalar IC::Trig::alpha = 1.0

private

Definition at line 190 of file Trig.H.

dim

int IC::Trig::dim = AMREX_SPACEDIM

private

Definition at line 189 of file Trig.H.

name

constexpr const char* IC::Trig::name = "trig"

staticconstexpr

Definition at line 25 of file Trig.H.

---

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

• src/IC/Trig.H