Class for handling spatial operations. More...

#include <CD_AmrMesh.H>

Public Member Functions
	AmrMesh ()
	Default constructor.

	AmrMesh (const AmrMesh &a_other)=delete
	Disallowed copy constructor.

	AmrMesh (const AmrMesh &&a_other)=delete
	Disallowed move constructor.

virtual	~AmrMesh ()
	Destructor.

AmrMesh &	operator= (const AmrMesh &a_other)=delete
	Disallowed copy assignment.

AmrMesh &	operator= (const AmrMesh &&a_other)=delete
	Disallowed move assignment.

template<typename T >
void	copyData (EBAMRData< T > &a_dst, const EBAMRData< T > &a_src, const CopyStrategy &a_toRegion=CopyStrategy::Valid, const CopyStrategy &a_fromRegion=CopyStrategy::Valid) const noexcept
	Method for copying from a source container to a destination container. User supplies information about from/to regions.

template<typename T >
void	copyData (EBAMRData< T > &a_dst, const EBAMRData< T > &a_src, const Interval &a_dstComps, const Interval &a_srcComps, const CopyStrategy &a_toRegion=CopyStrategy::Valid, const CopyStrategy &a_fromRegion=CopyStrategy::Valid) const noexcept
	Method for copying from a source container to a destination container. User supplies information.

template<typename T >
void	copyData (LevelData< T > &a_dst, const LevelData< T > &a_src, const int a_level, const std::string a_toRealm, const std::string a_fromRealm, const CopyStrategy &a_toRegion=CopyStrategy::Valid, const CopyStrategy &a_fromRegion=CopyStrategy::Valid) const noexcept
	Method for copying from a source container to a destination container. User supplies information about from/to regions.

template<typename T >
void	copyData (LevelData< T > &a_dst, const LevelData< T > &a_src, const int a_level, const std::string a_toRealm, const std::string a_fromRealm, const Interval &a_dstComps, const Interval &a_srcComps, const CopyStrategy &a_toRegion=CopyStrategy::Valid, const CopyStrategy &a_fromRegion=CopyStrategy::Valid) const noexcept
	Method for copying from a source container to a destination container. User supplies information about from/to regions.

template<typename T >
void	deallocate (Vector< T * > &a_data) const
	Deallocate data.

template<typename T >
void	deallocate (Vector< RefCountedPtr< T > > &a_data) const
	Deallocate smart pointer data.

template<typename T >
void	deallocate (EBAMRData< T > &a_data) const
	Deallocate data.

template<typename T >
void	alias (Vector< T * > &a_alias, const Vector< RefCountedPtr< T > > &a_data) const
	Turn smart-pointer data structure into regular-pointer data structure.

template<typename T , typename S >
void	alias (Vector< T * > &a_alias, const EBAMRData< S > &a_data) const
	Turn smart-pointer data structure into regular-pointer data structure.

template<typename T >
void	allocate (Vector< RefCountedPtr< ParticleData< T > > > &a_particles, const std::string a_realm) const
	Template class for generic allocation of particle data.

template<typename T >
void	allocate (ParticleContainer< T > &a_container, const std::string a_realm) const
	Template class for generic allocation of particle containers.

template<typename T >
void	allocatePointer (Vector< RefCountedPtr< T > > &a_data) const
	Allocate pointer but not any memory blocks.

template<typename T >
void	allocatePointer (Vector< RefCountedPtr< T > > &a_data, const int a_finestLevel) const
	Allocate pointer but not any memory blocks.

template<typename T >
void	allocatePointer (EBAMRData< T > &a_data, const std::string a_realm) const
	Allocate pointer but not any memory blocks.

template<typename T >
void	allocatePointer (EBAMRData< T > &a_data, const std::string a_realm, const int a_finestLevel) const
	Allocate pointer but not any memory.

EBAMRCellData	slice (EBAMRCellData &a_original, const Interval a_variables) const noexcept
	Slice cell-centered data in order to fetch a subset of components.

const EBAMRCellData	slice (const EBAMRCellData &a_original, const Interval a_variables) const noexcept
	Slice cell-centered data in order to fetch a subset of components.

void	parseOptions ()
	Parse options. Called during the constructor.

void	parseRuntimeOptions ()
	Parse runtime options.

void	registerOperator (const std::string a_operator, const std::string a_realm, const phase::which_phase a_phase)
	Register an operator over a realm and a phase.

void	registerMask (const std::string a_mask, const int a_buffer, const std::string a_realm)
	Register a boolean mask over a realm.

void	buildDomains ()
	Build domains.

void	setFinestLevel (const int a_finestLevel)
	Set the finest level.

void	setCoarsestGrid (const IntVect &a_nCells)
	Set the coarsest grid cells.

bool	queryRealm (const std::string a_realm) const
	Query if a realm exists.

bool	getEbCf () const
	Check if mesh has an EBCF.

void	registerRealm (const std::string a_realm)
	Register a new realm.

void	alias (EBAMRCellData &a_data, const phase::which_phase a_phase, const MFAMRCellData &a_mfdata, const int a_finestLevel) const
	Alias multifluid data up to a specified level.

void	alias (EBAMRFluxData &a_data, const phase::which_phase a_phase, const MFAMRFluxData &a_mfdata, const int a_finestLevel) const
	Alias multifluid data up to a specified level.

void	alias (EBAMRCellData &a_data, const phase::which_phase a_phase, const MFAMRCellData &a_mfdata) const
	Alias an entire hiearchy of multifluid data.

void	alias (EBAMRFluxData &a_data, const phase::which_phase a_phase, const MFAMRFluxData &a_mfdata) const
	Alias an entire hiearchy of multifluid data.

void	alias (EBAMRIVData &a_data, const phase::which_phase a_phase, const MFAMRIVData &a_mfdata) const
	Alias an entire hiearchy of multifluid data.

EBAMRCellData	alias (const phase::which_phase a_phase, const MFAMRCellData &a_mfdata) const
	Alias an entire hiearchy of multifluid data.

EBAMRFluxData	alias (const phase::which_phase a_phase, const MFAMRFluxData &a_mfdata) const
	Alias an entire hiearchy of multifluid data.

EBAMRIVData	alias (const phase::which_phase a_phase, const MFAMRIVData &a_mfdata) const
	Alias an entire hiearchy of multifluid data.

void	computeGradient (EBAMRCellData &a_gradient, const EBAMRCellData &a_phi, const std::string a_realm, const phase::which_phase a_phase) const
	Compute cell-centered gradient over an AMR hierarchy.

void	computeGradient (EBAMRFluxData &a_gradient, const EBAMRCellData &a_phi, const std::string a_realm, const phase::which_phase a_phase) const
	Compute face-centered gradient over an AMR hierarchy.

void	computeGradient (MFAMRCellData &a_gradient, const MFAMRCellData &a_phi, const std::string a_realm) const
	Compute cell-centered gradient over an AMR hierarchy.

void	computeGradient (MFAMRFluxData &a_gradient, const MFAMRCellData &a_phi, const std::string a_realm) const
	Compute face-centered gradient over an AMR hierarchy.

void	allocate (EBAMRCellData &a_data, const std::string a_realm, const phase::which_phase a_phase, const int a_nComp, const int a_nGhost=-1) const
	Allocate a data holder over a specific realm.

void	allocate (LevelData< EBCellFAB > &a_data, const std::string a_realm, const phase::which_phase a_phase, const int a_level, const int a_nComp, const int a_nGhost=-1) const
	Allocate data on specific level.

void	allocate (EBAMRFluxData &a_data, const std::string a_realm, const phase::which_phase a_phase, const int a_nComp, const int a_nGhost=-1) const
	Allocate a data holder over a specific realm.

void	allocate (EBAMRIVData &a_data, const std::string a_realm, const phase::which_phase a_phase, const int a_nComp, const int a_nGhost=-1) const
	Allocate a data holder over a specific realm.

void	allocate (EBAMRIFData &a_data, const std::string a_realm, const phase::which_phase a_phase, const int a_nComp, const int a_nGhost=-1) const
	Allocate a data holder over a specific realm.

void	allocate (EBAMRBool &a_data, const std::string a_realm, const int a_nComp, const int a_nGhost=-1) const
	Allocate Boolean data over a specific realm.

void	allocate (MFAMRCellData &a_data, const std::string a_realm, const int a_nComp, const int a_nGhost=-1) const
	Allocate a data holder over a specific realm.

void	allocate (MFAMRFluxData &a_data, const std::string a_realm, const int a_nComp, const int a_ghost=-1) const
	Allocate a data holder over a specific realm.

void	allocate (MFAMRIVData &a_data, const std::string a_realm, const int a_nComp, const int a_ghost=0) const
	Allocate a data holder over a specific realm.

void	reallocate (EBAMRCellData &a_data, const phase::which_phase a_phase, const int a_lmin) const
	Reallocate data.

void	reallocate (EBAMRFluxData &a_data, const phase::which_phase a_phase, const int a_lmin) const
	Reallocate data.

void	reallocate (EBAMRIVData &a_data, const phase::which_phase a_phase, const int a_lmin) const
	Reallocate data.

void	reallocate (EBAMRIFData &a_data, const phase::which_phase a_phase, const int a_lmin) const
	Reallocate data.

void	reallocate (EBAMRBool &a_data, const int a_lmin) const
	Reallocate data.

void	reallocate (MFAMRCellData &a_data, const int a_lmin) const
	Reallocate data.

void	reallocate (MFAMRFluxData &a_data, const int a_lmin) const
	Reallocate data.

void	reallocate (MFAMRIVData &a_data, const int a_lmin) const
	Reallocate data.

void	average (MFAMRCellData &a_data, const std::string a_realm, const Average &a_average) const
	Average multifluid data over a specified realm.

void	arithmeticAverage (MFAMRCellData &a_data, const std::string a_realm) const
	Arithmetic coarsening of multifluid data.

void	harmonicAverage (MFAMRCellData &a_data, const std::string a_realm) const
	Harmonic coarsening of multifluid data.

void	conservativeAverage (MFAMRCellData &a_data, const std::string a_realm) const
	Conservative coarsening of multifluid data.

void	average (MFAMRFluxData &a_data, const std::string a_realm, const Average &a_average) const
	Average multifluid data over a specified realm.

void	arithmeticAverage (MFAMRFluxData &a_data, const std::string a_realm) const
	Average multifluid data over a realm.

void	harmonicAverage (MFAMRFluxData &a_data, const std::string a_realm) const
	Average multifluid data over a realm.

void	conservativeAverage (MFAMRFluxData &a_data, const std::string a_realm) const
	Average down multifluid data over a realm.

void	average (EBAMRCellData &a_data, const std::string a_realm, const phase::which_phase a_phase, const Average &a_average) const
	Average down on specific realm and phase.

