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

#include <Constant.H>

Inheritance diagram for BC::Constant:
BC::BC< Set::Scalar >

Public Member Functions

 Constant (int a_ncomp, Unit a_unit=Unit::Less())
 
 Constant (int a_ncomp, IO::ParmParse &pp, std::string name)
 
 Constant (int a_ncomp, Unit a_unit, IO::ParmParse &pp, std::string name)
 
 Constant (int ncomp, amrex::Vector< std::string > bc_hi_str, amrex::Vector< std::string > bc_lo_str, AMREX_D_DECL(amrex::Vector< amrex::Real > _bc_lo_1, amrex::Vector< amrex::Real > _bc_lo_2, amrex::Vector< amrex::Real > _bc_lo_3), AMREX_D_DECL(amrex::Vector< amrex::Real > _bc_hi_1, amrex::Vector< amrex::Real > _bc_hi_2, amrex::Vector< amrex::Real > _bc_hi_3))
 
virtual ~Constant ()
 
virtual void FillBoundary (amrex::BaseFab< Set::Scalar > &in, const amrex::Box &box, int ngrow, int dcomp, int ncomp, amrex::Real time, Orientation face=Orientation::All, const amrex::Mask *mask=nullptr) override
 
amrex::BCRec GetBCRec () override
 
virtual amrex::Array< int, AMREX_SPACEDIM > IsPeriodic () override
 
virtual amrex::Periodicity Periodicity () const override
 
virtual amrex::Periodicity Periodicity (const amrex::Box &b) override
 
template<class T >
const amrex::Array< amrex::Array< T, AMREX_SPACEDIM >, 2 > GetBCTypes ()
 
virtual void FillBoundary (amrex::BaseFab< T > &in, const amrex::Box &box, int ngrow, int dcomp, int ncomp, amrex::Real time, Orientation face=Orientation::All, const amrex::Mask *mask=nullptr)=0
 
virtual void FillBoundary (amrex::FabArray< amrex::BaseFab< T > > &mf, int dcomp, int ncomp, amrex::Real time, int)
 
virtual void FillBoundary (amrex::FabArray< amrex::BaseFab< T > > &mf, int dcomp, int ncomp, amrex::IntVect const &, amrex::Real time, int bccomp)
 
template<class Q = T>
std::enable_if< std::is_same< Q, amrex::Real >::value >::type FillBoundary (amrex::MultiFab &mf, int dcomp, int ncomp, amrex::Real time, int)
 
- Public Member Functions inherited from BC::BC< Set::Scalar >
virtual ~BC ()
 
void define (const amrex::Geometry &a_geom)
 
virtual void FillBoundary (amrex::FabArray< amrex::BaseFab< Set::Scalar > > &mf, int dcomp, int ncomp, amrex::Real time, int)
 
virtual void FillBoundary (amrex::FabArray< amrex::BaseFab< Set::Scalar > > &mf, int dcomp, int ncomp, amrex::IntVect const &, amrex::Real time, int bccomp)
 
std::enable_if< std::is_same< Q, amrex::Real >::value >::type FillBoundary (amrex::MultiFab &mf, int dcomp, int ncomp, amrex::Real time, int)
 
void operator() (amrex::FabArray< amrex::BaseFab< Set::Scalar > > &mf, int dcomp, int ncomp, amrex::IntVect const &, amrex::Real time, int bccomp)
 
std::enable_if< std::is_same< Q, amrex::Real >::value >::type operator() (amrex::MultiFab &mf, int dcomp, int ncomp, amrex::IntVect const &, amrex::Real time, int bccomp)
 

Static Public Member Functions

static Constant ZeroNeumann (int ncomp=1, Unit unit=Unit::Less())
 
static Constant ZeroDirichlet (int ncomp=1, Unit unit=Unit::Less())
 
static void Parse (Constant &value, IO::ParmParse &pp)
 

Static Public Attributes

static constexpr const char * name = "constant"
 

Private Attributes

unsigned int m_ncomp = 0
 
Unit unit = Unit::Less()
 
std::array< std::vector< int >, m_nfaces > m_bc_type
 
std::array< std::vector< Numeric::Interpolator::Linear< Set::Scalar > >, m_nfaces > m_bc_val
 

Additional Inherited Members

- Protected Attributes inherited from BC::BC< Set::Scalar >
amrex::Geometry m_geom
 
Unit unit
 

Detailed Description

Definition at line 43 of file Constant.H.

Constructor & Destructor Documentation

◆ Constant() [1/4]

BC::Constant::Constant ( int  a_ncomp,
Unit  a_unit = Unit::Less() 
)
inline

Definition at line 63 of file Constant.H.

◆ Constant() [2/4]

BC::Constant::Constant ( int  a_ncomp,
IO::ParmParse &  pp,
std::string  name 
)
inline

Definition at line 64 of file Constant.H.

◆ Constant() [3/4]

BC::Constant::Constant ( int  a_ncomp,
Unit  a_unit,
IO::ParmParse &  pp,
std::string  name 
)
inline

