Rectangular problem domain geometry. More...

#include <AMReX_Geometry.H>

Inheritance diagram for amrex::Geometry:

Public Member Functions
	Geometry () noexcept
	Construct a copy of the default Geometry, if one is available.

	Geometry (const Box &dom, const RealBox rb=nullptr, int coord=-1, int const is_per=nullptr)
	Construct a Geometry for the specified index-space domain.

	Geometry (const Box &dom, const RealBox &rb, int coord, Array< int, 3 > const &is_per)
	Construct a Geometry with explicitly supplied physical bounds and periodicity.

	~Geometry ()=default

	Geometry (const Geometry &rhs)=default

	Geometry (Geometry &&rhs) noexcept=default

Geometry &	operator= (const Geometry &rhs)=default

Geometry &	operator= (Geometry &&rhs) noexcept=default

GeometryData	data () const noexcept
	Return a GPU-safe snapshot of the Geometry data.

void	define (const Box &dom, const RealBox rb=nullptr, int coord=-1, int const is_per=nullptr)
	Define this Geometry for the specified index-space domain.

void	define (const Box &dom, const RealBox &rb, int coord, Array< int, 3 > const &is_per)
	Define this Geometry with explicitly supplied physical bounds and periodicity.

const RealBox &	ProbDomain () const noexcept
	Returns the problem domain.

void	ProbDomain (const RealBox &rb)
	Sets the problem domain.

const Real *	ProbLo () const noexcept
	Returns the lo end of the problem domain in each dimension.

const Real *	ProbHi () const noexcept
	Returns the hi end of the problem domain in each dimension.

Real	ProbLo (int dir) const noexcept
	Returns the lo end of the problem domain in specified direction.

Real	ProbHi (int dir) const noexcept
	Returns the hi end of the problem domain in specified direction.

GpuArray< Real, 3 >	ProbLoArray () const noexcept
	Return the lo end of the problem domain in a GpuArray for device code.

GpuArray< Real, 3 >	ProbHiArray () const noexcept
	Return the hi end of the problem domain in a GpuArray for device code.

GpuArray< ParticleReal, 3 >	ProbLoArrayInParticleReal () const noexcept
	Return the lo end of the roundoff domain in ParticleReal precision.

GpuArray< ParticleReal, 3 >	ProbHiArrayInParticleReal () const noexcept
	Return the hi end of the roundoff domain in ParticleReal precision.

Real	ProbSize () const noexcept
	Returns the overall size of the domain by multiplying the ProbLength's together.

Real	ProbLength (int dir) const noexcept
	Returns length of problem domain in specified dimension.

const Box &	Domain () const noexcept
	Returns our rectangular domain.

void	Domain (const Box &bx)
	Sets our rectangular domain.

void	GetVolume (MultiFab &vol, const BoxArray &grds, const DistributionMapping &dm, int grow) const
	Define `vol` on `grds` with `dm` and fill it with cell volumes.

void	GetVolume (MultiFab &vol) const
	Fill all valid and ghost cells of the pre-defined `vol` with cell volumes.

void	GetVolume (FArrayBox &vol, const BoxArray &grds, int idx, int grow) const
	Resize `vol` to one component on entry `idx` of `grds` grown by `grow` in every direction, and fill it with cell volumes.

void	GetDLogA (MultiFab &dloga, const BoxArray &grds, const DistributionMapping &dm, int dir, int grow) const
	Define `dloga` on `grds` with `dm` and fill it with d(log(A))/dr at cell centers.

void	GetFaceArea (MultiFab &area, const BoxArray &grds, const DistributionMapping &dm, int dir, int grow) const
	Define `area` on the faces of `grds` normal to `dir`, using `dm`, and fill it with face areas.

void	GetFaceArea (MultiFab &area, int dir) const
	Fill all valid and ghost cells of the pre-defined `area` with face areas normal to `dir`.