void	average (EBAMRCellData &a_data, const std::string a_realm, const phase::which_phase a_phase, const Average &a_average, const Interval &a_variables) const
	Average down on specific realm and phase.

void	arithmeticAverage (EBAMRCellData &a_data, const std::string a_realm, const phase::which_phase a_phase) const
	Arithmetic average of data. Does all components.

void	arithmeticAverage (EBAMRCellData &a_data, const std::string a_realm, const phase::which_phase a_phase, const Interval &a_variables) const
	Arithmetic average of data.

void	harmonicAverage (EBAMRCellData &a_data, const std::string a_realm, const phase::which_phase a_phase) const
	Harmonic average of data. Does all components.

void	harmonicAverage (EBAMRCellData &a_data, const std::string a_realm, const phase::which_phase a_phase, const Interval &a_variables) const
	Harmonic average of data. Does all components.

void	conservativeAverage (EBAMRCellData &a_data, const std::string a_realm, const phase::which_phase a_phase) const
	Conseratively average data. Does all components.

void	conservativeAverage (EBAMRCellData &a_data, const std::string a_realm, const phase::which_phase a_phase, const Interval &a_variables) const
	Conseratively average data. Does all components.

void	average (EBAMRFluxData &a_data, const std::string a_realm, const phase::which_phase a_phase, const Average &a_average) const
	Average down on specific realm and phase.

void	arithmeticAverage (EBAMRFluxData &a_data, const std::string a_realm, const phase::which_phase a_phase) const
	Average down on specific realm and phase.

void	harmonicAverage (EBAMRFluxData &a_data, const std::string a_realm, const phase::which_phase a_phase) const
	Average down on specific realm and phase.

void	conservativeAverage (EBAMRFluxData &a_data, const std::string a_realm, const phase::which_phase a_phase) const
	Average down on specific realm and phase.

void	average (EBAMRIVData &a_data, const std::string a_realm, const phase::which_phase a_phase, const Average &a_average) const
	Average down on specific realm and phase.

void	arithmeticAverage (EBAMRIVData &a_data, const std::string a_realm, const phase::which_phase a_phase) const
	Arithmetic average on specific realm and phase.

void	harmonicAverage (EBAMRIVData &a_data, const std::string a_realm, const phase::which_phase a_phase) const
	Harmonic average on specific realm and phase.

void	conservativeAverage (EBAMRIVData &a_data, const std::string a_realm, const phase::which_phase a_phase) const
	Conservative averaging on specific realm and phase.

template<class P , typename Ret , Ret(P::*)() const MemberFunc>
void	depositParticles (EBAMRCellData &a_meshData, const std::string &a_realm, const phase::which_phase &a_phase, const ParticleContainer< P > &a_particles, const DepositionType a_depositionType, const CoarseFineDeposition a_coarseFineDeposition, const bool a_forceIrregNGP=false)
	Deposit scalar particle quantities on the mesh.

template<class P , typename Ret , Ret(P::*)() const MemberFunc>
void	depositParticles (EBAMRIVData &a_meshData, const std::string &a_realm, const phase::which_phase &a_phase, const ParticleContainer< P > &a_particles) const noexcept
	Deposit scalar particle quantities on the mesh.

template<class P , class Ret , Ret(P::*)() MemberFunc>
void	interpolateParticles (ParticleContainer< P > &a_particles, const std::string &a_realm, const phase::which_phase &a_phase, const EBAMRCellData &a_meshScalarField, const DepositionType a_interpType, const bool a_forceIrregNGP=false) const
	Interpolate mesh data onto a particle position.

template<class P >
void	removeCoveredParticlesIF (ParticleContainer< P > &a_particles, const phase::which_phase &a_phase, const Real a_tolerance=0.0) const
	Function which removes particles from the domain if they fall inside the EB.

template<class P >
void	removeCoveredParticlesDiscrete (ParticleContainer< P > &a_particles, const phase::which_phase &a_phase, const Real a_tolerance=0.0) const
	Function which removes particles from the domain if they fall inside the EB.

template<class P >
void	removeCoveredParticlesVoxels (ParticleContainer< P > &a_particles, const phase::which_phase &a_phase) const
	Function which removes particles from the domain if they fall inside the EB.

template<class P >
void	transferCoveredParticlesIF (ParticleContainer< P > &a_particlesFrom, ParticleContainer< P > &a_particlesTo, const phase::which_phase &a_phase, const Real a_tolerance=0.0) const
	Function which transferse particles from one particle container to another if they fall inside the EB.

template<class P >
void	transferCoveredParticlesDiscrete (ParticleContainer< P > &a_particlesFrom, ParticleContainer< P > &a_particlesTo, const phase::which_phase &a_phase, const Real a_tolerance=0.0) const
	Function which transferse particles from one particle container to another if they fall inside the EB.

template<class P >
void	transferCoveredParticlesVoxels (ParticleContainer< P > &a_particlesFrom, ParticleContainer< P > &a_particlesTo, const phase::which_phase &a_phase) const
	Function which transferse particles from one particle container to another if they fall inside the EB.

template<class P >
void	transferIrregularParticles (ParticleContainer< P > &a_dstParticles, ParticleContainer< P > &a_srcParticles, const phase::which_phase a_phase, const std::function< void(P &)> a_transferModifier=[](P &) -> void { return;}) const noexcept
	Transfer particles that are on the wrong side of the EB to a different container.

template<class P >
void	intersectParticlesRaycastIF (ParticleContainer< P > &a_activeParticles, ParticleContainer< P > &a_ebParticles, ParticleContainer< P > &a_domainParticles, const phase::which_phase a_phase, const Real a_tolerance, const bool a_deleteParticles, const std::function< void(P &)> a_nonDeletionModifier=[](P &) -> void { return;}) const noexcept
	Particle intersection algorithm based on ray-casting.

template<class P >
void	intersectParticlesBisectIF (ParticleContainer< P > &a_activeParticles, ParticleContainer< P > &a_ebParticles, ParticleContainer< P > &a_domainParticles, const phase::which_phase a_phase, const Real a_bisectionStep, const bool a_deleteParticles, const std::function< void(P &)> a_nonDeletionModifier=[](P &) -> void { return;}) const noexcept
	Particle intersection algorithm based on bisection.

void	interpGhost (EBAMRCellData &a_data, const std::string a_realm, const phase::which_phase a_phase) const
	Interpolate ghost vectors over a realm, using the default ghost cell interpolation method.

void	interpGhost (LevelData< EBCellFAB > &a_fineData, const LevelData< EBCellFAB > &a_coarData, const int a_level, const std::string a_realm, const phase::which_phase a_phase) const
	Interpolate ghost cells over a realm, using the default ghost cell interpolation method on a specific level.

void	interpGhost (MFAMRCellData &a_data, const std::string a_realm) const
	Interpolate ghost cells over a realm. Calls the default ghost cell interpolation method.

void	interpGhostPwl (MFAMRCellData &a_data, const std::string a_realm) const
	Interpolate ghost cells over a realm and phase. This uses piecewise linear interpolation (with limiters)

void	interpGhostPwl (EBAMRCellData &a_data, const std::string a_realm, const phase::which_phase a_phase) const
	Interpolate ghost cells over a realm and phase. This uses piecewise linear interpolation (with limiters)

void	interpGhostMG (MFAMRCellData &a_data, const std::string a_realm) const
	Interpolate ghost cells over a realm and phase.

void	interpGhostMG (EBAMRCellData &a_data, const std::string a_realm, const phase::which_phase a_phase) const
	Interpolate ghost cells over a realm and phase.

void	interpToNewGrids (MFAMRCellData &a_newData, const MFAMRCellData &a_oldData, const int a_lmin, const int a_oldFinestLevel, const int a_newFinestLevel, const EBCoarseToFineInterp::Type a_type)
	Interpolate data to new grids.

void	interpToNewGrids (EBAMRCellData &a_newData, const EBAMRCellData &a_oldData, const phase::which_phase a_phase, const int a_lmin, const int a_oldFinestLevel, const int a_newFinestLevel, const EBCoarseToFineInterp::Type a_type)
	Interpolate data to new grids.

void	interpToNewGrids (EBAMRIVData &a_newData, const EBAMRIVData &a_oldData, const phase::which_phase a_phase, const int a_lmin, const int a_oldFinestLevel, const int a_newFinestLevel, const EBCoarseToFineInterp::Type a_type)
	Interpolate data to new grids.

template<class P >
void	remapToNewGrids (ParticleContainer< P > &a_particles, const int a_lmin, const int a_newFinestLevel) const noexcept
	Regrid particle to new grids.

void	interpToCentroids (EBAMRCellData &a_data, const std::string a_realm, const phase::which_phase a_phase) const noexcept
	Interpolate data to centroids on realm and phase.

void	interpToCentroids (LevelData< EBCellFAB > &a_data, const std::string a_realm, const phase::which_phase a_phase, const int a_level) const noexcept
	Interpolate data to centroids.

void	interpToCentroids (EBCellFAB &a_centroidData, const EBCellFAB &a_cellData, const std::string a_realm, const phase::which_phase a_phase, const int a_level, const DataIndex &a_din) const noexcept
	Interpolate data to centroids.

void	interpToCentroids (EBAMRIVData &a_centroidData, const EBAMRCellData &a_cellData, const std::string a_realm, const phase::which_phase a_phase) const noexcept
	Interpolate data to centroids on realm and phase.

void	interpToCentroids (LevelData< BaseIVFAB< Real > > &a_centroidData, const LevelData< EBCellFAB > &a_cellData, const std::string a_realm, const phase::which_phase a_phase, const int a_level) const noexcept
	Interpolate data to centroids.

void	interpToEB (EBAMRIVData &a_centroidData, const EBAMRCellData &a_cellData, const std::string a_realm, const phase::which_phase a_phase) const noexcept
	Interpolate data to EB centroids on realm and phase.

void	interpToEB (LevelData< BaseIVFAB< Real > > &a_centroidData, const LevelData< EBCellFAB > &a_cellData, const std::string a_realm, const phase::which_phase a_phase, const int a_level) const noexcept
	Interpolate data to EB centroids.

void	interpToEB (BaseIVFAB< Real > &a_centroidData, const EBCellFAB &a_cellData, const std::string a_realm, const phase::which_phase a_phase, const int a_level, const DataIndex &a_din) const noexcept
	Interpolate data to EB centroids.

void	nonConservativeDivergence (EBAMRIVData &a_nonConsDivF, const EBAMRCellData &a_kappaDivF, const std::string &a_realm, const phase::which_phase &a_phase) const noexcept
	Compute a non-conservative divergence.

void	nonConservativeDivergence (LevelData< BaseIVFAB< Real > > &a_nonConsDivF, const LevelData< EBCellFAB > &a_kappaDivF, const int &a_level, const std::string &a_realm, const phase::which_phase &a_phase) const noexcept
	Compute a non-conservative divergence.

