Coordinate System. More...

#include <AMReX_CoordSys.H>

Inheritance diagram for amrex::CoordSys:

Public Types
enum	CoordType { undef = -1 , cartesian = 0 , RZ = 1 , SPHERICAL = 2 }

Public Member Functions
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

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

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 cell center.

void	CellCenter (const IntVect &point, Real *loc) const noexcept
	Return location of 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
	Sets location of lo face into loc.

void	LoFace (const IntVect &point, int dir, Real *loc) const noexcept
	Sets location of lo face into loc.

void	HiFace (const IntVect &point, int dir, Vector< Real > &loc) const noexcept
	Sets location of hi face into loc.

void	HiFace (const IntVect &point, int dir, Real *loc) const noexcept
	Sets location of hi face into loc.

void	LoNode (const IntVect &point, Vector< Real > &loc) const noexcept
	Return location of lower left hand corner.

void	LoNode (const IntVect &point, Real *loc) const noexcept
	Return location of lower left hand corner.

void	HiNode (const IntVect &point, Vector< Real > &loc) const noexcept
	Return location of upper right hand corner.

void	HiNode (const IntVect &point, Real *loc) const noexcept
	Return location of upper right hand corner.

IntVect	CellIndex (const Real *point) const noexcept
	Returns cell centered index of cell containing point. This may return undesired results if point is on a cell boundary.

IntVect	LowerIndex (const Real *point) const noexcept
	Returns node centered index of lower left hand corner of cell containing this point.

IntVect	UpperIndex (const Real *point) const noexcept
	Returns node centered 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 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.

Protected Attributes
CoordType	c_sys = undef

Real	offset [3]

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

Real	inv_dx [3]

bool	ok = false

Friends
std::ostream &	operator<< (std::ostream &, const CoordSys &)
	Nice ASCII output.

std::istream &	operator>> (std::istream &, CoordSys &)
	Nice ASCII input.

Detailed Description

Coordinate System.

Routines for mapping between physical coordinate system and index space.

Member Enumeration Documentation

◆ CoordType

enum amrex::CoordSys::CoordType

Enumerator
undef
cartesian
RZ
SPHERICAL

Member Function Documentation

◆ AreaHi()

Real amrex::CoordSys::AreaHi	(	const IntVect &	point,
		int	dir
	)		const

noexcept

Returns hi face area of given cell in direction dir.

◆ AreaLo()

Real amrex::CoordSys::AreaLo	(	const IntVect &	point,
		int	dir
	)		const

noexcept

Returns lo face area of given cell in direction dir.

◆ CellCenter() [1/3]

void amrex::CoordSys::CellCenter	(	const IntVect &	point,
		Real *	loc
	)		const

noexcept

Return location of cell center.

◆ CellCenter() [2/3]

void amrex::CoordSys::CellCenter	(	const IntVect &	point,
		Vector< Real > &	loc
	)		const

noexcept

Return location of cell center.

◆ CellCenter() [3/3]

Real amrex::CoordSys::CellCenter	(	int	point,
		int	dir
	)		const

inlinenoexcept

Returns location of cell center in specified direction.

◆ CellIndex()

IntVect amrex::CoordSys::CellIndex ( const Real * point ) const

noexcept

Returns cell centered index of cell containing point. This may return undesired results if point is on a cell boundary.

◆ CellSize() [1/2]

const Real * amrex::CoordSys::CellSize ( ) const

inlinenoexcept

Returns the cellsize for each coordinate direction.

◆ CellSize() [2/2]

Real amrex::CoordSys::CellSize ( int dir ) const

inlinenoexcept

Returns the cellsize for the specified coordinate direction.

◆ CellSizeArray()

GpuArray< Real, 3 > amrex::CoordSys::CellSizeArray ( ) const

inlinenoexcept

◆ Coord()

CoordType amrex::CoordSys::Coord ( ) const

inlinenoexcept

Returns the CoordType.

◆ CoordInt()

int amrex::CoordSys::CoordInt ( ) const

inlinenoexcept

Returns the CoordType as an int.

◆ GetCellLoc()

void amrex::CoordSys::GetCellLoc	(	Vector< Real > &	loc,
		const Box &	region,
		int	dir
	)		const

Return array of physical locations of cell centers in the resize()d input array.

◆ GetCellVolCoord()

