#include <AMReX_AmrParGDB.H>

Inheritance diagram for amrex::AmrParGDB:

Public Member Functions
	AmrParGDB (AmrCore *amr) noexcept
	Construct a AmrParGDB connected to `amr`.

const Geometry &	ParticleGeom (int level) const override
	Return particle geometry on level `level` (could be different from mesh geometry).

const Geometry &	Geom (int level) const override
	Return the mesh geometry (always the same as AmrCore::Geom()) for level `level`.

const Vector< Geometry > &	ParticleGeom () const override
	Return all particle geometries.

const Vector< Geometry > &	Geom () const override
	Return all mesh geometries from the underlying AmrCore.

const DistributionMapping &	ParticleDistributionMap (int level) const override
	Return the particle DistributionMapping for level `level` (could be different from mesh DistributionMapping).

const DistributionMapping &	DistributionMap (int level) const override
	Return the mesh DistributionMapping for level `level`.

const Vector< DistributionMapping > &	ParticleDistributionMap () const override
	Return particle DistributionMappings for all levels.

const Vector< DistributionMapping > &	DistributionMap () const override
	Return mesh DistributionMappings for all levels.

const BoxArray &	ParticleBoxArray (int level) const override
	Return particle BoxArray for level `level` (could be different from mesh BoxArray).

const BoxArray &	boxArray (int level) const override
	Return mesh BoxArray for level `level`.

const Vector< BoxArray > &	ParticleBoxArray () const override
	Return particle BoxArrays for all levels.

const Vector< BoxArray > &	boxArray () const override
	Return mesh BoxArrays for all levels.

void	SetParticleBoxArray (int level, const BoxArray &new_ba) override
	Set a particle BoxArray for level `level`.

void	SetParticleDistributionMap (int level, const DistributionMapping &new_dm) override
	Set a particle DistributionMapping for level `level`.

void	SetParticleGeometry (int level, const Geometry &new_geom) override
	Set a particle Geometry for level `level`.

void	ClearParticleBoxArray (int level) override
	Clear the cached particle BoxArray on level `level`.

void	ClearParticleDistributionMap (int level) override
	Clear the cached particle DistributionMapping on level `level`.

void	ClearParticleGeometry (int level) override
	Clear the cached particle Geometry on level `level`.

bool	LevelDefined (int level) const override
	Return true if level `level` has been defined.

int	finestLevel () const override
	Return the current finest level known to the owning AmrCore.

int	maxLevel () const override
	Return the maximum level configured on the owning AmrCore.

IntVect	refRatio (int level) const override
	Return the refinement ratio vector for level `level`.

int	MaxRefRatio (int level) const override
	Return the maximum scalar refinement ratio encountered up to level `level`.

Vector< IntVect >	refRatio () const override
	Return the refinement ratios for all levels.

Public Member Functions inherited from amrex::ParGDBBase
	ParGDBBase () noexcept=default

virtual	~ParGDBBase ()=default

	ParGDBBase (ParGDBBase const &) noexcept=default

	ParGDBBase (ParGDBBase &&) noexcept=default

ParGDBBase &	operator= (ParGDBBase const &) noexcept=default

ParGDBBase &	operator= (ParGDBBase &&) noexcept=default

template<class MF >
bool	OnSameGrids (int level, const MF &mf) const

Protected Attributes
AmrCore *	m_amrcore

Vector< Geometry >	m_geom

Vector< int >	m_has_geom

Vector< DistributionMapping >	m_dmap

Vector< BoxArray >	m_ba

Constructor & Destructor Documentation

◆ AmrParGDB()

amrex::AmrParGDB::AmrParGDB ( AmrCore * amr )

inlineexplicitnoexcept

Construct a AmrParGDB connected to amr.

Parameters

amr	Owning AmrCore (used to fetch default metadata).

Member Function Documentation

◆ boxArray() [1/2]

const Vector< BoxArray > & amrex::AmrParGDB::boxArray ( ) const

inlineoverridevirtual

Return mesh BoxArrays for all levels.

Implements amrex::ParGDBBase.

◆ boxArray() [2/2]

const BoxArray & amrex::AmrParGDB::boxArray ( int level ) const

inlineoverridevirtual

Return mesh BoxArray for level level.

Implements amrex::ParGDBBase.

◆ ClearParticleBoxArray()

void amrex::AmrParGDB::ClearParticleBoxArray ( int level )

inlineoverridevirtual

Clear the cached particle BoxArray on level level.

Implements amrex::ParGDBBase.

◆ ClearParticleDistributionMap()

void amrex::AmrParGDB::ClearParticleDistributionMap ( int level )

inlineoverridevirtual

Clear the cached particle DistributionMapping on level level.

Implements amrex::ParGDBBase.

◆ ClearParticleGeometry()

void amrex::AmrParGDB::ClearParticleGeometry ( int level )

inlineoverridevirtual

Clear the cached particle Geometry on level level.

Implements amrex::ParGDBBase.

◆ DistributionMap() [1/2]

const Vector< DistributionMapping > & amrex::AmrParGDB::DistributionMap ( ) const

inlineoverridevirtual

Return mesh DistributionMappings for all levels.

Implements amrex::ParGDBBase.

◆ DistributionMap() [2/2]

const DistributionMapping & amrex::AmrParGDB::DistributionMap ( int level ) const

inlineoverridevirtual

Return the mesh DistributionMapping for level level.

Implements amrex::ParGDBBase.

◆ finestLevel()

int amrex::AmrParGDB::finestLevel ( ) const

inlineoverridevirtual

Return the current finest level known to the owning AmrCore.

Implements amrex::ParGDBBase.

