Alamo
Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Attributes
IC::Constant Class Reference

#include <Constant.H>

Inheritance diagram for IC::Constant:
IC::IC< Set::Scalar > IC::IC< Set::Vector >

Public Member Functions

virtual ~Constant ()=default
 
 Constant (amrex::Vector< amrex::Geometry > &_geom)
 
 Constant (amrex::Vector< amrex::Geometry > &_geom, IO::ParmParse &pp)
 
 Constant (amrex::Vector< amrex::Geometry > &_geom, IO::ParmParse &pp, std::string name)
 
 Constant (amrex::Vector< amrex::Geometry > &_geom, Unit a_unit, IO::ParmParse &pp, std::string name)
 
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 (Constant &value, IO::ParmParse &pp)
 

Static Public Attributes

static constexpr const char * name = "constant"
 

Private Attributes

std::vector< Set::Scalarm_value
 
Unit unit
 

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 17 of file Constant.H.

Constructor & Destructor Documentation

◆ ~Constant()

virtual IC::Constant::~Constant ( )
virtualdefault

◆ Constant() [1/4]

IC::Constant::Constant ( amrex::Vector< amrex::Geometry > &  _geom)
inline

Definition at line 24 of file Constant.H.

◆ Constant() [2/4]

IC::Constant::Constant ( amrex::Vector< amrex::Geometry > &  _geom,
IO::ParmParse pp 
)
inline

Definition at line 26 of file Constant.H.

◆ Constant() [3/4]

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

Definition at line 29 of file Constant.H.

◆ Constant() [4/4]

IC::Constant::Constant ( amrex::Vector< amrex::Geometry > &  _geom,
Unit  a_unit,
IO::ParmParse pp,
std::string  name 
)
inline

Definition at line 32 of file Constant.H.

Member Function Documentation

◆ Add() [1/2]

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

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

Definition at line 37 of file Constant.H.

◆ Add() [2/2]

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

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

Definition at line 51 of file Constant.H.

◆ Parse()

static void IC::Constant::Parse ( Constant value,
IO::ParmParse pp 
)
inlinestatic

Definition at line 65 of file Constant.H.

Field Documentation

◆ m_value

std::vector<Set::Scalar> IC::Constant::m_value
private

Definition at line 74 of file Constant.H.

◆ name

constexpr const char* IC::Constant::name = "constant"
staticconstexpr

Definition at line 20 of file Constant.H.

◆ unit

Unit IC::Constant::unit
private

Definition at line 75 of file Constant.H.


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