#include <AMReX_EB2_Level.H>

Inheritance diagram for amrex::EB2::Level:

Public Member Functions
bool	isAllRegular () const noexcept

bool	isOK () const noexcept

void	fillEBCellFlag (FabArray< EBCellFlagFab > &cellflag, const Geometry &geom) const
	Fill `cellflag` with EBCellFlag data using geometry `geom`.

void	fillVolFrac (MultiFab &vfrac, const Geometry &geom) const
	Populate volume fractions into `vfrac` using `geom`.

void	fillCentroid (MultiCutFab &centroid, const Geometry &geom) const
	Populate cut-cell centroids into a MultiCutFab.

void	fillCentroid (MultiFab &centroid, const Geometry &geom) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void	fillBndryArea (MultiCutFab &bndryarea, const Geometry &geom) const
	Populate boundary-face areas into `bndryarea`.

void	fillBndryArea (MultiFab &bndryarea, const Geometry &geom) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void	fillBndryCent (MultiCutFab &bndrycent, const Geometry &geom) const
	Populate boundary centroids into `bndrycent`.

void	fillBndryCent (MultiFab &bndrycent, const Geometry &geom) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void	fillBndryNorm (MultiCutFab &bndrynorm, const Geometry &geom) const
	Populate boundary normals into `bndrynorm`.

void	fillBndryNorm (MultiFab &bndrynorm, const Geometry &geom) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void	fillAreaFrac (Array< MultiCutFab *, 3 > const &areafrac, const Geometry &geom) const
	Populate face area fractions for each direction.

void	fillAreaFrac (Array< MultiFab *, 3 > const &areafrac, const Geometry &geom) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void	fillFaceCent (Array< MultiCutFab *, 3 > const &facecent, const Geometry &geom) const
	Populate face centroids for each direction.

void	fillFaceCent (Array< MultiFab *, 3 > const &facecent, const Geometry &geom) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void	fillEdgeCent (Array< MultiCutFab *, 3 > const &edgecent, const Geometry &geom) const
	Populate edge centroids for each direction.

void	fillEdgeCent (Array< MultiFab *, 3 > const &edgecent, const Geometry &geom) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void	fillLevelSet (MultiFab &levelset, const Geometry &geom) const
	Write the implicit function values into `levelset`.

const BoxArray &	boxArray () const noexcept

const DistributionMapping &	DistributionMap () const noexcept

	Level (IndexSpace const *is, const Geometry &geom)
	Construct a Level bound to EB index space `is` and Geometry `geom`.

void	prepareForCoarsening (const Level &rhs, int max_grid_size, IntVect const &ngrow)
	Prepare for coarsening by copying from `rhs`, respecting max grid size and grow vector.

const Geometry &	Geom () const noexcept

IndexSpace const *	getEBIndexSpace () const noexcept

IntVect const &	nGrowVect () const noexcept

void	write_to_chkpt_file (const std::string &fname, bool extend_domain_face, int max_grid_size) const
	Write this level’s EB data to a checkpoint file `fname`.

bool	hasEBInfo () const noexcept

void	fillCutCellMask (iMultiFab &cutcellmask, const Geometry &geom) const
	Populate the cut-cell mask into `cutcellmask`.

void	setShift (int direction, int ncells)
	Shift this level by `ncells` cells along direction `direction` (for periodic tiling).

int	coarsenFromFine (Level &fineLevel, bool fill_boundary)
	Coarsen EB data from `fineLevel` into this level.

void	buildCellFlag ()
	Build EBCellFlag data from the current implicit function field.

void	buildCutCellMask (Level const &fine_level)
	Build the cut-cell mask by coarsening from `fine_level`.

Protected Attributes
Geometry	m_geom

IntVect	m_ngrow

BoxArray	m_grids

BoxArray	m_covered_grids

DistributionMapping	m_dmap

MultiFab	m_sdf

std::map< int, std::unique_ptr< MC::MCFab > >	m_marching_cubes

MultiGFab	m_mgf

MultiFab	m_levelset