void amrex::CoordSys::GetCellVolCoord	(	Vector< Real > &	vc,
		const Box &	region,
		int	dir
	)		const

Return array of volume coordinates at cell centers for region in given direction.

◆ GetDLogA()

void amrex::CoordSys::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.

◆ GetEdgeLoc()

void amrex::CoordSys::GetEdgeLoc	(	Vector< Real > &	loc,
		const Box &	region,
		int	dir
	)		const

Return array of physical locations of cell edges in the resize()d input array.

◆ GetEdgeVolCoord()

void amrex::CoordSys::GetEdgeVolCoord	(	Vector< Real > &	vc,
		const Box &	region,
		int	dir
	)		const

Return array of volume coordinates at cell edges for region in given direction.

◆ GetFaceArea()

void amrex::CoordSys::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.

◆ GetVolume()

void amrex::CoordSys::GetVolume	(	FArrayBox &	vol,
		const Box &	region
	)		const

Compute cell volumes in given region and place them into resize()d input FAB.

◆ HiEdge() [1/2]

Real amrex::CoordSys::HiEdge	(	const IntVect &	point,
		int	dir
	)		const

inlinenoexcept

Equivalent to HiEdge(point[dir], dir).

◆ HiEdge() [2/2]

Real amrex::CoordSys::HiEdge	(	int	point,
		int	dir
	)		const

inlinenoexcept

Returns location of hi edge in specified direction.

◆ HiFace() [1/2]

void amrex::CoordSys::HiFace	(	const IntVect &	point,
		int	dir,
		Real *	loc
	)		const

noexcept

Sets location of hi face into loc.

◆ HiFace() [2/2]

void amrex::CoordSys::HiFace	(	const IntVect &	point,
		int	dir,
		Vector< Real > &	loc
	)		const

noexcept

Sets location of hi face into loc.

◆ HiNode() [1/2]

void amrex::CoordSys::HiNode	(	const IntVect &	point,
		Real *	loc
	)		const

noexcept

Return location of upper right hand corner.

◆ HiNode() [2/2]

void amrex::CoordSys::HiNode	(	const IntVect &	point,
		Vector< Real > &	loc
	)		const

noexcept

Return location of upper right hand corner.

◆ InvCellSize() [1/2]

const Real * amrex::CoordSys::InvCellSize ( ) const

inlinenoexcept

Returns the inverse cellsize for each coordinate direction.

◆ InvCellSize() [2/2]

Real amrex::CoordSys::InvCellSize ( int dir ) const

inlinenoexcept

Returns the inverse cellsize for the specified coordinate direction.

◆ InvCellSizeArray()

GpuArray< Real, 3 > amrex::CoordSys::InvCellSizeArray ( ) const

inlinenoexcept

◆ IsCartesian()

bool amrex::CoordSys::IsCartesian ( ) const

inlinenoexcept

Is CoordType == cartesian?

◆ IsRZ()

bool amrex::CoordSys::IsRZ ( ) const

inlinenoexcept

Is CoordType == RZ?

◆ IsSPHERICAL()

bool amrex::CoordSys::IsSPHERICAL ( ) const

inlinenoexcept

Is CoordType == SPHERICAL?

◆ LoEdge() [1/2]

Real amrex::CoordSys::LoEdge	(	const IntVect &	point,
		int	dir
	)		const

inlinenoexcept

Equivalent to LoEdge(point[dir], dir).

◆ LoEdge() [2/2]

Real amrex::CoordSys::LoEdge	(	int	point,
		int	dir
	)		const

inlinenoexcept

Returns location of lo edge in specified direction.

◆ LoFace() [1/2]

void amrex::CoordSys::LoFace	(	const IntVect &	point,
		int	dir,
		Real *	loc
	)		const

noexcept

Sets location of lo face into loc.

◆ LoFace() [2/2]

void amrex::CoordSys::LoFace	(	const IntVect &	point,
		int	dir,
		Vector< Real > &	loc
	)		const

noexcept

Sets location of lo face into loc.

◆ LoNode() [1/2]

void amrex::CoordSys::LoNode	(	const IntVect &	point,
		Real *	loc
	)		const

noexcept

Return location of lower left hand corner.

◆ LoNode() [2/2]

void amrex::CoordSys::LoNode	(	const IntVect &	point,
		Vector< Real > &	loc
	)		const

noexcept