void	setMultifluidIndexSpace (const RefCountedPtr< MultiFluidIndexSpace > &a_multiFluidIndexSpace)
	Sets multifluid index space.

void	setBaseImplicitFunction (const phase::which_phase a_phase, const RefCountedPtr< BaseIF > &a_baseIF)
	Set implicit function for a specific phase. Need e.g. for level-sets.

void	preRegrid ()
	Run pre-regrid operations.

void	regridAmr (const Vector< IntVectSet > &a_tags, const int a_lmin, const int a_hardcap=-1)
	Regrid AMR. This versions generates the grids and Realms, but not the operator.

void	regridRealm (const std::string a_realm, const Vector< Vector< int > > &a_procs, const Vector< Vector< Box > > &a_boxes, const int a_lmin)
	Regrid a realm. This generates the grids for the realm, but does not do the operators on the realm.

void	postRegrid ()
	Run post-regrid operations.

void	setGrids (const Vector< Vector< Box > > &a_boxes, const std::map< std::string, Vector< Vector< long int > > > &a_realmsAndLoads)
	Set grids from boxes and computational loads.

void	regridOperators (const int a_lmin)
	Regrid AMR operators. This is done for all realms.

void	regridOperators (const std::string a_realm, const int a_lmin)
	Regrid AMR operators. This is done for a specific realm.

void	sanityCheck () const
	Do a sanity check to make sure everything is set up correctly.

int	getFinestLevel () const
	Get finest grid level.

int	getMaxAmrDepth () const
	Get maximum permitted amr depth.

int	getMaxSimulationDepth () const
	Get maximum permitted simulation depth.

int	getBlockingFactor () const
	Get blocking factor (i.e. the smallest possible box).

int	getMaxBoxSize () const
	Get maximum permitted box size.

int	getBrBuffer () const
	Return buffer for B-R mesh refinement algorithm.

int	getMaxEbisBoxSize () const
	Get maximum box size for EBIS generation.

int	getNumberOfGhostCells () const
	Get the default number of ghost cells.

int	getNumberOfEbGhostCells () const
	Get number of ghost cells used for EB grid generation.

int	getRedistributionRadius () const
	Get default redistribution radius.

Real	getFinestDx () const
	Get resolution on the finest grid level.

RealVect	getProbLo () const
	Get lower-left corner of computational domain.

RealVect	getProbHi () const
	Get upper-left corner of computational domain.

ProblemDomain	getFinestDomain () const
	Get finest domain.

const Vector< Real > &	getDx () const
	Get spatial resolutions.

const Vector< int > &	getRefinementRatios () const
	Get refinement ratios.

int	getRefinementRatio (const int a_level1, const int a_level2) const
	Get refinement factor between two levels.

const RefCountedPtr< BaseIF > &	getBaseImplicitFunction (const phase::which_phase a_phase) const
	Get implicit function for a specific phase.

const Vector< DisjointBoxLayout > &	getProxyGrids () const
	Get the "proxy" grids in AmrMesh.

const Vector< DisjointBoxLayout > &	getGrids (const std::string a_realm) const
	Get the grids.

const Vector< ProblemDomain > &	getDomains () const
	Get domains.

const AMRMask &	getMask (const std::string a_mask, const int a_buffer, const std::string a_realm) const
	Get a registered mask.

const AMRMask &	getValidCells (const std::string a_realm) const
	Get a map of all valid cells on a specified realm.

const Vector< RefCountedPtr< LevelTiles > > &	getLevelTiles (const std::string a_realm) const
	Get the tiled space representation.

const Vector< RefCountedPtr< EBLevelGrid > > &	getEBLevelGrid (const std::string a_realm, const phase::which_phase a_phase) const
	Get the EBLevelGrid for a Realm and phase.

const Vector< RefCountedPtr< EBLevelGrid > > &	getEBLevelGridCoFi (const std::string a_realm, const phase::which_phase a_phase) const
	Get the coarsened fine EBLevelGrid for a Realm and phase.

const Vector< EBISLayout > &	getEBISLayout (const std::string a_realm, const phase::which_phase a_phase) const
	Get EBISLayouts for a Realm and phase.

const Vector< RefCountedPtr< MFLevelGrid > > &	getMFLevelGrid (const std::string a_realm) const
	Get EBISLayouts for a Realm.

Vector< RefCountedPtr< LayoutData< VoFIterator > > > &	getVofIterator (const std::string a_realm, const phase::which_phase a_phase) const
	Get vof iterators for a Realm and phase. This has the capability of iterating through cut-cells.

const EBAMRFAB &	getLevelset (const std::string a_realm, const phase::which_phase a_phase) const
	Get levelset function, allocated over a grid for a Realm and phase.

EBAMRParticleMesh &	getParticleMesh (const std::string a_realm, const phase::which_phase a_phase) const
	Get EBAMRParticleMesh operator.

EBAMRSurfaceDeposition &	getSurfaceDeposition (const std::string a_realm, const phase::which_phase a_phase) const
	Get EBAMRSurfaceDeposition surface deposition operator.

Vector< RefCountedPtr< EBCoarAve > > &	getCoarseAverage (const std::string a_realm, const phase::which_phase a_phase) const
	Get the coarsening utility.

Vector< RefCountedPtr< EBMultigridInterpolator > > &	getMultigridInterpolator (const std::string a_realm, const phase::which_phase a_phase) const
	Get multigrid interpolation utility.

Vector< RefCountedPtr< EBCoarseToFineInterp > > &	getFineInterp (const std::string a_realm, const phase::which_phase a_phase) const
	Get interpolator.

Vector< RefCountedPtr< EBReflux > > &	getFluxRegister (const std::string a_realm, const phase::which_phase a_phase) const
	Get flux register.

Vector< RefCountedPtr< EBFluxRedistribution > > &	getRedistributionOp (const std::string a_realm, const phase::which_phase a_phase) const
	Get the redistribution operators.

std::vector< std::string >	getRealms () const
	Get the name of all Realms.

BoxSorting	getBoxSorting () const
	Get box sorting method.

RefCountedPtr< EBIndexSpace > &	getEBIndexSpace (const phase::which_phase a_phase)
	Get EBIndexSpace corresponding to a particular phase.

Protected Types
enum class	GridGenerationMethod { BergerRigoutsous , Tiled }
	Enum for having understandable notation for grid generation.

Protected Member Functions
void	defineRealms ()
	Define Realms.

void	buildGrids (const Vector< IntVectSet > &a_tags, const int a_lmin, const int a_hardcap=-1)
	Build new internal AMR grids.

void	buildCopiers ()
	Build copiers for copying between realms.

void	parseProbLoHiCorners ()
	Parse the low/high corners of the computational domain.

void	parseGridGeneration ()
	Parse the grid generation algorithm.

void	parseVerbosity ()
	Parse the verbosity for AmrMesh.

void	parseCoarsestLevelNumCells ()
	Parse the coarsest domain grid.

void	parseMaxAmrDepth ()
	Parse the maximum permitted AMR depth.

void	parseMaxSimulationDepth ()
	Set maximum simulation depth.

void	parseRefinementRatios ()
	Parse refinement ratios.

void	parseBrBufferSize ()
	Parse buffer size for Berger-Rigoutsous grid algorithm.

void	parseBrFillRatio ()
	Parse the Berger-Rigoutsos fill ratio.

void	parseMaxBoxSize ()
	Parse the maximum permitted box size.

void	parseMaxEbisBoxSize ()
	Parse the maximum permitted box size.

void	parseBlockingFactor ()
	Parse the B-R blocking factor. For tiled mesh refinement this parses the tile size.

void	parseEbGhostCells ()
	Parse number of ghost cells for eb stuff.

void	parseNumGhostCells ()
	Parse the number of ghost cells.

void	parseMultigridInterpolator ()
	Parse settings for the multigrid interpolator.

void	parseRedistributionRadius ()
	Parse the default redistribution radius.

void	parseCellCentroidInterpolation ()
	Parse centroid interpolation stencils.

void	parseEBCentroidInterpolation ()
	Parse EB interpolation (or extrapolation) stencils.

void	computeGradient (LevelData< EBCellFAB > &a_gradient, const LevelData< EBCellFAB > &a_phi, const std::string a_realm, const phase::which_phase a_phase, const int a_lvl) const
	Compute cell-centered gradient for a grid level.

Protected Attributes
std::map< std::string, RefCountedPtr< Realm > >	m_realms
	These are all the Realms.

std::map< phase::which_phase, RefCountedPtr< BaseIF > >	m_baseif
	Implicit functions.

std::map< std::string, Vector< DisjointBoxLayout > >	m_oldGrids
	Old grids.

std::map< std::string, Vector< Copier > >	m_oldToNewCellCopiers
	Storage for copiers from the old grids to the new ones.

std::map< std::string, Vector< Copier > >	m_oldToNewEBCopiers
	Storage for copiers from the old grids to the new ones.

std::map< std::pair< std::string, std::string >, Vector< Copier > >	m_validToValidRealmCopiers
	Map for copying between various Realms. First index is the "from" realm and second index is the "to" realm.

std::map< std::pair< std::string, std::string >, Vector< Copier > >	m_validToValidGhostRealmCopiers
	Map for copying between various Realms. First index is the "from" realm and second index is the "to" realm.

std::map< std::pair< std::string, std::string >, Vector< Copier > >	m_validGhostToValidRealmCopiers
	Map for copying between various Realms. First index is the "from" realm and second index is the "to" realm.

std::map< std::pair< std::string, std::string >, Vector< Copier > >	m_validGhostToValidGhostRealmCopiers
	Map for copying between various Realms. First index is the "from" realm and second index is the "to" realm.

GridGenerationMethod	m_gridGenerationMethod
	Grid generation method.

BoxSorting	m_boxSort
	Box sorting.

RefCountedPtr< MultiFluidIndexSpace >	m_multifluidIndexSpace
	MultiFluidIndexSpace.

CellCentroidInterpolation::Type	m_cellCentroidInterpolationType
	Interpolation type for cell to cell centroid interpolation.

EBCentroidInterpolation::Type	m_ebCentroidInterpolationType
	Interpolation type for cell to EB centroid interpolation

IntVect	m_numCells
	Coarsest box where we compute.

Real	m_fillRatioBR
	Fill ratio.

RealVect	m_probLo
	Domain simulation corner.

RealVect	m_probHi
	Domain simulation corner.

int	m_refRatio
	Refinement ratio.

int	m_verbosity
	Verbosity.

int	m_finestLevel
	Finest level.

int	m_oldFinestLevel
	Finest level before a regrid.

int	m_maxAmrDepth
	Maximum amr depth.

int	m_maxSimulationDepth
	Maximum allowed depth for simulation.

int	m_maxBoxSize
	Max box size.

int	m_maxEbisBoxSize
	Maximum box size for EBIS generation.