void	GetFaceArea (FArrayBox &area, const BoxArray &grds, int idx, int dir, int grow) const
	Resize `area` to one component on the faces normal to `dir` of entry `idx` of `grds` grown by `grow` in every direction, and fill it with face areas.

bool	isPeriodic (int dir) const noexcept
	Is the domain periodic in the specified direction?

bool	isAnyPeriodic () const noexcept
	Is domain periodic in any direction?

bool	isAllPeriodic () const noexcept
	Is domain periodic in all directions?

Array< int, 3 >	isPeriodic () const noexcept
	Return the periodicity flags for all directions as an Array.

GpuArray< int, 3 >	isPeriodicArray () const noexcept
	Return the periodicity flags in a GpuArray for device code.

int	period (int dir) const noexcept
	What's period in specified direction?

Periodicity	periodicity () const noexcept
	Return the Periodicity based on the length of the domain.

Periodicity	periodicity (const Box &b) const noexcept
	Return the Periodicity based on the length of the cell-centered box `b`.

void	periodicShift (const Box &target, const Box &src, Vector< IntVect > &out) const noexcept
	Compute Array of shifts which will translate `src` so that it will intersect `target` with non-zero intersection. The `out` array will be resized internally, so anything previously there will be gone. DO NOT return non-periodic shifts, even if the boxes do intersect without shifting. The logic is that you will only do this as a special case if there is some periodicity. Each returned IntVect is a nonzero index-space shift whose component is zero in a non-periodic direction and zero or plus/minus the domain length in a periodic direction.

Box	growNonPeriodicDomain (IntVect const &ngrow) const noexcept
	Return domain box with non-periodic directions grown by ngrow.

Box	growNonPeriodicDomain (int ngrow) const noexcept
	Return domain box with non-periodic directions grown by ngrow.

Box	growPeriodicDomain (IntVect const &ngrow) const noexcept
	Return domain box with periodic directions grown by ngrow.

Box	growPeriodicDomain (int ngrow) const noexcept
	Return domain box with periodic directions grown by ngrow.

Array< int, 3 >	setPeriodicity (Array< int, 3 > const &period) noexcept
	Set the periodicity flags and return the old flags.

void	coarsen (IntVect const &rr)
	Coarsen the Geometry by `rr`.

void	refine (IntVect const &rr)
	Refine the Geometry by `rr`.

bool	outsideRoundoffDomain (ParticleReal x, ParticleReal y, ParticleReal z) const
	Returns true if a point is outside the roundoff domain. All particles with positions inside the roundoff domain are sure to be mapped to cells inside the Domain() box. Note that the same need not be true for all points inside ProbDomain().

bool	insideRoundoffDomain (ParticleReal x, ParticleReal y, ParticleReal z) const
	Returns true if a point is inside the roundoff domain. All particles with positions inside the roundoff domain are sure to be mapped to cells inside the Domain() box. Note that the same need not be true for all points inside ProbDomain().

void	computeRoundoffDomain ()
	Compute the roundoff domain.

GpuArray< ParticleReal, 3 > const &	RoundOffLo () const
	Returns roundoff domain's lower end.

GpuArray< ParticleReal, 3 > const &	RoundOffHi () const
	Returns roundoff domain's higher end.

Public Member Functions inherited from amrex::CoordSys
bool	Ok () const noexcept
	Is ok?

void	SetCoord (CoordType coord) noexcept
	Set the CoordType.

CoordType	Coord () const noexcept
	Returns the CoordType.

int	CoordInt () const noexcept
	Returns the CoordType as an int.

bool	IsSPHERICAL () const noexcept
	Is CoordType == SPHERICAL?

bool	IsRZ () const noexcept
	Is CoordType == RZ?

bool	IsCartesian () const noexcept
	Is CoordType == cartesian?

void	SetOffset (const Real *x_lo) noexcept
	Sets the offset for each coordinate direction.

const Real *	Offset () const noexcept
	Returns the offset.

Real	Offset (int dir) const noexcept
	Returns the offset for the specified coordinate direction.

