Chombo + EB  3.0
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
EBLevelGrid Class Reference

#include <EBLevelGrid.H>

Public Member Functions

 EBLevelGrid ()
 
 ~EBLevelGrid ()
 
 EBLevelGrid (const DisjointBoxLayout &a_dbl, const ProblemDomain &a_domain, const int &a_numGhostEBISL, const EBIndexSpace *a_ebisPtr)
 
 EBLevelGrid (const DisjointBoxLayout &a_dbl, const EBISLayout &a_ebisl, const ProblemDomain &a_domain)
 
void define (const DisjointBoxLayout &a_dbl, const ProblemDomain &a_domain, const int &a_numGhostEBISL, const EBIndexSpace *a_ebisPtr)
 
void define (const DisjointBoxLayout &a_dbl, const EBISLayout &a_ebisl, const ProblemDomain &a_domain)
 
 EBLevelGrid (const EBLevelGrid &ebcin)
 
int getGhost () const
 
DisjointBoxLayout getDBL () const
 
EBISLayout getEBISL () const
 
RefCountedPtr< LayoutData< IntVectSet > > getCFIVS () const
 
bool isDefined () const
 
const EBIndexSpace * getEBIS () const
 
const IntVectSet & getCoveringIVS () const
 
const ProblemDomain & getDomain () const
 
void setMaxRefinementRatio (const int &a_maxRefine)
 
void setMaxCoarseningRatio (const int &a_maxCoarsen, const EBIndexSpace *const a_ebisPtr)
 
int getMaxCoarseningRatio () const
 
int getMaxRefinementRatio () const
 
bool coarsenable (const int &a_ref) const
 

Protected Member Functions

void defineCoveringIVS ()
 
void setDefaultValues ()
 

Protected Attributes

bool m_isDefined
 
bool m_isCoveringIVSDefined
 
DisjointBoxLayout m_grids
 
EBISLayout m_ebisl
 
ProblemDomain m_domain
 
RefCountedPtr< LayoutData< IntVectSet > > m_cfivs
 
IntVectSet m_coveringIVS
 
const EBIndexSpace * m_ebisPtr
 
int m_nghost
 

Friends

void coarsen (EBLevelGrid &a_eblgCoar, const EBLevelGrid &a_eblgFine, const int &a_ref)
 
void refine (EBLevelGrid &a_eblgCoar, const EBLevelGrid &a_eblgFine, const int &a_ref)
 

Detailed Description

A structure to hold the various components of an EB calculation grid.

Constructor & Destructor Documentation

◆ EBLevelGrid() [1/4]

EBLevelGrid::EBLevelGrid ( )

Default constructor. User must subsequently call define().

◆ ~EBLevelGrid()

EBLevelGrid::~EBLevelGrid ( )

◆ EBLevelGrid() [2/4]

EBLevelGrid::EBLevelGrid ( const DisjointBoxLayout &  a_dbl,
const ProblemDomain &  a_domain,
const int &  a_numGhostEBISL,
const EBIndexSpace *  a_ebisPtr 
)

Defining constructor. Constructs a valid object. Equivalent to default construction followed by define().

◆ EBLevelGrid() [3/4]

EBLevelGrid::EBLevelGrid ( const DisjointBoxLayout &  a_dbl,
const EBISLayout &  a_ebisl,
const ProblemDomain &  a_domain 
)

◆ EBLevelGrid() [4/4]

EBLevelGrid::EBLevelGrid ( const EBLevelGrid &  ebcin)

Member Function Documentation

◆ define() [1/2]

void EBLevelGrid::define ( const DisjointBoxLayout &  a_dbl,
const ProblemDomain &  a_domain,
const int &  a_numGhostEBISL,
const EBIndexSpace *  a_ebisPtr 
)

Define function that generates EBISL and CFIVS

◆ define() [2/2]

void EBLevelGrid::define ( const DisjointBoxLayout &  a_dbl,
const EBISLayout &  a_ebisl,
const ProblemDomain &  a_domain 
)

only generates cfivs. set EBISPtr = chombo_ebis::instance

◆ getGhost()

int EBLevelGrid::getGhost ( ) const
inline

References CH_assert, m_isDefined, and m_nghost.

◆ getDBL()

DisjointBoxLayout EBLevelGrid::getDBL ( ) const
inline

References CH_assert, m_grids, and m_isDefined.

Referenced by EBViscousTensorOp::diagonalScale(), EBViscousTensorOp::divideByIdentityCoef(), and EBFastFR::reflux().

◆ getEBISL()

EBISLayout EBLevelGrid::getEBISL ( ) const
inline

References CH_assert, m_ebisl, and m_isDefined.

Referenced by EBAMRPoissonOp::getFlux(), and EBFastFR::reflux().

◆ getCFIVS()

RefCountedPtr<LayoutData<IntVectSet> > EBLevelGrid::getCFIVS ( ) const
inline