int	m_bufferSizeBR
	Set buffer size.

int	m_blockingFactor
	Blocking factor.

int	m_numEbGhostsCells
	Number of ghost cells to use for eb stuff.

int	m_numGhostCells
	Number of ghost cells.

int	m_numLsfGhostCells
	Number of ghost cells to use when writing level-set to grid.

int	m_multigridInterpOrder
	Multigrid interpolation order.

int	m_multigridInterpRadius
	Multigrid interpolation radius.

int	m_multigridInterpWeight
	Multigrid interpolation weights.

int	m_redistributionRadius
	Redistribution radius.

bool	m_hasGrids
	Has grids or not.

bool	m_hasRegridCopiers
	Has regrid copiers or not.

Vector< DisjointBoxLayout >	m_grids
	Grids.

Vector< ProblemDomain >	m_domains
	Problem domains.

Vector< int >	m_refinementRatios
	AMR resolutions.

Vector< Real >	m_dx
	Level resolutions.

Detailed Description

Class for handling spatial operations.

This class handles most (if not all) spatial operations. Examples are grid generation, coarsening of data, interpolation of data, memory allocations etc.

Constructor & Destructor Documentation

◆ AmrMesh() [1/2]

AmrMesh::AmrMesh ( const AmrMesh & a_other )

delete

Disallowed copy constructor.

Parameters

[in] a_other Other AmrMesh

◆ AmrMesh() [2/2]

AmrMesh::AmrMesh ( const AmrMesh && a_other )

delete

Disallowed move constructor.

Parameters

[in] a_other Other AmrMesh

Member Function Documentation

◆ alias() [1/10]

EBAMRCellData AmrMesh::alias	(	const phase::which_phase	a_phase,
		const MFAMRCellData &	a_mfdata
	)		const

Alias an entire hiearchy of multifluid data.

Parameters

[in]	a_phase	Phase (gas or solid).
[in]	a_mfdata	Multifluid data to be aliased

Returns: A single-phase alias of the multifluid data, having the same size as the input data.

◆ alias() [2/10]

EBAMRFluxData AmrMesh::alias	(	const phase::which_phase	a_phase,
		const MFAMRFluxData &	a_mfdata
	)		const

Alias an entire hiearchy of multifluid data.

Parameters

[in]	a_phase	Phase (gas or solid).
[in]	a_mfdata	Multifluid data to be aliased

Returns: A single-phase alias of the multifluid data, having the same size as the input data.

◆ alias() [3/10]

EBAMRIVData AmrMesh::alias	(	const phase::which_phase	a_phase,
		const MFAMRIVData &	a_mfdata
	)		const

Alias an entire hiearchy of multifluid data.

Parameters

[in]	a_phase	Phase (gas or solid).
[in]	a_mfdata	Multifluid data to be aliased

Returns: A single-phase alias of the multifluid data, having the same size as the input data.

◆ alias() [4/10]

void AmrMesh::alias	(	EBAMRCellData &	a_data,
		const phase::which_phase	a_phase,
		const MFAMRCellData &	a_mfdata
	)		const

Alias an entire hiearchy of multifluid data.

Parameters

[out]	a_data	Single-phased data on specific phase
[in]	a_phase	Phase (gas or solid).
[in]	a_mfdata	Multifluid data to be aliased

◆ alias() [5/10]

void AmrMesh::alias	(	EBAMRCellData &	a_data,
		const phase::which_phase	a_phase,
		const MFAMRCellData &	a_mfdata,
		const int	a_finestLevel
	)		const

Alias multifluid data up to a specified level.

Parameters

[out]	a_data	Single-phased data on specific phase
[in]	a_phase	Phase (gas or solid).
[in]	a_mfdata	Multifluid data to be aliased
[in]	a_finestLevel	Maximum grid level for aliasing operation.

◆ alias() [6/10]

void AmrMesh::alias	(	EBAMRFluxData &	a_data,
		const phase::which_phase	a_phase,
		const MFAMRFluxData &	a_mfdata
	)		const

Alias an entire hiearchy of multifluid data.

Parameters

[out]	a_data	Single-phased data on specific phase
[in]	a_phase	Phase (gas or solid).
[in]	a_mfdata	Multifluid data to be aliased

◆ alias() [7/10]

void AmrMesh::alias	(	EBAMRFluxData &	a_data,
		const phase::which_phase	a_phase,
		const MFAMRFluxData &	a_mfdata,
		const int	a_finestLevel
	)		const

Alias multifluid data up to a specified level.

Parameters

[out]	a_data	Single-phased data on specific phase
[in]	a_phase	Phase (gas or solid).
[in]	a_mfdata	Multifluid data to be aliased
[in]	a_finestLevel	Maximum grid level for aliasing operation.

◆ alias() [8/10]

void AmrMesh::alias	(	EBAMRIVData &	a_data,
		const phase::which_phase	a_phase,
		const MFAMRIVData &	a_mfdata
	)		const

Alias an entire hiearchy of multifluid data.

Parameters

[out]	a_data	Single-phased data on specific phase
[in]	a_phase	Phase (gas or solid).
[in]	a_mfdata	Multifluid data to be aliased

◆ alias() [9/10]

template<typename T , typename S >

void AmrMesh::alias	(	Vector< T * > &	a_alias,
		const EBAMRData< S > &	a_data
	)		const

Turn smart-pointer data structure into regular-pointer data structure.

Parameters

[out]	a_alias	Raw pointer aliased
[in]	a_data	Smart-pointer data

This fetches the bare pointer from a_data and sets it in a_alias.

◆ alias() [10/10]

template<typename T >

void AmrMesh::alias	(	Vector< T * > &	a_alias,
		const Vector< RefCountedPtr< T > > &	a_data
	)		const

Turn smart-pointer data structure into regular-pointer data structure.

Parameters

[out]	a_alias	Raw pointer aliased
[in]	a_data	Smart-pointer data

This fetches the bare pointer from a_data and sets it in a_alias.

◆ allocate() [1/11]

void AmrMesh::allocate	(	EBAMRBool &	a_data,
		const std::string	a_realm,
		const int	a_nComp,
		const int	a_nGhost = `-1`
	)		const

Allocate Boolean data over a specific realm.

Parameters

[out]	a_data	Data holder to be allocated
[in]	a_realm	Realm of the name where the data will be allocated.
[in]	a_nComp	Number of components in a_data
[in]	a_nGhost	Number of ghost cells for a_data

Note: If a_nGhost < 0, this routine will use the default number of ghost cells.

◆ allocate() [2/11]

void AmrMesh::allocate	(	EBAMRCellData &	a_data,
		const std::string	a_realm,
		const phase::which_phase	a_phase,
		const int	a_nComp,
		const int	a_nGhost = `-1`
	)		const

Allocate a data holder over a specific realm.

Parameters

[out]	a_data	Data holder to be allocated
[in]	a_realm	Realm of the name where the data will be allocated.
[in]	a_phase	Phase (gas or solid)
[in]	a_nComp	Number of components in a_data
[in]	a_nGhost	Number of ghost cells for a_data

Note: If a_nGhost < 0, this routine will use the default number of ghost cells.

◆ allocate() [3/11]

void AmrMesh::allocate	(	EBAMRFluxData &	a_data,
		const std::string	a_realm,
		const phase::which_phase	a_phase,
		const int	a_nComp,
		const int	a_nGhost = `-1`
	)		const

Allocate a data holder over a specific realm.

Parameters

[out]	a_data	Data holder to be allocated
[in]	a_realm	Realm of the name where the data will be allocated.
[in]	a_phase	Phase (gas or solid)
[in]	a_nComp	Number of components in a_data
[in]	a_nGhost	Number of ghost cells for a_data

Note: If a_nGhost < 0, this routine will use the default number of ghost cells.

◆ allocate() [4/11]

void AmrMesh::allocate	(	EBAMRIFData &	a_data,
		const std::string	a_realm,
		const phase::which_phase	a_phase,
		const int	a_nComp,
		const int	a_nGhost = `-1`
	)		const

Allocate a data holder over a specific realm.

Parameters

[out]	a_data	Data holder to be allocated
[in]	a_realm	Realm of the name where the data will be allocated.
[in]	a_nComp	Number of components in a_data
[in]	a_nGhost	Number of ghost cells for a_data

Note: If a_nGhost < 0, this routine will use the default number of ghost cells.

◆ allocate() [5/11]

void AmrMesh::allocate	(	EBAMRIVData &	a_data,
		const std::string	a_realm,
		const phase::which_phase	a_phase,
		const int	a_nComp,
		const int	a_nGhost = `-1`
	)		const

Allocate a data holder over a specific realm.

Parameters

[out]	a_data	Data holder to be allocated
[in]	a_realm	Realm of the name where the data will be allocated.
[in]	a_phase	Phase (gas or solid)
[in]	a_nComp	Number of components in a_data
[in]	a_nGhost	Number of ghost cells for a_data

Note: If a_nGhost < 0, this routine will use the default number of ghost cells.

◆ allocate() [6/11]

void AmrMesh::allocate	(	LevelData< EBCellFAB > &	a_data,
		const std::string	a_realm,
		const phase::which_phase	a_phase,
		const int	a_level,
		const int	a_nComp,
		const int	a_nGhost = `-1`
	)		const

Allocate data on specific level.

Parameters

[out]	a_data	Data holder to be allocated
[in]	a_realm	Realm of the name where the data will be allocated.
[in]	a_phase	Phase (gas or solid)
[in]	a_level	AMR level
[in]	a_nComp	Number of components in a_data
[in]	a_nGhost	Number of ghost cells for a_data

Note: If a_nGhost < 0, this routine will use the default number of ghost cells.

◆ allocate() [7/11]

void AmrMesh::allocate	(	MFAMRCellData &	a_data,
		const std::string	a_realm,
		const int	a_nComp,
		const int	a_nGhost = `-1`
	)		const

Allocate a data holder over a specific realm.

Parameters

[out]	a_data	Data holder to be allocated
[in]	a_realm	Realm of the name where the data will be allocated.
[in]	a_nComp	Number of components in a_data
[in]	a_nGhost	Number of ghost cells for a_data

Note: If a_nGhost < 0, this routine will use the default number of ghost cells.

◆ allocate() [8/11]

void AmrMesh::allocate	(	MFAMRFluxData &	a_data,
		const std::string	a_realm,
		const int	a_nComp,
		const int	a_ghost = `-1`
	)		const

Allocate a data holder over a specific realm.

Parameters

[out]	a_data	Data holder to be allocated
[in]	a_realm	Realm of the name where the data will be allocated.
[in]	a_nComp	Number of components in a_data
[in]	a_nGhost	Number of ghost cells for a_data

Note: If a_nGhost < 0, this routine will use the default number of ghost cells.

◆ allocate() [9/11]