const Real *	CellSize () const noexcept
	Returns the cellsize for each coordinate direction.

Real	CellSize (int dir) const noexcept
	Returns the cellsize for the specified coordinate direction.

GpuArray< Real, 3 >	CellSizeArray () const noexcept
	Returns the cell sizes as a GpuArray for use on host or device.

const Real *	InvCellSize () const noexcept
	Returns the inverse cellsize for each coordinate direction.

Real	InvCellSize (int dir) const noexcept
	Returns the inverse cellsize for the specified coordinate direction.

GpuArray< Real, 3 >	InvCellSizeArray () const noexcept
	Returns the inverse cell sizes as a GpuArray for use on host or device.

Real	CellCenter (int point, int dir) const noexcept
	Returns location of cell center in specified direction.

void	CellCenter (const IntVect &point, Vector< Real > &loc) const noexcept
	Return location of the specified cell center.

void	CellCenter (const IntVect &point, Real *loc) const noexcept
	Return location of the specified cell center.

Real	LoEdge (int point, int dir) const noexcept
	Returns location of lo edge in specified direction.

Real	LoEdge (const IntVect &point, int dir) const noexcept
	Equivalent to LoEdge(point[dir], dir).

Real	HiEdge (int point, int dir) const noexcept
	Returns location of hi edge in specified direction.

Real	HiEdge (const IntVect &point, int dir) const noexcept
	Equivalent to HiEdge(point[dir], dir).

void	LoFace (const IntVect &point, int dir, Vector< Real > &loc) const noexcept
	Compute the physical location of the lower face in direction `dir`.

void	LoFace (const IntVect &point, int dir, Real *loc) const noexcept
	Compute the physical location of the lower face in direction `dir`.

void	HiFace (const IntVect &point, int dir, Vector< Real > &loc) const noexcept
	Compute the physical location of the upper face in direction `dir`.

void	HiFace (const IntVect &point, int dir, Real *loc) const noexcept
	Compute the physical location of the upper face in direction `dir`.

void	LoNode (const IntVect &point, Vector< Real > &loc) const noexcept
	Return the location of the lower-left node of the cell.

void	LoNode (const IntVect &point, Real *loc) const noexcept
	Return the location of the lower-left node of the cell.

void	HiNode (const IntVect &point, Vector< Real > &loc) const noexcept
	Return the location of the upper-right node of the cell.

void	HiNode (const IntVect &point, Real *loc) const noexcept
	Return the location of the upper-right node of the cell.

IntVect	CellIndex (const Real *point) const noexcept
	Returns cell-centered index of cell containing `point`.

IntVect	LowerIndex (const Real *point) const noexcept
	Returns nodal index of lower-left corner of cell containing this point.

IntVect	UpperIndex (const Real *point) const noexcept
	Returns nodal index of upper right hand corner of cell containing this point.

void	SetVolume (FArrayBox &a_volfab, const Box &region) const
	Compute cell volumes in given region and place them into input FAB.

void	GetVolume (FArrayBox &vol, const Box &region) const
	Compute cell volumes in given region and place them into resize()d input FAB.

void	SetDLogA (FArrayBox &a_dlogafab, const Box &region, int dir) const
	Compute d(log(A))/dr at cell centers in given region and place them into input FAB.

void	GetDLogA (FArrayBox &dloga, const Box &region, int dir) const
	Compute d(log(A))/dr at cell centers in given region and return the results in the resize()d input FAB.

Real	Volume (const IntVect &point) const
	Return the physical volume of the specified cell.

Real	Volume (const Real xlo[3], const Real xhi[3]) const
	Return the volume of the specified cell.

void	SetFaceArea (FArrayBox &a_areafab, const Box &region, int dir) const
	Compute area of cell faces in given region and given index direction and return the result in input FAB.

void	GetFaceArea (FArrayBox &area, const Box &region, int dir) const
	Compute area of cell faces in given region and given index direction and return the result in resize()d input FAB.

