CD_CellInfo.H

Go to the documentation of this file.

/* chombo-discharge
 * Copyright © 2024 SINTEF Energy Research.
 * Please refer to Copyright.txt and LICENSE in the chombo-discharge root directory.
 */
 
#ifndef CD_CellInfo_H
#define CD_CellInfo_H
 
// Chombo includes
#include <RealVect.H>
 
// Our includes
#include <CD_NamespaceHeader.H>
 
class CellInfo
{
public:
  CellInfo() = delete;
 
  CellInfo(const IntVect a_gridIndex, const Real a_dx) noexcept;
 
  CellInfo(const IntVect  a_gridIndex,
           const Real     a_dx,
           const Real     a_volFrac,
           const RealVect a_bndryCentroid,
           const RealVect a_bndryNormal) noexcept;
 
  virtual ~CellInfo() noexcept;
 
  IntVect&
  getGridIndex() noexcept;
 
  const IntVect&
  getGridIndex() const noexcept;
 
  Real&
  getDx() noexcept;
 
  const Real&
  getDx() const noexcept;
 
  Real&
  getVolFrac() noexcept;
 
  const Real&
  getVolFrac() const noexcept;
 
  RealVect&
  getBndryCentroid() noexcept;
 
  const RealVect&
  getBndryCentroid() const noexcept;
 
  RealVect&
  getBndryNormal() noexcept;
 
  const RealVect&
  getBndryNormal() const noexcept;
 
  RealVect&
  getValidLo() noexcept;
 
  const RealVect&
  getValidLo() const noexcept;
 
  RealVect&
  getValidHi() noexcept;
 
  const RealVect&
  getValidHi() const noexcept;
 
protected:
  IntVect m_gridIndex;
 
  Real m_dx;
 
  Real m_volFrac;
 
  RealVect m_bndryCentroid;
 
  RealVect m_bndryNormal;
 
  RealVect m_validLo;
 
  RealVect m_validHi;
};
 
#include <CD_NamespaceFooter.H>
 
#endif