void AmrMesh::allocate	(	MFAMRIVData &	a_data,
		const std::string	a_realm,
		const int	a_nComp,
		const int	a_ghost = `0`
	)		const

Allocate a data holder over a specific realm.

Parameters

[out]	a_data	Data holder to be allocated
[in]	a_realm	Realm of the name where the data will be allocated.
[in]	a_nComp	Number of components in a_data
[in]	a_nGhost	Number of ghost cells for a_data

Note: If a_nGhost < 0, this routine will use the default number of ghost cells.

◆ allocate() [10/11]

template<typename T >

void AmrMesh::allocate	(	ParticleContainer< T > &	a_container,
		const std::string	a_realm
	)		const

Template class for generic allocation of particle containers.

Parameters

[out]	a_container	Particle container to be allocated
[out]	a_realm	Realm on which the particles will be allocated.

◆ allocate() [11/11]

template<typename T >

void AmrMesh::allocate	(	Vector< RefCountedPtr< ParticleData< T > > > &	a_particles,
		const std::string	a_realm
	)		const

Template class for generic allocation of particle data.

Parameters

[out]	a_particles	Particle data holder.
[out]	a_realm	Realm on which the particles will be allocated.

◆ allocatePointer() [1/4]

template<typename T >

void AmrMesh::allocatePointer	(	EBAMRData< T > &	a_data,
		const std::string	a_realm
	)		const

Allocate pointer but not any memory blocks.

Parameters

[out]	a_data	Data structure for which pointers will be constructed.
[in]	a_realm	Realm associated with the data

This sets all the elements in a_data to be RefCountedPtr<T>(nullptr)

◆ allocatePointer() [2/4]

template<typename T >

void AmrMesh::allocatePointer	(	EBAMRData< T > &	a_data,
		const std::string	a_realm,
		const int	a_finestLevel
	)		const

Allocate pointer but not any memory.

Parameters

[out]	a_data	Data structure for which pointers will be constructed.
[in]	a_realm	Realm associated with the data
[in]	a_finestLevel	Finest grid level on which a_data will be defined.

This sets all the elements in the vector to be RefCountedPtr<T>(nullptr)

◆ allocatePointer() [3/4]

template<typename T >

void AmrMesh::allocatePointer ( Vector< RefCountedPtr< T > > & a_data ) const

Allocate pointer but not any memory blocks.

Parameters

[out] a_data Data structure for which pointers will be constructed.

This sets all the elements in the vector to be RefCountedPtr<T>(nullptr)

◆ allocatePointer() [4/4]

template<typename T >

void AmrMesh::allocatePointer	(	Vector< RefCountedPtr< T > > &	a_data,
		const int	a_finestLevel
	)		const

Allocate pointer but not any memory blocks.

Parameters

[out]	a_data	Data structure for which pointers will be constructed.
[in]	a_finestLevel	Finest grid level on which a_data will be defined.

This sets all the elements in the vector to be RefCountedPtr<T>(nullptr)

◆ arithmeticAverage() [1/6]

void AmrMesh::arithmeticAverage	(	EBAMRCellData &	a_data,
		const std::string	a_realm,
		const phase::which_phase	a_phase
	)		const

Arithmetic average of data. Does all components.

Parameters

[in,out]	a_data	Data to be coarsened.
[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)

◆ arithmeticAverage() [2/6]

void AmrMesh::arithmeticAverage	(	EBAMRCellData &	a_data,
		const std::string	a_realm,
		const phase::which_phase	a_phase,
		const Interval &	a_variables
	)		const

Arithmetic average of data.

Parameters

[in,out]	a_data	Data to be coarsened.
[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)
[in]	a_variables	Variables

◆ arithmeticAverage() [3/6]

void AmrMesh::arithmeticAverage	(	EBAMRFluxData &	a_data,
		const std::string	a_realm,
		const phase::which_phase	a_phase
	)		const

Average down on specific realm and phase.

This computes an arithmetic average of the face data. Data on coarse faces is replaced by the arithmetic average of the fine face data.

Parameters

[in,out]	a_data	Data to be average.
[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)

◆ arithmeticAverage() [4/6]

void AmrMesh::arithmeticAverage	(	EBAMRIVData &	a_data,
		const std::string	a_realm,
		const phase::which_phase	a_phase
	)		const

Arithmetic average on specific realm and phase.

Parameters

[in,out]	a_data	Data to be coarsened.
[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)

◆ arithmeticAverage() [5/6]

void AmrMesh::arithmeticAverage	(	MFAMRCellData &	a_data,
		const std::string	a_realm
	)		const

Arithmetic coarsening of multifluid data.

Parameters

[in,out]	a_data	Data to be coarsened.
[in]	a_realm	Realm name

◆ arithmeticAverage() [6/6]

void AmrMesh::arithmeticAverage	(	MFAMRFluxData &	a_data,
		const std::string	a_realm
	)		const

Average multifluid data over a realm.

This computes an arithmetic average of the face data. Data on coarse faces is replaced by the arithmetic average of the fine face data.

Parameters

[in,out]	a_data	Data to be coarsened.
[in]	a_realm	Realm name

◆ average() [1/6]

void AmrMesh::average	(	EBAMRCellData &	a_data,
		const std::string	a_realm,
		const phase::which_phase	a_phase,
		const Average &	a_average
	)		const

Average down on specific realm and phase.

Parameters

[in,out]	a_data	Data to be coarsened.
[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)
[in]	a_average	Averaging method

◆ average() [2/6]

void AmrMesh::average	(	EBAMRCellData &	a_data,
		const std::string	a_realm,
		const phase::which_phase	a_phase,
		const Average &	a_average,
		const Interval &	a_variables
	)		const

Average down on specific realm and phase.

Parameters

[in,out]	a_data	Data to be coarsened.
[in]	a_realm	Realm
[in]	a_phase	Phase (gas or solid)
[in]	a_variables	Variables to average
[in]	a_average	Averaging method

◆ average() [3/6]

void AmrMesh::average	(	EBAMRFluxData &	a_data,
		const std::string	a_realm,
		const phase::which_phase	a_phase,
		const Average &	a_average
	)		const

Average down on specific realm and phase.

Parameters

[in,out]	a_data	Data to be coarsened.
[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)
[in]	a_average	Averaging method

◆ average() [4/6]

void AmrMesh::average	(	EBAMRIVData &	a_data,
		const std::string	a_realm,
		const phase::which_phase	a_phase,
		const Average &	a_average
	)		const

Average down on specific realm and phase.

Parameters

[in,out]	a_data	Data to be coarsened.
[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)
[in]	a_average	Averaging method

◆ average() [5/6]

void AmrMesh::average	(	MFAMRCellData &	a_data,
		const std::string	a_realm,
		const Average &	a_average
	)		const

Average multifluid data over a specified realm.

Parameters

[in,out]	a_data	Data to be coarsened.
[in]	a_realm	Realm name
[in]	a_average	Averaging method

◆ average() [6/6]

void AmrMesh::average	(	MFAMRFluxData &	a_data,
		const std::string	a_realm,
		const Average &	a_average
	)		const

Average multifluid data over a specified realm.

Parameters

[in,out]	a_data	Data to be coarsened.
[in]	a_realm	Realm name
[in]	a_average	Averaging method

◆ buildGrids()

void AmrMesh::buildGrids	(	const Vector< IntVectSet > &	a_tags,
		const int	a_lmin,
		const int	a_hardcap = `-1`
	)

protected

Build new internal AMR grids.

Parameters

[in,out]	a_tags	Sets of cell tags used for the grid generation.
[in]	a_lmin	The finest grid level which changes.
[in]	a_hardcap	Hardcap for the maximum grid level which can be generated. If a_hardcap < 0 there is no restriction beyond the AmrMesh restrictions.

This will call the specified grid generation method and fill m_grids with the new grids.

◆ computeGradient() [1/5]

void AmrMesh::computeGradient	(	EBAMRCellData &	a_gradient,
		const EBAMRCellData &	a_phi,
		const std::string	a_realm,
		const phase::which_phase	a_phase
	)		const

Compute cell-centered gradient over an AMR hierarchy.

Parameters

[out]	a_gradient	Cell centered gradient.
[in]	a_phi	The scalar for which the gradient is computed.
[in]	a_realm	Name of the realm where the data lives.
[in]	a_phase	Phase on which the data lives.

Note: This routine will reach into ghost cells and across refinement boundaries. The user must make sure that ghost cells are updated before using this routine.

◆ computeGradient() [2/5]

void AmrMesh::computeGradient	(	EBAMRFluxData &	a_gradient,
		const EBAMRCellData &	a_phi,
		const std::string	a_realm,
		const phase::which_phase	a_phase
	)		const

Compute face-centered gradient over an AMR hierarchy.

Parameters

[out]	a_gradient	Face centered gradient.
[in]	a_phi	The scalar for which the gradient is computed.
[in]	a_realm	Name of the realm where the data lives.
[in]	a_phase	Phase on which the data lives.

Note: This routine will reach into ghost cells and across refinement boundaries. The user must make sure that ghost cells are updated before using this routine.

◆ computeGradient() [3/5]

void AmrMesh::computeGradient	(	LevelData< EBCellFAB > &	a_gradient,
		const LevelData< EBCellFAB > &	a_phi,
		const std::string	a_realm,
		const phase::which_phase	a_phase,
		const int	a_lvl
	)		const

protected

Compute cell-centered gradient for a grid level.

Parameters

[out]	a_gradient	Cell centered gradient.
[in]	a_phi	The scalar for which the gradient is computed.
[in]	a_realm	Name of the realm where the data lives.
[in]	a_phase	Phase on which the data lives.
[in]	a_lvl	Grid level where the data lives.

Note: This routine will reach into ghost cells and across refinement boundaries. The user must make sure that ghost cells updated before using this routine.

◆ computeGradient() [4/5]

void AmrMesh::computeGradient	(	MFAMRCellData &	a_gradient,
		const MFAMRCellData &	a_phi,
		const std::string	a_realm
	)		const

Compute cell-centered gradient over an AMR hierarchy.

Parameters

[out]	a_gradient	Cell centered gradient.
[in]	a_phi	The scalar for which the gradient is computed.
[in]	a_realm	Name of the Realm where the data lives.

Note: This routine will reach into ghost cells and across refinement boundaries. The user must make sure that ghost cells are updated before using this routine.

◆ computeGradient() [5/5]

void AmrMesh::computeGradient	(	MFAMRFluxData &	a_gradient,
		const MFAMRCellData &	a_phi,
		const std::string	a_realm
	)		const

Compute face-centered gradient over an AMR hierarchy.

Parameters

[out]	a_gradient	Face centered gradient.
[in]	a_phi	The scalar for which the gradient is computed.
[in]	a_realm	Name of the Realm where the data lives.

Note: This routine will reach into ghost cells and across refinement boundaries. The user must make sure that ghost cells are updated before using this routine.