◆ Geom() [1/2]

const Vector< Geometry > & amrex::AmrParGDB::Geom ( ) const

inlineoverridevirtual

Return all mesh geometries from the underlying AmrCore.

Implements amrex::ParGDBBase.

◆ Geom() [2/2]

const Geometry & amrex::AmrParGDB::Geom ( int level ) const

inlineoverridevirtual

Return the mesh geometry (always the same as AmrCore::Geom()) for level level.

Implements amrex::ParGDBBase.

◆ LevelDefined()

bool amrex::AmrParGDB::LevelDefined ( int level ) const

inlineoverridevirtual

Return true if level level has been defined.

Implements amrex::ParGDBBase.

◆ maxLevel()

int amrex::AmrParGDB::maxLevel ( ) const

inlineoverridevirtual

Return the maximum level configured on the owning AmrCore.

Implements amrex::ParGDBBase.

◆ MaxRefRatio()

int amrex::AmrParGDB::MaxRefRatio ( int level ) const

inlineoverridevirtual

Return the maximum scalar refinement ratio encountered up to level level.

Implements amrex::ParGDBBase.

◆ ParticleBoxArray() [1/2]

const Vector< BoxArray > & amrex::AmrParGDB::ParticleBoxArray ( ) const

inlineoverridevirtual

Return particle BoxArrays for all levels.

Implements amrex::ParGDBBase.

◆ ParticleBoxArray() [2/2]

const BoxArray & amrex::AmrParGDB::ParticleBoxArray ( int level ) const

inlineoverridevirtual

Return particle BoxArray for level level (could be different from mesh BoxArray).

Implements amrex::ParGDBBase.

◆ ParticleDistributionMap() [1/2]

const Vector< DistributionMapping > & amrex::AmrParGDB::ParticleDistributionMap ( ) const

inlineoverridevirtual

Return particle DistributionMappings for all levels.

Implements amrex::ParGDBBase.

◆ ParticleDistributionMap() [2/2]

const DistributionMapping & amrex::AmrParGDB::ParticleDistributionMap ( int level ) const

inlineoverridevirtual

Return the particle DistributionMapping for level level (could be different from mesh DistributionMapping).

Implements amrex::ParGDBBase.

◆ ParticleGeom() [1/2]

const Vector< Geometry > & amrex::AmrParGDB::ParticleGeom ( ) const

inlineoverridevirtual

Return all particle geometries.

Implements amrex::ParGDBBase.

◆ ParticleGeom() [2/2]

const Geometry & amrex::AmrParGDB::ParticleGeom ( int level ) const

inlineoverridevirtual

Return particle geometry on level level (could be different from mesh geometry).

Implements amrex::ParGDBBase.

◆ refRatio() [1/2]

Vector< IntVect > amrex::AmrParGDB::refRatio ( ) const

inlineoverridevirtual

Return the refinement ratios for all levels.

Implements amrex::ParGDBBase.

◆ refRatio() [2/2]

IntVect amrex::AmrParGDB::refRatio ( int level ) const

inlineoverridevirtual

Return the refinement ratio vector for level level.

Implements amrex::ParGDBBase.

◆ SetParticleBoxArray()

void amrex::AmrParGDB::SetParticleBoxArray	(	int	level,
		const BoxArray &	new_ba
	)

inlineoverridevirtual

Set a particle BoxArray for level level.

Implements amrex::ParGDBBase.

◆ SetParticleDistributionMap()

void amrex::AmrParGDB::SetParticleDistributionMap	(	int	level,
		const DistributionMapping &	new_dm
	)

inlineoverridevirtual

Set a particle DistributionMapping for level level.

Implements amrex::ParGDBBase.

◆ SetParticleGeometry()

void amrex::AmrParGDB::SetParticleGeometry	(	int	level,
		const Geometry &	new_geom
	)

inlineoverridevirtual

Set a particle Geometry for level level.

Implements amrex::ParGDBBase.

Member Data Documentation

◆ m_amrcore

AmrCore* amrex::AmrParGDB::m_amrcore

protected

◆ m_ba

Vector<BoxArray> amrex::AmrParGDB::m_ba

protected

◆ m_dmap

Vector<DistributionMapping> amrex::AmrParGDB::m_dmap

protected

◆ m_geom

Vector<Geometry> amrex::AmrParGDB::m_geom

protected

◆ m_has_geom

Vector<int> amrex::AmrParGDB::m_has_geom

protected

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

/home/runner/work/amrex/amrex/Src/AmrCore/AMReX_AmrParGDB.H

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ AmrParGDB()

Member Function Documentation

◆ boxArray() [1/2]

◆ boxArray() [2/2]

◆ ClearParticleBoxArray()

◆ ClearParticleDistributionMap()

◆ ClearParticleGeometry()

◆ DistributionMap() [1/2]

◆ DistributionMap() [2/2]

◆ finestLevel()

◆ Geom() [1/2]

◆ Geom() [2/2]

◆ LevelDefined()

◆ maxLevel()

◆ MaxRefRatio()

◆ ParticleBoxArray() [1/2]

◆ ParticleBoxArray() [2/2]

◆ ParticleDistributionMap() [1/2]

◆ ParticleDistributionMap() [2/2]

◆ ParticleGeom() [1/2]

◆ ParticleGeom() [2/2]

◆ refRatio() [1/2]

◆ refRatio() [2/2]

◆ SetParticleBoxArray()

◆ SetParticleDistributionMap()

◆ SetParticleGeometry()

Member Data Documentation

◆ m_amrcore

◆ m_ba

◆ m_dmap

◆ m_geom

◆ m_has_geom