chombo-discharge
Public Member Functions | Protected Attributes | List of all members
CellInfo Class Reference

Class for the cell-information that is often queried when merging particles inside a cell. More...

#include <CD_CellInfo.H>

Public Member Functions

 CellInfo ()=delete
 Default constructor - creates a regular cell.
 
 CellInfo (const IntVect a_gridIndex, const Real a_dx) noexcept
 Constructor which creates a regular cell. More...
 
 CellInfo (const IntVect a_gridIndex, const Real a_dx, const Real a_volFrac, const RealVect a_bndryCentroid, const RealVect a_bndryNormal) noexcept
 Constructor which automatically constructs an approximation to the minimum box enclosing the valid region of the cell. More...
 
virtual ~CellInfo () noexcept
 Destructor.
 
IntVect & getGridIndex () noexcept
 Get the grid index.
 
const IntVect & getGridIndex () const noexcept
 Get the grid index.
 
Real & getDx () noexcept
 Get the grid spacing.
 
const Real & getDx () const noexcept
 Get the grid spacing.
 
Real & getVolFrac () noexcept
 Get the volume fraction.
 
const Real & getVolFrac () const noexcept
 Get the volume fraction.
 
RealVect & getBndryCentroid () noexcept
 Get the boundary centroid.
 
const RealVect & getBndryCentroid () const noexcept
 Get the boundary centroid.
 
RealVect & getBndryNormal () noexcept
 Get the boundary normal.
 
const RealVect & getBndryNormal () const noexcept
 Get the boundary normal.
 
RealVect & getValidLo () noexcept
 Get the lower valid region.
 
const RealVect & getValidLo () const noexcept
 Get the lower valid region.
 
RealVect & getValidHi () noexcept
 Get the upper valid region.
 
const RealVect & getValidHi () const noexcept
 Get the upper valid region.
 

Protected Attributes

IntVect m_gridIndex
 Grid index.
 
Real m_dx
 Grid spacing.
 
Real m_volFrac
 Volume fraction.
 
RealVect m_bndryCentroid
 Boundary centroid.
 
RealVect m_bndryNormal
 EB boundary normal.
 
RealVect m_validLo
 Valid region in each direction (lower limit)
 
RealVect m_validHi
 Valid region in each direction (upper limit)
 

Detailed Description

Class for the cell-information that is often queried when merging particles inside a cell.

Constructor & Destructor Documentation

◆ CellInfo() [1/2]

CellInfo::CellInfo ( const IntVect  a_gridIndex,
const Real  a_dx 
)
noexcept

Constructor which creates a regular cell.

Parameters
[in]a_gridIndexGrid index
[in]a_dxGrid resolution

◆ CellInfo() [2/2]

CellInfo::CellInfo ( const IntVect  a_gridIndex,
const Real  a_dx,
const Real  a_volFrac,
const RealVect  a_bndryCentroid,
const RealVect  a_bndryNormal 
)
noexcept

Constructor which automatically constructs an approximation to the minimum box enclosing the valid region of the cell.

Parameters
[in]a_gridIndexGrid index
[in]a_dxGrid resolution
[in]a_volFracVolume fraction.
[in]a_bndryCentroidBoundary centroid
[in]a_bndryNormalBoundary normal

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