References CH_assert, m_cfivs, and m_isDefined.

◆ isDefined()

bool EBLevelGrid::isDefined ( ) const
inline

References m_isDefined.

◆ getEBIS()

const EBIndexSpace* EBLevelGrid::getEBIS ( ) const
inline

References CH_assert, m_ebisPtr, and m_isDefined.

◆ getCoveringIVS()

const IntVectSet& EBLevelGrid::getCoveringIVS ( ) const
inline

References CH_assert, defineCoveringIVS(), m_coveringIVS, m_isCoveringIVSDefined, and m_isDefined.

◆ getDomain()

const ProblemDomain& EBLevelGrid::getDomain ( ) const
inline

References CH_assert, m_domain, and m_isDefined.

Referenced by EBAMRPoissonOp::getFlux().

◆ setMaxRefinementRatio()

void EBLevelGrid::setMaxRefinementRatio ( const int &  a_maxRefine)
inline

Sets the maximum level of refinement that the EBISLayout will have to perform. Creates and holds new EBISLayouts at intermediate levels of refinement. Default is one (no refinement done).

References CH_assert, m_ebisl, m_ebisPtr, m_isDefined, and EBISLayout::setMaxRefinementRatio().

◆ setMaxCoarseningRatio()

void EBLevelGrid::setMaxCoarseningRatio ( const int &  a_maxCoarsen,
const EBIndexSpace *const  a_ebisPtr 
)
inline

Sets the maximum level of coarsening that the will have to perform. Creates and holds new EBISLayouts at intermediate levels of refinement. Default is one (no coarsening done).

References CH_assert, m_ebisl, m_isDefined, and EBISLayout::setMaxCoarseningRatio().

◆ getMaxCoarseningRatio()

int EBLevelGrid::getMaxCoarseningRatio ( ) const
inline

References CH_assert, EBISLayout::getMaxCoarseningRatio(), m_ebisl, and m_isDefined.

◆ getMaxRefinementRatio()

int EBLevelGrid::getMaxRefinementRatio ( ) const
inline

References CH_assert, coarsen, coarsenable(), defineCoveringIVS(), EBISLayout::getMaxRefinementRatio(), m_ebisl, m_isDefined, refine, and setDefaultValues().

◆ coarsenable()

bool EBLevelGrid::coarsenable ( const int &  a_ref) const

Referenced by getMaxRefinementRatio().

◆ defineCoveringIVS()

void EBLevelGrid::defineCoveringIVS ( )
protected

Referenced by getCoveringIVS(), and getMaxRefinementRatio().

◆ setDefaultValues()

void EBLevelGrid::setDefaultValues ( )
protected

Referenced by getMaxRefinementRatio().

Friends And Related Function Documentation

◆ coarsen

void coarsen ( EBLevelGrid &  a_eblgCoar,
const EBLevelGrid &  a_eblgFine,
const int &  a_ref 
)
friend

Coarsen eblgFine by a_ref

Referenced by getMaxRefinementRatio().

◆ refine

void refine ( EBLevelGrid &  a_eblgCoar,
const EBLevelGrid &  a_eblgFine,
const int &  a_ref 
)
friend

Referenced by getMaxRefinementRatio().

Member Data Documentation

◆ m_isDefined

bool EBLevelGrid::m_isDefined
protected

Referenced by getCFIVS(), getCoveringIVS(), getDBL(), getDomain(), getEBIS(), getEBISL(), getGhost(), getMaxCoarseningRatio(), getMaxRefinementRatio(), isDefined(), setMaxCoarseningRatio(), and setMaxRefinementRatio().

◆ m_isCoveringIVSDefined

bool EBLevelGrid::m_isCoveringIVSDefined
protected

Referenced by getCoveringIVS().

◆ m_grids

DisjointBoxLayout EBLevelGrid::m_grids
protected

Referenced by getDBL().

◆ m_ebisl

EBISLayout EBLevelGrid::m_ebisl
protected

Referenced by getEBISL(), getMaxCoarseningRatio(), getMaxRefinementRatio(), setMaxCoarseningRatio(), and setMaxRefinementRatio().

◆ m_domain

ProblemDomain EBLevelGrid::m_domain
protected

Referenced by getDomain().

◆ m_cfivs

RefCountedPtr<LayoutData<IntVectSet> > EBLevelGrid::m_cfivs
protected

Referenced by getCFIVS().

◆ m_coveringIVS

IntVectSet EBLevelGrid::m_coveringIVS
protected

Referenced by getCoveringIVS().

◆ m_ebisPtr

const EBIndexSpace* EBLevelGrid::m_ebisPtr
protected

Referenced by getEBIS(), and setMaxRefinementRatio().

◆ m_nghost

int EBLevelGrid::m_nghost
protected

Referenced by getGhost().

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.13