Real	AreaLo (const IntVect &point, int dir) const noexcept
	Returns lo face area of given cell in direction dir.

Real	AreaHi (const IntVect &point, int dir) const noexcept
	Returns hi face area of given cell in direction dir.

void	GetEdgeLoc (Vector< Real > &loc, const Box &region, int dir) const
	Return array of physical locations of cell edges in the resize()d input array.

void	GetCellLoc (Vector< Real > &loc, const Box &region, int dir) const
	Return array of physical locations of cell centers in the resize()d input array.

void	GetEdgeVolCoord (Vector< Real > &vc, const Box &region, int dir) const
	Return array of volume coordinates at cell edges for region in given direction.

void	GetCellVolCoord (Vector< Real > &vc, const Box &region, int dir) const
	Return array of volume coordinates at cell centers for region in given direction.

Static Public Member Functions
static void	Setup (const RealBox rb=nullptr, int coord=-1, int const isper=nullptr)
	Set up the default Geometry, unless it has already been set up.

static void	ResetDefaultProbDomain (const RealBox &rb) noexcept
	Set the problem domain of the default Geometry to `rb`.

static void	ResetDefaultPeriodicity (const Array< int, 3 > &is_per) noexcept
	Set the periodicity flags of the default Geometry to `is_per`.

static void	ResetDefaultCoord (int coord) noexcept
	Set the coordinate-system type of the default Geometry to `coord`.

__host__ static __device__ Real	Volume (const IntVect &point, const GeometryData &geomdata)
	Return the volume of the specified cell.

Friends
std::istream &	operator>> (std::istream &, Geometry &)
	Read a Geometry from an input stream in ASCII format.

Additional Inherited Members
Public Types inherited from amrex::CoordSys
enum	CoordType { undef = -1 , cartesian = 0 , RZ = 1 , SPHERICAL = 2 }
	Coordinate system type: undefined, Cartesian, cylindrical (RZ), or spherical. More...

Protected Attributes inherited from amrex::CoordSys
CoordType	c_sys = undef

Real	offset [3]

Real	dx [3] = { 0. , 0. , 0. }

Real	inv_dx [3]

bool	ok = false

Detailed Description

Rectangular problem domain geometry.

This class describes problem domain and coordinate system for RECTANGULAR problem domains. Since the problem domain is RECTANGULAR, periodicity is meaningful.

Constructor & Destructor Documentation

◆ Geometry() [1/5]

amrex::Geometry::Geometry ( )

noexcept

Construct a copy of the default Geometry, if one is available.

If there is no AMReX instance, or the default Geometry has not been set up yet, the object is left in an unusable state and a define method must be called before use.

◆ Geometry() [2/5]

amrex::Geometry::Geometry	(	const Box &	dom,
		const RealBox *	rb = `nullptr`,
		int	coord = `-1`,
		int const *	is_per = `nullptr`
	)

explicit

Construct a Geometry for the specified index-space domain.

Parameters

dom	Cell-centered Box specifying the index-space domain.
rb	Physical bounds of the domain. If nullptr, the bounds of the default Geometry are used (see Setup()).
coord	Coordinate-system type: 0 for Cartesian (CoordSys::cartesian), 1 for RZ (CoordSys::RZ), or 2 for spherical (CoordSys::SPHERICAL). Any other value selects the coordinate system of the default Geometry.
is_per	Periodicity flags for each coordinate direction. If nullptr, the flags of the default Geometry are used.

◆ Geometry() [3/5]

amrex::Geometry::Geometry	(	const Box &	dom,
		const RealBox &	rb,
		int	coord,
		Array< int, 3 > const &	is_per
	)

Construct a Geometry with explicitly supplied physical bounds and periodicity.

Parameters

dom	Cell-centered Box specifying the index-space domain.
rb	Physical bounds of the domain.
coord	Coordinate-system type: 0 for Cartesian (CoordSys::cartesian), 1 for RZ (CoordSys::RZ), or 2 for spherical (CoordSys::SPHERICAL). Any other value selects the coordinate system of the default Geometry.
is_per	Periodicity flags for each coordinate direction.

