Block-Structured AMR Software Framework
amrex::BCRec Class Reference

Boundary Condition Records. Necessary information and functions for computing boundary conditions. More...

#include <AMReX_BCRec.H>

Public Member Functions

AMREX_GPU_HOST_DEVICE BCRec () noexcept=default
 The default constructor, which does NOT set valid boundary types. More...
 
AMREX_GPU_HOST_DEVICE BCRec (AMREX_D_DECL(int loX, int loY, int loZ), AMREX_D_DECL(int hiX, int hiY, int hiZ)) noexcept
 The constructor. More...
 
AMREX_GPU_HOST_DEVICE BCRec (const int *a_lo, const int *a_hi) noexcept
 Another constructor. More...
 
AMREX_GPU_HOST_DEVICE BCRec (const Box &bx, const Box &domain, const BCRec &bc_domain) noexcept
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void setLo (int dir, int bc_val) noexcept
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void setHi (int dir, int bc_val) noexcept
 Explicitly set hi bndry value. More...
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void set (Orientation face, int bc_val) noexcept
 Explicitly set bndry value for given face. More...
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const intvect () const &noexcept
 Return bndry values (used in calls to FORTRAN). More...
 
const intvect () &&=delete
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const intdata () const &noexcept
 
const intdata () &&=delete
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const intlo () const &noexcept
 Return low-end boundary data. More...
 
const intlo () &&=delete
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const inthi () const &noexcept
 Return high-end boundary data. More...
 
const inthi () &&=delete
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE int lo (int dir) const noexcept
 Return low-end boundary data in direction <dir>. More...
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE int hi (int dir) const noexcept
 Return high-end boundary data in direction <dir>. More...
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE bool operator== (const BCRec &rhs) const noexcept
 Equal test. More...
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE bool operator!= (const BCRec &rhs) const noexcept
 Not equal test. More...
 

Private Attributes

int bc [2 *AMREX_SPACEDIM]
 Array of integer values describing boundary conditions. More...
 

Friends

std::ostream & operator<< (std::ostream &, const BCRec &)
 ASCII write to ostream. More...
 

Detailed Description

Boundary Condition Records. Necessary information and functions for computing boundary conditions.

This class has standard layout. And we should keep it so!

Constructor & Destructor Documentation

◆ BCRec() [1/4]

AMREX_GPU_HOST_DEVICE amrex::BCRec::BCRec ( )
defaultnoexcept

The default constructor, which does NOT set valid boundary types.

◆ BCRec() [2/4]

AMREX_GPU_HOST_DEVICE amrex::BCRec::BCRec ( AMREX_D_DECL(int loX, int loY, int loZ)  ,
AMREX_D_DECL(int hiX, int hiY, int hiZ)   
)
inlinenoexcept

The constructor.

◆ BCRec() [3/4]

AMREX_GPU_HOST_DEVICE amrex::BCRec::BCRec ( const int a_lo,
const int a_hi 
)
inlinenoexcept

Another constructor.

◆ BCRec() [4/4]

AMREX_GPU_HOST_DEVICE amrex::BCRec::BCRec ( const Box bx,
const Box domain,
const BCRec bc_domain 
)
inlinenoexcept

Member Function Documentation

◆ data() [1/2]

const int* amrex::BCRec::data ( ) &&
delete

◆ data() [2/2]

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const int* amrex::BCRec::data ( ) const &
inlinenoexcept

◆ hi() [1/3]

const int* amrex::BCRec::hi ( ) &&
delete

◆ hi() [2/3]

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const int* amrex::BCRec::hi ( ) const &
inlinenoexcept

Return high-end boundary data.

◆ hi() [3/3]

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE int amrex::BCRec::hi ( int  dir) const
inlinenoexcept

Return high-end boundary data in direction <dir>.

◆ lo() [1/3]

const int* amrex::BCRec::lo ( ) &&
delete

◆ lo() [2/3]

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const int* amrex::BCRec::lo ( ) const &
inlinenoexcept

Return low-end boundary data.

◆ lo() [3/3]

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE int amrex::BCRec::lo ( int  dir) const
inlinenoexcept

Return low-end boundary data in direction <dir>.

◆ operator!=()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE bool amrex::BCRec::operator!= ( const BCRec rhs) const
inlinenoexcept

Not equal test.

◆ operator==()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE bool amrex::BCRec::operator== ( const BCRec rhs) const
inlinenoexcept

Equal test.

◆ set()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void amrex::BCRec::set ( Orientation  face,
int  bc_val 
)
inlinenoexcept

Explicitly set bndry value for given face.

◆ setHi()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void amrex::BCRec::setHi ( int  dir,
int  bc_val 
)
inlinenoexcept

Explicitly set hi bndry value.

◆ setLo()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void amrex::BCRec::setLo ( int  dir,
int  bc_val 
)
inlinenoexcept

◆ vect() [1/2]

const int* amrex::BCRec::vect ( ) &&
delete

◆ vect() [2/2]

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const int* amrex::BCRec::vect ( ) const &
inlinenoexcept

Return bndry values (used in calls to FORTRAN).

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
const BCRec b 
)
friend

ASCII write to ostream.

Member Data Documentation

◆ bc

int amrex::BCRec::bc[2 *AMREX_SPACEDIM]
private
Initial value:
{AMREX_D_DECL(BCType::bogus,BCType::bogus,BCType::bogus),
AMREX_D_DECL(BCType::bogus,BCType::bogus,BCType::bogus)}
#define AMREX_D_DECL(a, b, c)
Definition: AMReX_SPACE.H:104

Array of integer values describing boundary conditions.


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