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

Maintain an identifier for boundary condition types. More...

#include <AMReX_BoundCond.H>

Public Member Functions

 BoundCond () noexcept=default
 Initializes boundary condition type to default. More...
 
 BoundCond (int _bctype) noexcept
 Initializes boundary condition type to specified value. More...
 
AMREX_GPU_HOST_DEVICE operator int () const noexcept
 Return index of boundary condition type. More...
 
BoundCondoperator= (const int _bctype) noexcept
 Set index of boundary condition type. More...
 

Private Attributes

int bctype = -1
 Index of boundary condition type. More...
 

Detailed Description

Maintain an identifier for boundary condition types.

This is a placeholder for more extensive boundary condition implementations, which might include stencils, etc. Presently, boundary conditions are specified via an integer identifier. This class maintains that integer.

Constructor & Destructor Documentation

◆ BoundCond() [1/2]

amrex::BoundCond::BoundCond ( )
defaultnoexcept

Initializes boundary condition type to default.

◆ BoundCond() [2/2]

amrex::BoundCond::BoundCond ( int  _bctype)
inlinenoexcept

Initializes boundary condition type to specified value.

Member Function Documentation

◆ operator int()

AMREX_GPU_HOST_DEVICE amrex::BoundCond::operator int ( ) const
inlinenoexcept

Return index of boundary condition type.

◆ operator=()

BoundCond& amrex::BoundCond::operator= ( const int  _bctype)
inlinenoexcept

Set index of boundary condition type.

Member Data Documentation

◆ bctype

int amrex::BoundCond::bctype = -1
private

Index of boundary condition type.


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