◆ ~Geometry()

amrex::Geometry::~Geometry ( )

default

◆ Geometry() [4/5]

amrex::Geometry::Geometry ( const Geometry & rhs )

default

◆ Geometry() [5/5]

amrex::Geometry::Geometry ( Geometry && rhs )

defaultnoexcept

Member Function Documentation

◆ coarsen()

void amrex::Geometry::coarsen ( IntVect const & rr )

inline

Coarsen the Geometry by rr.

This does not refresh roundoff_lo/hi. Call computeRoundoffDomain() before using particle roundoff bounds from the modified Geometry.

◆ computeRoundoffDomain()

void amrex::Geometry::computeRoundoffDomain ( )

Compute the roundoff domain.

◆ data()

GeometryData amrex::Geometry::data ( ) const

inlinenoexcept

Return a GPU-safe snapshot of the Geometry data.

◆ define() [1/2]

void amrex::Geometry::define	(	const Box &	dom,
		const RealBox &	rb,
		int	coord,
		Array< int, 3 > const &	is_per
	)

Define this Geometry with explicitly supplied physical bounds and periodicity.

Parameters

dom	Cell-centered Box specifying the index-space domain.
rb	Physical bounds of the domain.
coord	Coordinate-system type: 0 for Cartesian (CoordSys::cartesian), 1 for RZ (CoordSys::RZ), or 2 for spherical (CoordSys::SPHERICAL). Any other value selects the coordinate system of the default Geometry.
is_per	Periodicity flags for each coordinate direction.

◆ define() [2/2]

void amrex::Geometry::define	(	const Box &	dom,
		const RealBox *	rb = `nullptr`,
		int	coord = `-1`,
		int const *	is_per = `nullptr`
	)

Define this Geometry for the specified index-space domain.

Parameters

dom	Cell-centered Box specifying the index-space domain.
rb	Physical bounds of the domain. If nullptr, the bounds of the default Geometry are used (see Setup()).
coord	Coordinate-system type: 0 for Cartesian (CoordSys::cartesian), 1 for RZ (CoordSys::RZ), or 2 for spherical (CoordSys::SPHERICAL). Any other value selects the coordinate system of the default Geometry.
is_per	Periodicity flags for each coordinate direction. If nullptr, the flags of the default Geometry are used.

◆ Domain() [1/2]

const Box & amrex::Geometry::Domain ( ) const

inlinenoexcept

Returns our rectangular domain.

◆ Domain() [2/2]

void amrex::Geometry::Domain ( const Box & bx )

inline

Sets our rectangular domain.

◆ GetDLogA()

void amrex::Geometry::GetDLogA	(	MultiFab &	dloga,
		const BoxArray &	grds,
		const DistributionMapping &	dm,
		int	dir,
		int	grow
	)		const

Define dloga on grds with dm and fill it with d(log(A))/dr at cell centers.

The result has one component and grow ghost cells in every direction. dir is the coordinate direction of the face area A.

Note: This function is only available in 1D and 2D.

◆ GetFaceArea() [1/3]

void amrex::Geometry::GetFaceArea	(	FArrayBox &	area,
		const BoxArray &	grds,
		int	idx,
		int	dir,
		int	grow
	)		const

Resize area to one component on the faces normal to dir of entry idx of grds grown by grow in every direction, and fill it with face areas.

◆ GetFaceArea() [2/3]

void amrex::Geometry::GetFaceArea	(	MultiFab &	area,
		const BoxArray &	grds,
		const DistributionMapping &	dm,
		int	dir,
		int	grow
	)		const

Define area on the faces of grds normal to dir, using dm, and fill it with face areas.

The result has one component and grow ghost cells in every direction.

◆ GetFaceArea() [3/3]

void amrex::Geometry::GetFaceArea	(	MultiFab &	area,
		int	dir
	)		const