◆ conservativeAverage() [1/6]

void AmrMesh::conservativeAverage	(	EBAMRCellData &	a_data,
		const std::string	a_realm,
		const phase::which_phase	a_phase
	)		const

Conseratively average data. Does all components.

Parameters

[in,out]	a_data	Data to be coarsened.
[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)

◆ conservativeAverage() [2/6]

void AmrMesh::conservativeAverage	(	EBAMRCellData &	a_data,
		const std::string	a_realm,
		const phase::which_phase	a_phase,
		const Interval &	a_variables
	)		const

Conseratively average data. Does all components.

Parameters

[in,out]	a_data	Data to be coarsened.
[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)
[in]	a_variables	Variables

◆ conservativeAverage() [3/6]

void AmrMesh::conservativeAverage	(	EBAMRFluxData &	a_data,
		const std::string	a_realm,
		const phase::which_phase	a_phase
	)		const

Average down on specific realm and phase.

Parameters

[in,out]	a_data	Data to be coarsened.
[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)

◆ conservativeAverage() [4/6]

void AmrMesh::conservativeAverage	(	EBAMRIVData &	a_data,
		const std::string	a_realm,
		const phase::which_phase	a_phase
	)		const

Conservative averaging on specific realm and phase.

Parameters

[in,out]	a_data	Data to be coarsened.
[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)

◆ conservativeAverage() [5/6]

void AmrMesh::conservativeAverage	(	MFAMRCellData &	a_data,
		const std::string	a_realm
	)		const

Conservative coarsening of multifluid data.

Parameters

[in,out]	a_data	Data to be coarsened.
[in]	a_realm	Realm name

◆ conservativeAverage() [6/6]

void AmrMesh::conservativeAverage	(	MFAMRFluxData &	a_data,
		const std::string	a_realm
	)		const

Average down multifluid data over a realm.

Parameters

[in,out]	a_data	Data to be coarsened.
[in]	a_realm	Realm name

◆ copyData() [1/4]

template<typename T >

void AmrMesh::copyData	(	EBAMRData< T > &	a_dst,
		const EBAMRData< T > &	a_src,
		const CopyStrategy &	a_toRegion = `CopyStrategy::Valid`,
		const CopyStrategy &	a_fromRegion = `CopyStrategy::Valid`
	)		const

noexcept

Method for copying from a source container to a destination container. User supplies information about from/to regions.

Parameters

[in,out]	a_dst	Destination data
[in]	a_src	Source data
[in]	a_toRegion	Region we copy into
[in]	a_fromRegion	Region we copy from

Note: If the user requests copying into ghosted regions, the Copiers MUST USE THE CORRECT NUMBER OF GHOST CELLS; This routine will not work if copying between grids before/after regrids.

◆ copyData() [2/4]

template<typename T >

void AmrMesh::copyData	(	EBAMRData< T > &	a_dst,
		const EBAMRData< T > &	a_src,
		const Interval &	a_dstComps,
		const Interval &	a_srcComps,
		const CopyStrategy &	a_toRegion = `CopyStrategy::Valid`,
		const CopyStrategy &	a_fromRegion = `CopyStrategy::Valid`
	)		const

noexcept

Method for copying from a source container to a destination container. User supplies information.

Parameters

[in,out]	a_dst	Destination data
[in]	a_src	Source data
[in]	a_dstComps	Destination components
[in]	a_srcComps	Source components
[in]	a_toRegion	Region we copy into
[in]	a_fromRegion	Region we copy from

Note: If the user requests copying into ghosted regions, the Copiers MUST USE THE CORRECT NUMBER OF GHOST CELLS; This routine will not work if copying between grids before/after regrids.

◆ copyData() [3/4]

template<typename T >

void AmrMesh::copyData	(	LevelData< T > &	a_dst,
		const LevelData< T > &	a_src,
		const int	a_level,
		const std::string	a_toRealm,
		const std::string	a_fromRealm,
		const CopyStrategy &	a_toRegion = `CopyStrategy::Valid`,
		const CopyStrategy &	a_fromRegion = `CopyStrategy::Valid`
	)		const

noexcept

Method for copying from a source container to a destination container. User supplies information about from/to regions.

Parameters

[in,out]	a_dst	Destination data
[in]	a_src	Source data
[in]	a_level	Grid level
[in]	a_toRealm	Destination realm
[in]	a_fromRealm	Source realm
[in]	a_fromRegion	Region we copy from
[in]	a_toRegion	Region we copy into

Note: If the user requests copying into ghosted regions, the Copiers MUST USE THE CORRECT NUMBER OF GHOST CELLS; This routine will not work if copying between grids before/after regrids.

◆ copyData() [4/4]

template<typename T >

void AmrMesh::copyData	(	LevelData< T > &	a_dst,
		const LevelData< T > &	a_src,
		const int	a_level,
		const std::string	a_toRealm,
		const std::string	a_fromRealm,
		const Interval &	a_dstComps,
		const Interval &	a_srcComps,
		const CopyStrategy &	a_toRegion = `CopyStrategy::Valid`,
		const CopyStrategy &	a_fromRegion = `CopyStrategy::Valid`
	)		const

noexcept

Method for copying from a source container to a destination container. User supplies information about from/to regions.

Parameters

[in,out]	a_dst	Destination data
[in]	a_src	Source data
[in]	a_level	Grid level
[in]	a_toRealm	Destination realm
[in]	a_fromRealm	Source realm
[in]	a_dstComps	Destination components
[in]	a_srcComps	Source components
[in]	a_fromRegion	Region we copy from
[in]	a_toRegion	Region we copy into

Note: If the user requests copying into ghosted regions, the Copiers MUST USE THE CORRECT NUMBER OF GHOST CELLS; This routine will not work if copying between grids before/after regrids.

◆ deallocate() [1/3]

template<typename T >

void AmrMesh::deallocate ( EBAMRData< T > & a_data ) const

Deallocate data.

Parameters

[in,out] a_data Data to be deallocated.

◆ deallocate() [2/3]

template<typename T >

void AmrMesh::deallocate ( Vector< RefCountedPtr< T > > & a_data ) const

Deallocate smart pointer data.

Parameters

[in,out] a_data Data to be deallocated.

◆ deallocate() [3/3]

template<typename T >

void AmrMesh::deallocate ( Vector< T * > & a_data ) const

Deallocate data.

Parameters

[in,out] a_data Data to be deleted.

◆ depositParticles() [1/2]

template<class P , class Ret , Ret(P::*)() const MemberFunc>

void AmrMesh::depositParticles	(	EBAMRCellData &	a_meshData,
		const std::string &	a_realm,
		const phase::which_phase &	a_phase,
		const ParticleContainer< P > &	a_particles,
		const DepositionType	a_depositionType,
		const CoarseFineDeposition	a_coarseFineDeposition,
		const bool	a_forceIrregNGP = `false`
	)

Deposit scalar particle quantities on the mesh.

P is the particle type, Ret is the returned value of the particle member function, and must be a Real or a RealVect. MemFunc is a pointer to a member function of P. E.g., depositParticles<P, const RealVect&, &P::position>.

Parameters

[out]	a_meshData	Mesh data. Must have exactly one compnent.
[in]	a_realm	Realm where data is registered.
[in]	a_phase	Phase where data is registered.
[in]	a_particles	Particle container. Must be in "usable state" for deposition.
[in]	a_depositionType	Specification of deposition kernel (e.g., CIC)
[in]	a_coarseFineDeposition	Specification of handling of coarse-fine boundaries.
[in]	a_forceIrregNGP	Force NGP deposition in irregular cells or not.

◆ depositParticles() [2/2]

template<class P , typename Ret , Ret(P::*)() const MemberFunc>

void AmrMesh::depositParticles	(	EBAMRIVData &	a_meshData,
		const std::string &	a_realm,
		const phase::which_phase &	a_phase,
		const ParticleContainer< P > &	a_particles
	)		const

noexcept

Deposit scalar particle quantities on the mesh.

P is the particle type, Ret is the returned value of the particle member function, and must be a Real or a const Real&. MemFunc is a pointer to a member function of P. E.g., depositParticles<P, const Real&, &P::weight>.

Parameters

[out]	a_meshData	Mesh data. MUST have exactly one compnent.
[in]	a_realm	Realm where data is registered.
[in]	a_phase	Phase where data is registered.
[in]	a_particles	Particle container. Must be in "usable state" for deposition.

◆ getBaseImplicitFunction()

const RefCountedPtr< BaseIF > & AmrMesh::getBaseImplicitFunction ( const phase::which_phase a_phase ) const

Get implicit function for a specific phase.

Parameters

[in] a_phase Phase 8gas or solid)

◆ getBoxSorting()

BoxSorting AmrMesh::getBoxSorting ( ) const

Get box sorting method.

Returns: Box sorting method.

◆ getEbCf()

bool AmrMesh::getEbCf ( ) const

Check if mesh has an EBCF.

Note: Always returns true, non-EBCF cases are a thing of the past.

◆ getEBIndexSpace()

RefCountedPtr< EBIndexSpace > & AmrMesh::getEBIndexSpace ( const phase::which_phase a_phase )

inline

Get EBIndexSpace corresponding to a particular phase.

Parameters

[in] a_phase Phase (gas/solid)

◆ getEBISLayout()

const Vector< EBISLayout > & AmrMesh::getEBISLayout	(	const std::string	a_realm,
		const phase::which_phase	a_phase
	)		const

Get EBISLayouts for a Realm and phase.

Parameters

[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)

◆ getEBLevelGrid()

const Vector< RefCountedPtr< EBLevelGrid > > & AmrMesh::getEBLevelGrid	(	const std::string	a_realm,
		const phase::which_phase	a_phase
	)		const

Get the EBLevelGrid for a Realm and phase.

Parameters

[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)

◆ getEBLevelGridCoFi()

const Vector< RefCountedPtr< EBLevelGrid > > & AmrMesh::getEBLevelGridCoFi	(	const std::string	a_realm,
		const phase::which_phase	a_phase
	)		const

Get the coarsened fine EBLevelGrid for a Realm and phase.

Parameters

[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)

◆ getFineInterp()

Vector< RefCountedPtr< EBCoarseToFineInterp > > & AmrMesh::getFineInterp	(	const std::string	a_realm,
		const phase::which_phase	a_phase
	)		const

Get interpolator.

Parameters

[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)

◆ getFluxRegister()

Vector< RefCountedPtr< EBReflux > > & AmrMesh::getFluxRegister	(	const std::string	a_realm,
		const phase::which_phase	a_phase
	)		const

Get flux register.

Parameters

[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)

◆ getLevelset()

const EBAMRFAB & AmrMesh::getLevelset	(	const std::string	a_realm,
		const phase::which_phase	a_phase
	)		const

Get levelset function, allocated over a grid for a Realm and phase.

Parameters

[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)