Definition at line 68 of file Constant.H.

◆ Constant() [4/4]

BC::Constant::Constant ( int  ncomp,
amrex::Vector< std::string >  bc_hi_str,
amrex::Vector< std::string >  bc_lo_str,
AMREX_D_DECL(amrex::Vector< amrex::Real > _bc_lo_1, amrex::Vector< amrex::Real > _bc_lo_2, amrex::Vector< amrex::Real > _bc_lo_3)  ,
AMREX_D_DECL(amrex::Vector< amrex::Real > _bc_hi_1, amrex::Vector< amrex::Real > _bc_hi_2, amrex::Vector< amrex::Real > _bc_hi_3)   
)

Definition at line 7 of file Constant.cpp.

◆ ~Constant()

virtual BC::Constant::~Constant ( )
inlinevirtual

Definition at line 114 of file Constant.H.

Member Function Documentation

◆ FillBoundary() [1/5]

void BC::Constant::FillBoundary ( amrex::BaseFab< Set::Scalar > &  in,
const amrex::Box &  box,
int  ngrow,
int  dcomp,
int  ncomp,
amrex::Real  time,
Orientation  face = Orientation::All,
const amrex::Mask *  mask = nullptr 
)
overridevirtual

Implements BC::BC< Set::Scalar >.

Definition at line 59 of file Constant.cpp.

◆ FillBoundary() [2/5]

virtual void BC::BC< T >::FillBoundary ( amrex::BaseFab< T > &  in,
const amrex::Box &  box,
int  ngrow,
int  dcomp,
int  ncomp,
amrex::Real  time,
Orientation  face = Orientation::All,
const amrex::Mask *  mask = nullptr 
)

◆ FillBoundary() [3/5]

virtual void BC::BC< T >::FillBoundary ( amrex::FabArray< amrex::BaseFab< T > > &  mf,
int  dcomp,
int  ncomp,
amrex::IntVect const &  ,
amrex::Real  time,
int  bccomp 
)
inline

Definition at line 71 of file BC.H.

◆ FillBoundary() [4/5]

virtual void BC::BC< T >::FillBoundary ( amrex::FabArray< amrex::BaseFab< T > > &  mf,
int  dcomp,
int  ncomp,
amrex::Real  time,
int   
)
inline

Definition at line 58 of file BC.H.

◆ FillBoundary() [5/5]

template<class Q = T>
std::enable_if< std::is_same< Q, amrex::Real >::value >::type BC::BC< T >::FillBoundary ( amrex::MultiFab &  mf,
int  dcomp,
int  ncomp,
amrex::Real  time,
int   
)
inline

Definition at line 89 of file BC.H.

◆ GetBCRec()

amrex::BCRec BC::Constant::GetBCRec ( )
overridevirtual

Implements BC::BC< Set::Scalar >.

Definition at line 188 of file Constant.cpp.

◆ GetBCTypes()

template<class T >
const amrex::Array< amrex::Array< T, AMREX_SPACEDIM >, 2 > BC::Constant::GetBCTypes ( )
inline

Definition at line 131 of file Constant.H.

◆ IsPeriodic()

amrex::Array< int, AMREX_SPACEDIM > BC::Constant::IsPeriodic ( )
overridevirtual

Reimplemented from BC::BC< Set::Scalar >.

Definition at line 197 of file Constant.cpp.

◆ Parse()

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

Definition at line 157 of file Constant.H.

◆ Periodicity() [1/2]

amrex::Periodicity BC::Constant::Periodicity ( ) const
overridevirtual

Reimplemented from BC::BC< Set::Scalar >.

Definition at line 203 of file Constant.cpp.

◆ Periodicity() [2/2]

amrex::Periodicity BC::Constant::Periodicity ( const amrex::Box &  b)
overridevirtual

Reimplemented from BC::BC< Set::Scalar >.

Definition at line 209 of file Constant.cpp.

◆ ZeroDirichlet()

static Constant BC::Constant::ZeroDirichlet ( int  ncomp = 1,
Unit  unit = Unit::Less() 
)
inlinestatic

Definition at line 99 of file Constant.H.

◆ ZeroNeumann()

static Constant BC::Constant::ZeroNeumann ( int  ncomp = 1,
Unit  unit = Unit::Less() 
)
inlinestatic

Definition at line 82 of file Constant.H.

Field Documentation

◆ m_bc_type

std::array<std::vector<int>, m_nfaces> BC::Constant::m_bc_type
private

Definition at line 153 of file Constant.H.

◆ m_bc_val

std::array<std::vector<Numeric::Interpolator::Linear<Set::Scalar> >, m_nfaces> BC::Constant::m_bc_val
private

Definition at line 154 of file Constant.H.

◆ m_ncomp

unsigned int BC::Constant::m_ncomp = 0
private

Definition at line 145 of file Constant.H.

◆ name

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

Definition at line 60 of file Constant.H.

◆ unit

Unit BC::Constant::unit = Unit::Less()
private

Definition at line 146 of file Constant.H.

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.8