Fill all valid and ghost cells of the pre-defined area with face areas normal to dir.

◆ GetVolume() [1/3]

void amrex::Geometry::GetVolume	(	FArrayBox &	vol,
		const BoxArray &	grds,
		int	idx,
		int	grow
	)		const

Resize vol to one component on entry idx of grds grown by grow in every direction, and fill it with cell volumes.

◆ GetVolume() [2/3]

void amrex::Geometry::GetVolume ( MultiFab & vol ) const

Fill all valid and ghost cells of the pre-defined vol with cell volumes.

◆ GetVolume() [3/3]

void amrex::Geometry::GetVolume	(	MultiFab &	vol,
		const BoxArray &	grds,
		const DistributionMapping &	dm,
		int	grow
	)		const

Define vol on grds with dm and fill it with cell volumes.

The result has one component and grow ghost cells in every direction.

◆ growNonPeriodicDomain() [1/2]

Box amrex::Geometry::growNonPeriodicDomain ( int ngrow ) const

noexcept

Return domain box with non-periodic directions grown by ngrow.

◆ growNonPeriodicDomain() [2/2]

Box amrex::Geometry::growNonPeriodicDomain ( IntVect const & ngrow ) const

noexcept

Return domain box with non-periodic directions grown by ngrow.

◆ growPeriodicDomain() [1/2]

Box amrex::Geometry::growPeriodicDomain ( int ngrow ) const

noexcept

Return domain box with periodic directions grown by ngrow.

◆ growPeriodicDomain() [2/2]

Box amrex::Geometry::growPeriodicDomain ( IntVect const & ngrow ) const

noexcept

Return domain box with periodic directions grown by ngrow.

◆ insideRoundoffDomain()

bool amrex::Geometry::insideRoundoffDomain	(	ParticleReal	x,
		ParticleReal	y,
		ParticleReal	z
	)		const

Returns true if a point is inside the roundoff domain. All particles with positions inside the roundoff domain are sure to be mapped to cells inside the Domain() box. Note that the same need not be true for all points inside ProbDomain().

◆ isAllPeriodic()

bool amrex::Geometry::isAllPeriodic ( ) const

inlinenoexcept

Is domain periodic in all directions?

◆ isAnyPeriodic()

bool amrex::Geometry::isAnyPeriodic ( ) const

inlinenoexcept

Is domain periodic in any direction?

◆ isPeriodic() [1/2]

Array< int, 3 > amrex::Geometry::isPeriodic ( ) const

inlinenoexcept

Return the periodicity flags for all directions as an Array.

◆ isPeriodic() [2/2]

bool amrex::Geometry::isPeriodic ( int dir ) const

inlinenoexcept

Is the domain periodic in the specified direction?

◆ isPeriodicArray()

GpuArray< int, 3 > amrex::Geometry::isPeriodicArray ( ) const

inlinenoexcept

Return the periodicity flags in a GpuArray for device code.

◆ operator=() [1/2]

Geometry & amrex::Geometry::operator= ( const Geometry & rhs )

default

◆ operator=() [2/2]

Geometry & amrex::Geometry::operator= ( Geometry && rhs )

defaultnoexcept

◆ outsideRoundoffDomain()

bool amrex::Geometry::outsideRoundoffDomain	(	ParticleReal	x,
		ParticleReal	y,
		ParticleReal	z
	)		const

Returns true if a point is outside the roundoff domain. All particles with positions inside the roundoff domain are sure to be mapped to cells inside the Domain() box. Note that the same need not be true for all points inside ProbDomain().

◆ period()

int amrex::Geometry::period ( int dir ) const

inlinenoexcept

What's period in specified direction?

◆ periodicity() [1/2]

Periodicity amrex::Geometry::periodicity ( ) const

inlinenoexcept

Return the Periodicity based on the length of the domain.

◆ periodicity() [2/2]

Periodicity amrex::Geometry::periodicity ( const Box & b ) const