◆ getLevelTiles()

const Vector< RefCountedPtr< LevelTiles > > & AmrMesh::getLevelTiles ( const std::string a_realm ) const

Get the tiled space representation.

Parameters

[in] a_realm Realm name

◆ getMask()

const AMRMask & AmrMesh::getMask	(	const std::string	a_mask,
		const int	a_buffer,
		const std::string	a_realm
	)		const

Get a registered mask.

Parameters

[in]	a_mask	Mask name
[in]	a_buffer	Buffer (used when registering mask)
[in]	a_realm	Realm name

◆ getMFLevelGrid()

const Vector< RefCountedPtr< MFLevelGrid > > & AmrMesh::getMFLevelGrid ( const std::string a_realm ) const

Get EBISLayouts for a Realm.

Parameters

[in] a_realm Realm name

◆ getMultigridInterpolator()

Vector< RefCountedPtr< EBMultigridInterpolator > > & AmrMesh::getMultigridInterpolator	(	const std::string	a_realm,
		const phase::which_phase	a_phase
	)		const

Get multigrid interpolation utility.

Parameters

[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)

◆ getParticleMesh()

EBAMRParticleMesh & AmrMesh::getParticleMesh	(	const std::string	a_realm,
		const phase::which_phase	a_phase
	)		const

Get EBAMRParticleMesh operator.

Parameters

[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)

◆ getProxyGrids()

const Vector< DisjointBoxLayout > & AmrMesh::getProxyGrids ( ) const

Get the "proxy" grids in AmrMesh.

Returns m_grids

◆ getRealms()

std::vector< std::string > AmrMesh::getRealms ( ) const

Get the name of all Realms.

Returns: Names of all Realms

◆ getRedistributionOp()

Vector< RefCountedPtr< EBFluxRedistribution > > & AmrMesh::getRedistributionOp	(	const std::string	a_realm,
		const phase::which_phase	a_phase
	)		const

Get the redistribution operators.

Parameters

[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)

◆ getRefinementRatio()

int AmrMesh::getRefinementRatio	(	const int	a_level1,
		const int	a_level2
	)		const

Get refinement factor between two levels.

Parameters

[in]	a_level1	First level
[in]	a_level2	Second level

This will work correctly in reverse as well.

◆ getSurfaceDeposition()

EBAMRSurfaceDeposition & AmrMesh::getSurfaceDeposition	(	const std::string	a_realm,
		const phase::which_phase	a_phase
	)		const

Get EBAMRSurfaceDeposition surface deposition operator.

Parameters

[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)

◆ getValidCells()

const AMRMask & AmrMesh::getValidCells ( const std::string a_realm ) const

Get a map of all valid cells on a specified realm.

Parameters

[in] a_realm Realm name

◆ getVofIterator()

Vector< RefCountedPtr< LayoutData< VoFIterator > > > & AmrMesh::getVofIterator	(	const std::string	a_realm,
		const phase::which_phase	a_phase
	)		const

Get vof iterators for a Realm and phase. This has the capability of iterating through cut-cells.

Not const because we need to reset the vofiterator

◆ harmonicAverage() [1/6]

void AmrMesh::harmonicAverage	(	EBAMRCellData &	a_data,
		const std::string	a_realm,
		const phase::which_phase	a_phase
	)		const

Harmonic average of data. Does all components.

Parameters

[in,out]	a_data	Data to be coarsened.
[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)

◆ harmonicAverage() [2/6]

void AmrMesh::harmonicAverage	(	EBAMRCellData &	a_data,
		const std::string	a_realm,
		const phase::which_phase	a_phase,
		const Interval &	a_variables
	)		const

Harmonic average of data. Does all components.

Parameters

[in,out]	a_data	Data to be coarsened.
[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)
[in]	a_variables	Variables

◆ harmonicAverage() [3/6]

void AmrMesh::harmonicAverage	(	EBAMRFluxData &	a_data,
		const std::string	a_realm,
		const phase::which_phase	a_phase
	)		const

Average down on specific realm and phase.

This computes an arithmetic average of the face data. Data on coarse faces is replaced by the arithmetic average of the fine face data.

Parameters

[in,out]	a_data	Data to be average.
[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)

◆ harmonicAverage() [4/6]

void AmrMesh::harmonicAverage	(	EBAMRIVData &	a_data,
		const std::string	a_realm,
		const phase::which_phase	a_phase
	)		const

Harmonic average on specific realm and phase.

Parameters

[in,out]	a_data	Data to be coarsened.
[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)

◆ harmonicAverage() [5/6]

void AmrMesh::harmonicAverage	(	MFAMRCellData &	a_data,
		const std::string	a_realm
	)		const

Harmonic coarsening of multifluid data.

Parameters

[in,out]	a_data	Data to be coarsened.
[in]	a_realm	Realm name

◆ harmonicAverage() [6/6]

void AmrMesh::harmonicAverage	(	MFAMRFluxData &	a_data,
		const std::string	a_realm
	)		const

Average multifluid data over a realm.

This computes an arithmetic average of the face data. Data on coarse faces is replaced by the arithmetic average of the fine face data.

Parameters

[in,out]	a_data	Data to be coarsened.
[in]	a_realm	Realm name

◆ interpGhost() [1/3]

void AmrMesh::interpGhost	(	EBAMRCellData &	a_data,
		const std::string	a_realm,
		const phase::which_phase	a_phase
	)		const

Interpolate ghost vectors over a realm, using the default ghost cell interpolation method.

Parameters

[in,out]	a_data	Data to be interpolated.
[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)

◆ interpGhost() [2/3]

void AmrMesh::interpGhost	(	LevelData< EBCellFAB > &	a_fineData,
		const LevelData< EBCellFAB > &	a_coarData,
		const int	a_level,
		const std::string	a_realm,
		const phase::which_phase	a_phase
	)		const

Interpolate ghost cells over a realm, using the default ghost cell interpolation method on a specific level.

Parameters

[in,out]	a_fineData	Fine grid data
[in,out]	a_coarData	Coarse grid data
[in]	a_level	The grid level corresponding to a_fineData
[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)

◆ interpGhost() [3/3]

void AmrMesh::interpGhost	(	MFAMRCellData &	a_data,
		const std::string	a_realm
	)		const

Interpolate ghost cells over a realm. Calls the default ghost cell interpolation method.

Parameters

[in,out]	a_data	Data to be interpolated
[in]	a_realm	Realm name

◆ interpGhostMG() [1/2]

void AmrMesh::interpGhostMG	(	EBAMRCellData &	a_data,
		const std::string	a_realm,
		const phase::which_phase	a_phase
	)		const

Interpolate ghost cells over a realm and phase.

This routine uses the multigrid interpolator, which does not reach into invalid regions. I.e., all ghost cells are interpolated using valid data only.

Parameters

[in,out]	a_data	Data to be interpolated
[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)

◆ interpGhostMG() [2/2]

void AmrMesh::interpGhostMG	(	MFAMRCellData &	a_data,
		const std::string	a_realm
	)		const

Interpolate ghost cells over a realm and phase.

This routine uses the multigrid interpolator, which does not reach into invalid regions. I.e., all ghost cells are interpolated using valid data only.

Parameters

[in,out]	a_data	Data to be interpolated
[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)

◆ interpGhostPwl() [1/2]

void AmrMesh::interpGhostPwl	(	EBAMRCellData &	a_data,
		const std::string	a_realm,
		const phase::which_phase	a_phase
	)		const

Interpolate ghost cells over a realm and phase. This uses piecewise linear interpolation (with limiters)

Parameters

[in,out]	a_data	Data to be interpolated
[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)

◆ interpGhostPwl() [2/2]

void AmrMesh::interpGhostPwl	(	MFAMRCellData &	a_data,
		const std::string	a_realm
	)		const

Interpolate ghost cells over a realm and phase. This uses piecewise linear interpolation (with limiters)

Parameters

[in,out]	a_data	Data to be interpolated
[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)

◆ interpolateParticles()

template<class P , class Ret , Ret(P::*)() MemberFunc>

void AmrMesh::interpolateParticles	(	ParticleContainer< P > &	a_particles,
		const std::string &	a_realm,
		const phase::which_phase &	a_phase,
		const EBAMRCellData &	a_meshScalarField,
		const DepositionType	a_interpType,
		const bool	a_forceIrregNGP = `false`
	)		const

Interpolate mesh data onto a particle position.

P is the particle type, Ret is the returned value of the particle member function, and must be a Real& or a RealVect&. MemFunc is a pointer to a member function of P. E.g., interpolate<P, Real&, &P::weight>.

Parameters

[in,out]	a_particles	Particles to be interpolated.
[in]	a_realm	Realm where data is registered.
[in]	a_phase	Phase where data is registered.
[in]	a_meshScalarField	Scalar field on the mesh
[in]	a_interpType	Interpolation type.
[in]	a_forceIrregNGP	Force NGP interpolation in cut-cells.

◆ interpToCentroids() [1/5]

void AmrMesh::interpToCentroids	(	EBAMRCellData &	a_data,
		const std::string	a_realm,
		const phase::which_phase	a_phase
	)		const

noexcept

Interpolate data to centroids on realm and phase.

Parameters

[in,out]	a_data	Data to be interpolated
[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)

This leaves regular data intact, while the values in irregular are replaced by the corresponding interpolation to centroids.

◆ interpToCentroids() [2/5]

void AmrMesh::interpToCentroids	(	EBAMRIVData &	a_centroidData,
		const EBAMRCellData &	a_cellData,
		const std::string	a_realm,
		const phase::which_phase	a_phase
	)		const

noexcept

Interpolate data to centroids on realm and phase.

Parameters

[out]	a_centroidData	Centroid-centered data
[in]	a_cellData	Cell-centered data to be interpolated
[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)

This leaves regular data intact, while the values in irregular are replaced by the corresponding interpolation to centroids.

◆ interpToCentroids() [3/5]

void AmrMesh::interpToCentroids	(	EBCellFAB &	a_centroidData,
		const EBCellFAB &	a_cellData,
		const std::string	a_realm,
		const phase::which_phase	a_phase,
		const int	a_level,
		const DataIndex &	a_din
	)		const

noexcept

Interpolate data to centroids.

Parameters

[in,out]	a_centroidData	Centroid-centered data
[in]	a_cellData	Cell-centered data
[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)
[in]	a_level	Grid level
[in]	a_din	Grid index

◆ interpToCentroids() [4/5]

void AmrMesh::interpToCentroids	(	LevelData< BaseIVFAB< Real > > &	a_centroidData,
		const LevelData< EBCellFAB > &	a_cellData,
		const std::string	a_realm,
		const phase::which_phase	a_phase,
		const int	a_level
	)		const

noexcept

Interpolate data to centroids.

Parameters

[out]	a_centroidData	Centroid-centered data
[in]	a_cellData	Cell-centered data to be interpolated
[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)
[in]	a_level	Grid level