Return location of lower left hand corner.

◆ LowerIndex()

IntVect amrex::CoordSys::LowerIndex ( const Real * point ) const

noexcept

Returns node centered index of lower left hand corner of cell containing this point.

◆ Offset() [1/2]

const Real * amrex::CoordSys::Offset ( ) const

inlinenoexcept

Returns the offset.

◆ Offset() [2/2]

Real amrex::CoordSys::Offset ( int dir ) const

inlinenoexcept

Returns the offset for the specified coordinate direction.

◆ Ok()

bool amrex::CoordSys::Ok ( ) const

inlinenoexcept

Is ok?

◆ SetCoord()

void amrex::CoordSys::SetCoord ( CoordType coord )

inlinenoexcept

Set the CoordType.

◆ SetDLogA()

void amrex::CoordSys::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.

◆ SetFaceArea()

void amrex::CoordSys::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.

◆ SetOffset()

void amrex::CoordSys::SetOffset ( const Real * x_lo )

noexcept

Sets the offset for each coordinate direction.

◆ SetVolume()

void amrex::CoordSys::SetVolume	(	FArrayBox &	a_volfab,
		const Box &	region
	)		const

Compute cell volumes in given region and place them into input FAB.

◆ UpperIndex()

IntVect amrex::CoordSys::UpperIndex ( const Real * point ) const

noexcept

Returns node centered index of upper right hand corner of cell containing this point.

◆ Volume() [1/2]

Real amrex::CoordSys::Volume ( const IntVect & point ) const

Return the volume of the specified cell.

◆ Volume() [2/2]

Real amrex::CoordSys::Volume	(	const Real	xlo[3],
		const Real	xhi[3]
	)		const

Return the volume of the specified cell.

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<<	(	std::ostream &	os,
		const CoordSys &	c
	)

friend

Nice ASCII output.

◆ operator>>

std::istream & operator>>	(	std::istream &	is,
		CoordSys &	c
	)

friend

Nice ASCII input.

Member Data Documentation

◆ c_sys

CoordType amrex::CoordSys::c_sys = undef

protected

◆ dx

Real amrex::CoordSys::dx[3] = { 0. , 0. , 0. }

protected

◆ inv_dx

Real amrex::CoordSys::inv_dx[3]

protected

Initial value:

= {
 
 std::numeric_limits<Real>::max() , std::numeric_limits<Real>::max() , std::numeric_limits<Real>::max() }

◆ offset

Real amrex::CoordSys::offset[3]

protected

◆ ok

bool amrex::CoordSys::ok = false

protected

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

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

Public Types

Public Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ CoordType

Member Function Documentation

◆ AreaHi()

◆ AreaLo()

◆ CellCenter() [1/3]

◆ CellCenter() [2/3]

◆ CellCenter() [3/3]

◆ CellIndex()

◆ CellSize() [1/2]

◆ CellSize() [2/2]

◆ CellSizeArray()

◆ Coord()

◆ CoordInt()

◆ GetCellLoc()

◆ GetCellVolCoord()

◆ GetDLogA()

◆ GetEdgeLoc()

◆ GetEdgeVolCoord()

◆ GetFaceArea()

◆ GetVolume()

◆ HiEdge() [1/2]

◆ HiEdge() [2/2]

◆ HiFace() [1/2]

◆ HiFace() [2/2]

◆ HiNode() [1/2]

◆ HiNode() [2/2]

◆ InvCellSize() [1/2]

◆ InvCellSize() [2/2]

◆ InvCellSizeArray()

◆ IsCartesian()

◆ IsRZ()

◆ IsSPHERICAL()

◆ LoEdge() [1/2]

◆ LoEdge() [2/2]

◆ LoFace() [1/2]

◆ LoFace() [2/2]

◆ LoNode() [1/2]

◆ LoNode() [2/2]

◆ LowerIndex()

◆ Offset() [1/2]

◆ Offset() [2/2]

◆ Ok()

◆ SetCoord()

◆ SetDLogA()

◆ SetFaceArea()

◆ SetOffset()

◆ SetVolume()

◆ UpperIndex()

◆ Volume() [1/2]

◆ Volume() [2/2]

Friends And Related Symbol Documentation

◆ operator<<

◆ operator>>

Member Data Documentation

◆ c_sys

◆ dx

◆ inv_dx

◆ offset

◆ ok