inlinenoexcept

Return the Periodicity based on the length of the cell-centered box b.

◆ periodicShift()

void amrex::Geometry::periodicShift	(	const Box &	target,
		const Box &	src,
		Vector< IntVect > &	out
	)		const

noexcept

Compute Array of shifts which will translate src so that it will intersect target with non-zero intersection. The out array will be resized internally, so anything previously there will be gone. DO NOT return non-periodic shifts, even if the boxes do intersect without shifting. The logic is that you will only do this as a special case if there is some periodicity. Each returned IntVect is a nonzero index-space shift whose component is zero in a non-periodic direction and zero or plus/minus the domain length in a periodic direction.

◆ ProbDomain() [1/2]

const RealBox & amrex::Geometry::ProbDomain ( ) const

inlinenoexcept

Returns the problem domain.

◆ ProbDomain() [2/2]

void amrex::Geometry::ProbDomain ( const RealBox & rb )

inline

Sets the problem domain.

◆ ProbHi() [1/2]

const Real * amrex::Geometry::ProbHi ( ) const

inlinenoexcept

Returns the hi end of the problem domain in each dimension.

◆ ProbHi() [2/2]

Real amrex::Geometry::ProbHi ( int dir ) const

inlinenoexcept

Returns the hi end of the problem domain in specified direction.

◆ ProbHiArray()

GpuArray< Real, 3 > amrex::Geometry::ProbHiArray ( ) const

inlinenoexcept

Return the hi end of the problem domain in a GpuArray for device code.

◆ ProbHiArrayInParticleReal()

GpuArray< ParticleReal, 3 > amrex::Geometry::ProbHiArrayInParticleReal ( ) const

inlinenoexcept

Return the hi end of the roundoff domain in ParticleReal precision.

◆ ProbLength()

Real amrex::Geometry::ProbLength ( int dir ) const

inlinenoexcept

Returns length of problem domain in specified dimension.

◆ ProbLo() [1/2]

const Real * amrex::Geometry::ProbLo ( ) const

inlinenoexcept

Returns the lo end of the problem domain in each dimension.

◆ ProbLo() [2/2]

Real amrex::Geometry::ProbLo ( int dir ) const

inlinenoexcept

Returns the lo end of the problem domain in specified direction.

◆ ProbLoArray()

GpuArray< Real, 3 > amrex::Geometry::ProbLoArray ( ) const

inlinenoexcept

Return the lo end of the problem domain in a GpuArray for device code.

◆ ProbLoArrayInParticleReal()

GpuArray< ParticleReal, 3 > amrex::Geometry::ProbLoArrayInParticleReal ( ) const

inlinenoexcept

Return the lo end of the roundoff domain in ParticleReal precision.

◆ ProbSize()

Real amrex::Geometry::ProbSize ( ) const

inlinenoexcept

Returns the overall size of the domain by multiplying the ProbLength's together.

◆ refine()

void amrex::Geometry::refine ( IntVect const & rr )

inline

Refine the Geometry by rr.

This does not refresh roundoff_lo/hi. Call computeRoundoffDomain() before using particle roundoff bounds from the modified Geometry.

◆ ResetDefaultCoord()

void amrex::Geometry::ResetDefaultCoord ( int coord )

staticnoexcept

Set the coordinate-system type of the default Geometry to coord.

◆ ResetDefaultPeriodicity()

void amrex::Geometry::ResetDefaultPeriodicity ( const Array< int, 3 > & is_per )

staticnoexcept

Set the periodicity flags of the default Geometry to is_per.

◆ ResetDefaultProbDomain()

void amrex::Geometry::ResetDefaultProbDomain ( const RealBox & rb )

staticnoexcept

Set the problem domain of the default Geometry to rb.

◆ RoundOffHi()

GpuArray< ParticleReal, 3 > const & amrex::Geometry::RoundOffHi ( ) const

inline

Returns roundoff domain's higher end.

◆ RoundOffLo()