◆ interpToCentroids() [5/5]

void AmrMesh::interpToCentroids	(	LevelData< EBCellFAB > &	a_data,
		const std::string	a_realm,
		const phase::which_phase	a_phase,
		const int	a_level
	)		const

noexcept

Interpolate data to centroids.

Parameters

[in,out]	a_data	Data to be interpolated
[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)
[in]	a_level	Grid level

◆ interpToEB() [1/3]

void AmrMesh::interpToEB	(	BaseIVFAB< Real > &	a_centroidData,
		const EBCellFAB &	a_cellData,
		const std::string	a_realm,
		const phase::which_phase	a_phase,
		const int	a_level,
		const DataIndex &	a_din
	)		const

noexcept

Interpolate data to EB centroids.

Parameters

[out]	a_centroidData	EB-centered data
[in]	a_cellData	Cell-centered data to be interpolated
[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)
[in]	a_level	Grid level
[in]	a_din	Grid index

◆ interpToEB() [2/3]

void AmrMesh::interpToEB	(	EBAMRIVData &	a_centroidData,
		const EBAMRCellData &	a_cellData,
		const std::string	a_realm,
		const phase::which_phase	a_phase
	)		const

noexcept

Interpolate data to EB centroids on realm and phase.

Parameters

[out]	a_centroidData	EB-centered data
[in]	a_cellData	Cell-centered data to be interpolated
[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)

◆ interpToEB() [3/3]

void AmrMesh::interpToEB	(	LevelData< BaseIVFAB< Real > > &	a_centroidData,
		const LevelData< EBCellFAB > &	a_cellData,
		const std::string	a_realm,
		const phase::which_phase	a_phase,
		const int	a_level
	)		const

noexcept

Interpolate data to EB centroids.

Parameters

[out]	a_centroidData	EB-centered data
[in]	a_cellData	Cell-centered data to be interpolated
[in]	a_realm	Realm name
[in]	a_phase	Phase (gas or solid)
[in]	a_level	Grid level

◆ interpToNewGrids() [1/3]

void AmrMesh::interpToNewGrids	(	EBAMRCellData &	a_newData,
		const EBAMRCellData &	a_oldData,
		const phase::which_phase	a_phase,
		const int	a_lmin,
		const int	a_oldFinestLevel,
		const int	a_newFinestLevel,
		const EBCoarseToFineInterp::Type	a_type
	)

Interpolate data to new grids.

This is called when requiring data to be interpolated to new grids. Takes old data as argument and fills the new grid data with an interpolation of the old grid data.

Parameters

[out]	a_newData	New grid data.
[in]	a_oldData	Old grid data.
[in]	a_phase	Phase on which we regrid.
[in]	a_lmin	Coarsest level that did not change (but distribution may have changed).
[in]	a_oldFinestLevel	Previous finest level.
[in]	a_newFinestLevel	New finest level.
[in]	a_type	Interpolation type

◆ interpToNewGrids() [2/3]

void AmrMesh::interpToNewGrids	(	EBAMRIVData &	a_newData,
		const EBAMRIVData &	a_oldData,
		const phase::which_phase	a_phase,
		const int	a_lmin,
		const int	a_oldFinestLevel,
		const int	a_newFinestLevel,
		const EBCoarseToFineInterp::Type	a_type
	)

Interpolate data to new grids.

This is called when requiring data to be interpolated to new grids. Takes old data as argument and fills the new grid data with an interpolation of the old grid data.

Parameters

[out]	a_newData	New grid data.
[in]	a_oldData	Old grid data.
[in]	a_phase	Phase on which we regrid.
[in]	a_lmin	Coarsest level that did not change (but distribution may have changed).
[in]	a_oldFinestLevel	Previous finest level.
[in]	a_newFinestLevel	New finest level.
[in]	a_type	Interpolation type

◆ interpToNewGrids() [3/3]

void AmrMesh::interpToNewGrids	(	MFAMRCellData &	a_newData,
		const MFAMRCellData &	a_oldData,
		const int	a_lmin,
		const int	a_oldFinestLevel,
		const int	a_newFinestLevel,
		const EBCoarseToFineInterp::Type	a_type
	)

Interpolate data to new grids.

This is called when requiring data to be interpolated to new grids. Takes old data as argument and fills the new grid data with an interpolation of the old grid data.

Parameters

[out]	a_newData	New grid data.
[in]	a_oldData	Old grid data.
[in]	a_lmin	Coarsest level that did not change (but distribution may have changed).
[in]	a_oldFinestLevel	Previous finest level.
[in]	a_newFinestLevel	New finest level.
[in]	a_type	Interpolation type

◆ intersectParticlesBisectIF()

template<class P >

void AmrMesh::intersectParticlesBisectIF	(	ParticleContainer< P > &	a_activeParticles,
		ParticleContainer< P > &	a_ebParticles,
		ParticleContainer< P > &	a_domainParticles,
		const phase::which_phase	a_phase,
		const Real	a_bisectionStep,
		const bool	a_deleteParticles,
		const std::function< void(P &)>	a_nonDeletionModifier = `[](P&) -> void { return; }`
	)		const

noexcept

Particle intersection algorithm based on bisection.

This routine will iterate through all the particles and check if they intersect the geometry. The template parameter indicates the particle type – it MUST have const RealVec& position() const and const RealVect& oldPosition() const functions that determine the start and stop position of the particle trajectory. This routine uses a bisection method to check for intersections with the EB (the domain side is much easier). Their position are updated and they are placed in the a_ebParticles argument.

Parameters

[in,out]	a_activeParticles	Particles to be intersected with geometry
[out]	a_ebParticles	Particles that intersected with the EB
[out]	a_domainParticles	Particles that intersected with the domain faces
[in]	a_phase	Phase where the input particles live
[in]	a_bisectionStep	Length of the bisection step
[in]	a_deleteParticles	If true, particles will be removed from a_activeParticles if they intersect the geometry.
[in]	a_nonDeletionModifier	Optional input argument for letting the user manipulate particles that were intersected but not deleted

◆ intersectParticlesRaycastIF()

template<class P >

void AmrMesh::intersectParticlesRaycastIF	(	ParticleContainer< P > &	a_activeParticles,
		ParticleContainer< P > &	a_ebParticles,
		ParticleContainer< P > &	a_domainParticles,
		const phase::which_phase	a_phase,
		const Real	a_tolerance,
		const bool	a_deleteParticles,
		const std::function< void(P &)>	a_nonDeletionModifier = `[](P&) -> void { return; }`
	)		const

noexcept

Particle intersection algorithm based on ray-casting.

This routine will iterate through all the particles and check if they intersect the geometry. The template parameter indicates the particle type – it MUST have const RealVec& position() const and const RealVect& oldPosition() const functions that determine the start and stop position of the particle trajectory. This routine uses a ray-casting method to check for intersections with the EB (the domain side is much easier). If the particles are closer to the EB than a_tolerance, they are absorbed and placed on the EB. Their position are updated and they are placed in the a_ebParticles argument. This routine uses a ray-casting method where it computes the distance from the EB (assuming that the implicit function is a signed distance function). Particles are then moved that distance along their trajectory and we then update the new distance to the EB. This is done recursively until the particles have either moved the entire length or been absorbed by the EB or domain side.

Parameters

[in,out]	a_activeParticles	Particles to be intersected with geometry
[out]	a_ebParticles	Particles that intersected with the EB
[out]	a_domainParticles	Particles that intersected with the domain faces
[in]	a_phase	Phase where the input particles live
[in]	a_bisectionStep	Length of the bisection step
[in]	a_deleteParticles	If true, particles will be removed from a_activeParticles if they intersect the geometry.
[in]	a_nonDeletionModifier	Optional input argument for letting the user manipulate particles that were intersected but not deleted

◆ nonConservativeDivergence() [1/2]

void AmrMesh::nonConservativeDivergence	(	EBAMRIVData &	a_nonConsDivF,
		const EBAMRCellData &	a_kappaDivF,
		const std::string &	a_realm,
		const phase::which_phase &	a_phase
	)		const

noexcept

Compute a non-conservative divergence.

This computes divNC(F) = sum(kappa*divC(F))/sum(kappa), where kappa*divC(F) is the finite-volume approximation to kappa*div(F) = int_A F*dA (and dA is in grid units, not physical units).

Parameters

[out]	a_nonConsDivF	The non-conservative divergence.
[in]	a_kappaDivF	Conservative divergence, not weighted by kappa.
[in]	a_realm	Realm where the data lives.
[in]	a_phase	Phase where the data lives.

◆ nonConservativeDivergence() [2/2]

void AmrMesh::nonConservativeDivergence	(	LevelData< BaseIVFAB< Real > > &	a_nonConsDivF,
		const LevelData< EBCellFAB > &	a_kappaDivF,
		const int &	a_level,
		const std::string &	a_realm,
		const phase::which_phase &	a_phase
	)		const

noexcept

Compute a non-conservative divergence.

This computes divNC(F) = sum(kappa*divC(F))/sum(kappa), where kappa*divC(F) is the finite-volume approximation to kappa*div(F) = int_A F*dA (and dA is in grid units, not physical units).

Parameters

[out]	a_nonConsDivF	The non-conservative divergence.
[in]	a_level	Grid level
[in]	a_kappaDivF	Conservative divergence, not weighted by kappa.
[in]	a_realm	Realm where the data lives.
[in]	a_phase	Phase where the data lives.

◆ operator=() [1/2]

AmrMesh & AmrMesh::operator= ( const AmrMesh && a_other )

delete

Disallowed move assignment.

Parameters

[in] a_other Other AmrMesh

◆ operator=() [2/2]

AmrMesh & AmrMesh::operator= ( const AmrMesh & a_other )

delete

Disallowed copy assignment.

Parameters

[in] a_other Other AmrMesh

◆ parseEbGhostCells()

void AmrMesh::parseEbGhostCells ( )

protected

Parse number of ghost cells for eb stuff.

Only matters for the grid generation step.

◆ parseMaxEbisBoxSize()

void AmrMesh::parseMaxEbisBoxSize ( )

protected

Parse the maximum permitted box size.

Only relevant for the grid generation step.

◆ parseRuntimeOptions()

void AmrMesh::parseRuntimeOptions ( )

Parse runtime options.

Note: Called by Driver as simulations progress.

◆ queryRealm()

bool AmrMesh::queryRealm ( const std::string a_realm ) const

Query if a realm exists.

Parameters

[in] a_realm Name of the realm.

Returns: True if the realm exists and false otherwise.

◆ reallocate() [1/8]

void AmrMesh::reallocate	(	EBAMRBool &	a_data,
		const int	a_lmin
	)		const

Reallocate data.

Parameters

[out]	a_data	Data to be reallocated
[in]	a_lmin	The lowest grid level that will be reallocated.