FabArray< EBCellFlagFab >	m_cellflag

MultiFab	m_volfrac

MultiFab	m_centroid

MultiFab	m_bndryarea

MultiFab	m_bndrycent

MultiFab	m_bndrynorm

Array< MultiFab, 3 >	m_areafrac

Array< MultiFab, 3 >	m_facecent

Array< MultiFab, 3 >	m_edgecent

iMultiFab	m_cutcellmask

bool	m_allregular = false

bool	m_ok = false

bool	m_has_eb_info = true

IntVect	m_shift {0}

IndexSpace const *	m_parent

Friends
template<typename G >
class	GShopLevel

Constructor & Destructor Documentation

◆ Level()

amrex::EB2::Level::Level	(	IndexSpace const *	is,
		const Geometry &	geom
	)

inline

Construct a Level bound to EB index space is and Geometry geom.

Member Function Documentation

◆ boxArray()

const BoxArray & amrex::EB2::Level::boxArray ( ) const

inlinenoexcept

Returns: Grid layout associated with this level.

◆ buildCellFlag()

void amrex::EB2::Level::buildCellFlag ( )

Build EBCellFlag data from the current implicit function field.

◆ buildCutCellMask()

void amrex::EB2::Level::buildCutCellMask ( Level const & fine_level )

Build the cut-cell mask by coarsening from fine_level.

◆ coarsenFromFine()

int amrex::EB2::Level::coarsenFromFine	(	Level &	fineLevel,
		bool	fill_boundary
	)

Coarsen EB data from fineLevel into this level.

Parameters

fineLevel	Source level.
fill_boundary	Whether to fill boundary data after coarsening.

Returns: 0 on success.

◆ DistributionMap()

const DistributionMapping & amrex::EB2::Level::DistributionMap ( ) const

inlinenoexcept

Returns: Distribution mapping describing how grids are assigned to ranks.

◆ fillAreaFrac() [1/2]

void amrex::EB2::Level::fillAreaFrac	(	Array< MultiCutFab *, 3 > const &	areafrac,
		const Geometry &	geom
	)		const

Populate face area fractions for each direction.

◆ fillAreaFrac() [2/2]

void amrex::EB2::Level::fillAreaFrac	(	Array< MultiFab *, 3 > const &	areafrac,
		const Geometry &	geom
	)		const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ fillBndryArea() [1/2]

void amrex::EB2::Level::fillBndryArea	(	MultiCutFab &	bndryarea,
		const Geometry &	geom
	)		const

Populate boundary-face areas into bndryarea.

◆ fillBndryArea() [2/2]

void amrex::EB2::Level::fillBndryArea	(	MultiFab &	bndryarea,
		const Geometry &	geom
	)		const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ fillBndryCent() [1/2]

void amrex::EB2::Level::fillBndryCent	(	MultiCutFab &	bndrycent,
		const Geometry &	geom
	)		const

Populate boundary centroids into bndrycent.

◆ fillBndryCent() [2/2]

void amrex::EB2::Level::fillBndryCent	(	MultiFab &	bndrycent,
		const Geometry &	geom
	)		const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ fillBndryNorm() [1/2]

void amrex::EB2::Level::fillBndryNorm	(	MultiCutFab &	bndrynorm,
		const Geometry &	geom
	)		const

Populate boundary normals into bndrynorm.

◆ fillBndryNorm() [2/2]

void amrex::EB2::Level::fillBndryNorm	(	MultiFab &	bndrynorm,
		const Geometry &	geom
	)		const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ fillCentroid() [1/2]

void amrex::EB2::Level::fillCentroid	(	MultiCutFab &	centroid,
		const Geometry &	geom
	)		const

Populate cut-cell centroids into a MultiCutFab.

◆ fillCentroid() [2/2]

void amrex::EB2::Level::fillCentroid	(	MultiFab &	centroid,
		const Geometry &	geom
	)		const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ fillCutCellMask()

void amrex::EB2::Level::fillCutCellMask	(	iMultiFab &	cutcellmask,
		const Geometry &	geom
	)		const

Populate the cut-cell mask into cutcellmask.

◆ fillEBCellFlag()

void amrex::EB2::Level::fillEBCellFlag	(	FabArray< EBCellFlagFab > &	cellflag,
		const Geometry &	geom
	)		const

Fill cellflag with EBCellFlag data using geometry geom.

Parameters

cellflag	Destination flag array.
geom	Geometry describing the sampling box.

◆ fillEdgeCent() [1/2]

void amrex::EB2::Level::fillEdgeCent	(	Array< MultiCutFab *, 3 > const &	edgecent,
		const Geometry &	geom
	)		const

Populate edge centroids for each direction.

◆ fillEdgeCent() [2/2]

void amrex::EB2::Level::fillEdgeCent	(	Array< MultiFab *, 3 > const &	edgecent,
		const Geometry &	geom
	)		const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ fillFaceCent() [1/2]

void amrex::EB2::Level::fillFaceCent	(	Array< MultiCutFab *, 3 > const &	facecent,
		const Geometry &	geom
	)		const

Populate face centroids for each direction.

◆ fillFaceCent() [2/2]

void amrex::EB2::Level::fillFaceCent	(	Array< MultiFab *, 3 > const &	facecent,
		const Geometry &	geom
	)		const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ fillLevelSet()

void amrex::EB2::Level::fillLevelSet	(	MultiFab &	levelset,
		const Geometry &	geom
	)		const

Write the implicit function values into levelset.

◆ fillVolFrac()

void amrex::EB2::Level::fillVolFrac	(	MultiFab &	vfrac,
		const Geometry &	geom
	)		const

Populate volume fractions into vfrac using geom.

◆ Geom()

const Geometry & amrex::EB2::Level::Geom ( ) const

inlinenoexcept

Returns: Reference to the level Geometry.

◆ getEBIndexSpace()

IndexSpace const * amrex::EB2::Level::getEBIndexSpace ( ) const

inlinenoexcept

Returns: Pointer to the EB IndexSpace.

◆ hasEBInfo()

bool amrex::EB2::Level::hasEBInfo ( ) const

inlinenoexcept

Returns: True if EB data (flags, area fractions, etc.) are available.

◆ isAllRegular()

bool amrex::EB2::Level::isAllRegular ( ) const

inlinenoexcept

Returns: True if every cell in this level is regular (no cut cells).

◆ isOK()

bool amrex::EB2::Level::isOK ( ) const

inlinenoexcept

Returns: True if the level successfully built its EB description.

◆ nGrowVect()

IntVect const & amrex::EB2::Level::nGrowVect ( ) const

inlinenoexcept

Returns: EB grow-vector.

◆ prepareForCoarsening()

void amrex::EB2::Level::prepareForCoarsening	(	const Level &	rhs,
		int	max_grid_size,
		IntVect const &	ngrow
	)

Prepare for coarsening by copying from rhs, respecting max grid size and grow vector.

◆ setShift()

void amrex::EB2::Level::setShift	(	int	direction,
		int	ncells
	)

Shift this level by ncells cells along direction direction (for periodic tiling).

◆ write_to_chkpt_file()

void amrex::EB2::Level::write_to_chkpt_file	(	const std::string &	fname,
		bool	extend_domain_face,
		int	max_grid_size
	)		const

Write this level’s EB data to a checkpoint file fname.

Parameters

fname	Target checkpoint file name.
extend_domain_face	Whether domain faces were extended.
max_grid_size	Grid blocking factor used during build.

Friends And Related Symbol Documentation

◆ GShopLevel

template<typename G >

friend class GShopLevel

friend

Member Data Documentation

◆ m_allregular

bool amrex::EB2::Level::m_allregular = false

protected

◆ m_areafrac

Array<MultiFab,3> amrex::EB2::Level::m_areafrac

protected

◆ m_bndryarea

MultiFab amrex::EB2::Level::m_bndryarea

protected

◆ m_bndrycent

MultiFab amrex::EB2::Level::m_bndrycent

protected

◆ m_bndrynorm

MultiFab amrex::EB2::Level::m_bndrynorm

protected

◆ m_cellflag

FabArray<EBCellFlagFab> amrex::EB2::Level::m_cellflag

protected

◆ m_centroid

MultiFab amrex::EB2::Level::m_centroid

protected

◆ m_covered_grids

BoxArray amrex::EB2::Level::m_covered_grids

protected

◆ m_cutcellmask

iMultiFab amrex::EB2::Level::m_cutcellmask

protected

◆ m_dmap

DistributionMapping amrex::EB2::Level::m_dmap

protected

◆ m_edgecent

Array<MultiFab,3> amrex::EB2::Level::m_edgecent

protected

◆ m_facecent

Array<MultiFab,3> amrex::EB2::Level::m_facecent

protected

◆ m_geom

Geometry amrex::EB2::Level::m_geom

protected

◆ m_grids

BoxArray amrex::EB2::Level::m_grids

protected

◆ m_has_eb_info

bool amrex::EB2::Level::m_has_eb_info = true

protected

◆ m_levelset

MultiFab amrex::EB2::Level::m_levelset

protected

◆ m_marching_cubes

std::map<int,std::unique_ptr<MC::MCFab> > amrex::EB2::Level::m_marching_cubes

protected

◆ m_mgf

MultiGFab amrex::EB2::Level::m_mgf

protected

◆ m_ngrow

IntVect amrex::EB2::Level::m_ngrow

protected

◆ m_ok

bool amrex::EB2::Level::m_ok = false

protected

◆ m_parent

IndexSpace const* amrex::EB2::Level::m_parent

protected

◆ m_sdf

MultiFab amrex::EB2::Level::m_sdf

protected

◆ m_shift

IntVect amrex::EB2::Level::m_shift {0}

protected

◆ m_volfrac

MultiFab amrex::EB2::Level::m_volfrac

protected

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

/home/runner/work/amrex/amrex/Src/EB/AMReX_EB2_Level.H
/home/runner/work/amrex/amrex/Src/EB/AMReX_EB2_Level.cpp

Public Member Functions

Protected Attributes

Friends

Constructor & Destructor Documentation

◆ Level()

Member Function Documentation

◆ boxArray()

◆ buildCellFlag()

◆ buildCutCellMask()

◆ coarsenFromFine()

◆ DistributionMap()

◆ fillAreaFrac() [1/2]

◆ fillAreaFrac() [2/2]

◆ fillBndryArea() [1/2]

◆ fillBndryArea() [2/2]

◆ fillBndryCent() [1/2]

◆ fillBndryCent() [2/2]

◆ fillBndryNorm() [1/2]

◆ fillBndryNorm() [2/2]

◆ fillCentroid() [1/2]

◆ fillCentroid() [2/2]

◆ fillCutCellMask()

◆ fillEBCellFlag()

◆ fillEdgeCent() [1/2]

◆ fillEdgeCent() [2/2]

◆ fillFaceCent() [1/2]

◆ fillFaceCent() [2/2]

◆ fillLevelSet()

◆ fillVolFrac()

◆ Geom()

◆ getEBIndexSpace()

◆ hasEBInfo()

◆ isAllRegular()

◆ isOK()

◆ nGrowVect()

◆ prepareForCoarsening()

◆ setShift()

◆ write_to_chkpt_file()

Friends And Related Symbol Documentation

◆ GShopLevel

Member Data Documentation

◆ m_allregular

◆ m_areafrac

◆ m_bndryarea

◆ m_bndrycent

◆ m_bndrynorm

◆ m_cellflag

◆ m_centroid

◆ m_covered_grids

◆ m_cutcellmask

◆ m_dmap

◆ m_edgecent

◆ m_facecent

◆ m_geom

◆ m_grids

◆ m_has_eb_info

◆ m_levelset

◆ m_marching_cubes

◆ m_mgf

◆ m_ngrow

◆ m_ok

◆ m_parent

◆ m_sdf

◆ m_shift

◆ m_volfrac