GpuArray< ParticleReal, 3 > const & amrex::Geometry::RoundOffLo ( ) const

inline

Returns roundoff domain's lower end.

◆ setPeriodicity()

Array< int, 3 > amrex::Geometry::setPeriodicity ( Array< int, 3 > const & period )

inlinenoexcept

Set the periodicity flags and return the old flags.

Note that, unlike the Periodicity class, the flags are just boolean. The caller can use the returned array to restore the previous state after a temporary override.

◆ Setup()

void amrex::Geometry::Setup	(	const RealBox *	rb = `nullptr`,
		int	coord = `-1`,
		int const *	isper = `nullptr`
	)

static

Set up the default Geometry, unless it has already been set up.

A Geometry constructed or defined without explicit physical bounds, coordinate system, or periodicity takes those from the default Geometry, which this function initializes. Anything not passed in here is read from the ParmParse prefix geometry.

Parameters

rb	Problem-domain bounds. If nullptr, the bounds are read from `geometry.prob_lo` (default zero) together with either `geometry.prob_hi` or `geometry.prob_extent`, exactly one of which must be provided.
coord	Coordinate-system identifier. If outside the range [0,2], it is read from `geometry.coord_sys` and defaults to Cartesian.
isper	Periodicity flags. If nullptr, they are read from `geometry.is_periodic` and default to non-periodic.

◆ Volume()

__host__ static __device__ Real amrex::Geometry::Volume	(	const IntVect &	point,
		const GeometryData &	geomdata
	)

inlinestatic

Return the volume of the specified cell.

Friends And Related Symbol Documentation

◆ operator>>

std::istream & operator>>	(	std::istream &	,
		Geometry &
	)

friend

Read a Geometry from an input stream in ASCII format.

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

/home/runner/work/amrex/amrex/Src/Base/AMReX_Geometry.H
/home/runner/work/amrex/amrex/Src/Base/AMReX_Geometry.cpp

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Geometry() [1/5]

◆ Geometry() [2/5]

◆ Geometry() [3/5]

◆ ~Geometry()

◆ Geometry() [4/5]

◆ Geometry() [5/5]

Member Function Documentation

◆ coarsen()

◆ computeRoundoffDomain()

◆ data()

◆ define() [1/2]

◆ define() [2/2]

◆ Domain() [1/2]

◆ Domain() [2/2]

◆ GetDLogA()

◆ GetFaceArea() [1/3]

◆ GetFaceArea() [2/3]

◆ GetFaceArea() [3/3]

◆ GetVolume() [1/3]

◆ GetVolume() [2/3]

◆ GetVolume() [3/3]

◆ growNonPeriodicDomain() [1/2]

◆ growNonPeriodicDomain() [2/2]

◆ growPeriodicDomain() [1/2]

◆ growPeriodicDomain() [2/2]

◆ insideRoundoffDomain()

◆ isAllPeriodic()

◆ isAnyPeriodic()

◆ isPeriodic() [1/2]

◆ isPeriodic() [2/2]

◆ isPeriodicArray()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ outsideRoundoffDomain()

◆ period()

◆ periodicity() [1/2]

◆ periodicity() [2/2]

◆ periodicShift()

◆ ProbDomain() [1/2]

◆ ProbDomain() [2/2]

◆ ProbHi() [1/2]

◆ ProbHi() [2/2]

◆ ProbHiArray()

◆ ProbHiArrayInParticleReal()

◆ ProbLength()

◆ ProbLo() [1/2]

◆ ProbLo() [2/2]

◆ ProbLoArray()

◆ ProbLoArrayInParticleReal()

◆ ProbSize()

◆ refine()

◆ ResetDefaultCoord()

◆ ResetDefaultPeriodicity()

◆ ResetDefaultProbDomain()

◆ RoundOffHi()

◆ RoundOffLo()

◆ setPeriodicity()

◆ Setup()

◆ Volume()

Friends And Related Symbol Documentation

◆ operator>>