Block-Structured AMR Software Framework
Loading...
Searching...
No Matches
amrex::GeometryData Struct Reference

GPU-safe snapshot of Geometry data suitable for capture in GPU kernels. More...

#include <AMReX_Geometry.H>

Public Member Functions

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

Public Attributes

RealBox prob_domain
 Physical bounds of the problem domain.
 
Box domain
 Cell-centered index-space domain.
 
Real dx [3]
 Cell size in each dimension.
 
int is_periodic [3]
 For each dimension, 0 if the domain is non-periodic and 1 if it is.
 
int coord
 Coordinate-system type: 0 for Cartesian, 1 for RZ, and 2 for spherical.
 

Detailed Description

GPU-safe snapshot of Geometry data suitable for capture in GPU kernels.

Member Function Documentation

◆ CellSize() [1/2]

__host__ __device__ const Real * amrex::GeometryData::CellSize ( ) const
inlinenoexcept

Returns the cellsize for each coordinate direction.

◆ CellSize() [2/2]

__host__ __device__ Real amrex::GeometryData::CellSize ( int  dir) const
inlinenoexcept

Returns the cellsize for direction dir.

◆ Coord()

__host__ __device__ int amrex::GeometryData::Coord ( ) const
inlinenoexcept

Coordinates type.

◆ Domain()

__host__ __device__ const Box & amrex::GeometryData::Domain ( ) const
inlinenoexcept

Returns our rectangular domain.

◆ isPeriodic()

__host__ __device__ int amrex::GeometryData::isPeriodic ( const int  i) const
inlinenoexcept

Returns whether the domain is periodic in the given direction.

◆ ProbHi() [1/2]

__host__ __device__ const Real * amrex::GeometryData::ProbHi ( ) const
inlinenoexcept

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

◆ ProbHi() [2/2]

__host__ __device__ Real amrex::GeometryData::ProbHi ( int  dir) const
inlinenoexcept

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

◆ ProbLo() [1/2]

__host__ __device__ const Real * amrex::GeometryData::ProbLo ( ) const
inlinenoexcept

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

◆ ProbLo() [2/2]

__host__ __device__ Real amrex::GeometryData::ProbLo ( int  dir) const
inlinenoexcept

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

Member Data Documentation

◆ coord

int amrex::GeometryData::coord

Coordinate-system type: 0 for Cartesian, 1 for RZ, and 2 for spherical.

◆ domain

Box amrex::GeometryData::domain

Cell-centered index-space domain.

◆ dx

Real amrex::GeometryData::dx[3]

Cell size in each dimension.

◆ is_periodic

int amrex::GeometryData::is_periodic[3]

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

◆ prob_domain

RealBox amrex::GeometryData::prob_domain

Physical bounds of the problem domain.


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