chombo-discharge
Loading...
Searching...
No Matches
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.
 
 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.
 
virtual ~CellInfo () noexcept
 Destructor.
 
IntVectgetGridIndex () noexcept
 Get the grid index.
 
const IntVectgetGridIndex () const noexcept
 Get the grid index.
 
RealgetDx () noexcept
 Get the grid spacing.
 
const RealgetDx () const noexcept
 Get the grid spacing.
 
RealgetVolFrac () noexcept
 Get the volume fraction.
 
const RealgetVolFrac () const noexcept
 Get the volume fraction.
 
RealVectgetBndryCentroid () noexcept
 Get the boundary centroid.
 
const RealVectgetBndryCentroid () const noexcept
 Get the boundary centroid.
 
RealVectgetBndryNormal () noexcept
 Get the boundary normal.
 
const RealVectgetBndryNormal () const noexcept
 Get the boundary normal.
 
RealVectgetValidLo () noexcept
 Get the lower valid region.
 
const RealVectgetValidLo () const noexcept
 Get the lower valid region.
 
RealVectgetValidHi () noexcept
 Get the upper valid region.
 
const RealVectgetValidHi () 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: