Block-Structured AMR Software Framework
amrex::GeometryData Struct Reference

#include <AMReX_Geometry.H>

Public Member Functions

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const Real * CellSize () const noexcept
 Returns the cellsize for each coordinate direction. More...
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE Real CellSize (int dir) const noexcept
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const Real * ProbLo () const noexcept
 Returns the lo end of the problem domain in each dimension. More...
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE Real ProbLo (int dir) const noexcept
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const Real * ProbHi () const noexcept
 Returns the hi end of the problem domain in each dimension. More...
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE Real ProbHi (int dir) const noexcept
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const BoxDomain () const noexcept
 Returns our rectangular domain. More...
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE int isPeriodic (const int i) const noexcept
 Returns whether the domain is periodic in the given direction. More...
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE int Coord () const noexcept
 Coordinates type. More...
 

Public Attributes

RealBox prob_domain
 
Box domain
 
Real dx [AMREX_SPACEDIM]
 
int is_periodic [AMREX_SPACEDIM]
 
int coord
 

Member Function Documentation

◆ CellSize() [1/2]

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const Real* amrex::GeometryData::CellSize ( ) const
inlinenoexcept

Returns the cellsize for each coordinate direction.

◆ CellSize() [2/2]

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE Real amrex::GeometryData::CellSize ( int  dir) const
inlinenoexcept

◆ Coord()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE int amrex::GeometryData::Coord ( ) const
inlinenoexcept

Coordinates type.

◆ Domain()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const Box& amrex::GeometryData::Domain ( ) const
inlinenoexcept

Returns our rectangular domain.

◆ isPeriodic()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE int amrex::GeometryData::isPeriodic ( const int  i) const
inlinenoexcept

Returns whether the domain is periodic in the given direction.

◆ ProbHi() [1/2]

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const Real* amrex::GeometryData::ProbHi ( ) const
inlinenoexcept

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

◆ ProbHi() [2/2]

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE Real amrex::GeometryData::ProbHi ( int  dir) const
inlinenoexcept

◆ ProbLo() [1/2]

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const Real* amrex::GeometryData::ProbLo ( ) const
inlinenoexcept

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

◆ ProbLo() [2/2]

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE Real amrex::GeometryData::ProbLo ( int  dir) const
inlinenoexcept

Member Data Documentation

◆ coord

int amrex::GeometryData::coord

◆ domain

Box amrex::GeometryData::domain

◆ dx

Real amrex::GeometryData::dx[AMREX_SPACEDIM]

◆ is_periodic

int amrex::GeometryData::is_periodic[AMREX_SPACEDIM]

For each dimension, 0 if the domain is non-periodic and 1 if it is.

◆ prob_domain

RealBox amrex::GeometryData::prob_domain

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