Chombo + EB + MF  3.2
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ParticleValidRegion Class Reference

#include <ParticleValidRegion.H>

Public Member Functions

 ParticleValidRegion ()
 Default constructor. User must subsequently call define(). More...
 
 ~ParticleValidRegion ()
 Destructor. More...
 
 ParticleValidRegion (const DisjointBoxLayout &a_domain, const LevelData< BaseFab< bool > > *a_crseValid, const int a_refRatio, const int a_buffer)
 Full constructor. More...
 
void define (const DisjointBoxLayout &a_domain, const LevelData< BaseFab< bool > > *a_crseValid, const int a_refRatio, const int a_buffer)
 Like the full constructor. More...
 
const LevelData< BaseFab< bool > > * mask () const
 Return pointer to valid region. More...
 

Protected Member Functions

void bufferGhostJob (BaseFab< bool > &a_valid, const Box &a_box, const Box &a_domain, const int a_buffer, const int a_dir)
 internal use only More...
 

Protected Attributes

bool m_isDefined
 
LevelData< BaseFab< bool > > m_valid
 levelData mask of valid region More...
 

Detailed Description

This class defines the region in which the particle data is valid. The invalid region is a layer of a_buffer cells abutting the next coarser level. The buffer is computed in such a way that during two successive synchronization points the particles deposition/interpolation stencil remains fully contained on this level

Constructor & Destructor Documentation

◆ ParticleValidRegion() [1/2]

ParticleValidRegion::ParticleValidRegion ( )
inline

Default constructor. User must subsequently call define().

Referenced by ~ParticleValidRegion().

◆ ~ParticleValidRegion()

ParticleValidRegion::~ParticleValidRegion ( )
inline

Destructor.

References define(), and ParticleValidRegion().

◆ ParticleValidRegion() [2/2]

ParticleValidRegion::ParticleValidRegion ( const DisjointBoxLayout a_domain,
const LevelData< BaseFab< bool > > *  a_crseValid,
const int  a_refRatio,
const int  a_buffer 
)

Full constructor.

Member Function Documentation

◆ define()

void ParticleValidRegion::define ( const DisjointBoxLayout a_domain,
const LevelData< BaseFab< bool > > *  a_crseValid,
const int  a_refRatio,
const int  a_buffer 
)

Like the full constructor.

Referenced by ~ParticleValidRegion().

◆ mask()

const LevelData<BaseFab<bool> >* ParticleValidRegion::mask ( ) const
inline

Return pointer to valid region.

References bufferGhostJob(), CH_TIME, m_isDefined, and m_valid.

◆ bufferGhostJob()

void ParticleValidRegion::bufferGhostJob ( BaseFab< bool > &  a_valid,
const Box a_box,
const Box a_domain,
const int  a_buffer,
const int  a_dir 
)
inlineprotected

internal use only

Referenced by mask().

Member Data Documentation

◆ m_isDefined

bool ParticleValidRegion::m_isDefined
protected

Referenced by mask().

◆ m_valid

LevelData<BaseFab<bool> > ParticleValidRegion::m_valid
protected

levelData mask of valid region

Referenced by mask().


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