SpatialOps
SpatialOps::GhostData Class Reference

Holds information about the number of ghost cells on each side of the domain. More...

#include <GhostData.h>

Public Member Functions

 GhostData (const int nx, const int px, const int ny, const int py, const int nz, const int pz)
 Construct a GhostData. More...
 
 GhostData (const IntVec &minus, const IntVec &plus)
 Construct a GhostData. More...
 
 GhostData (const int n=0)
 construct a GhostData with the same number of ghost cells on each face More...
 
IntVec get_minus () const
 obtain the IntVec containing the number of ghost cells on the (-) faces
 
int get_minus (const int i) const
 obtain the number of ghost cells on the requested (-) face (0=x, 1=y, 2=z)
 
IntVec get_plus () const
 obtain the IntVec containing the number of ghost cells on the (+) faces
 
int get_plus (const int i) const
 obtain the number of ghost cells on the requested (+) face (0=x, 1=y, 2=z)
 
void set_minus (const IntVec &minus)
 set the number of ghost cells on the requested (-) face (0=x, 1=y, 2=z)
 
void set_plus (const IntVec &plus)
 set the number of ghost cells on the requested (+) face (0=x, 1=y, 2=z)
 

Detailed Description

Holds information about the number of ghost cells on each side of the domain.

Date
July, 2013
Author
James C. Sutherland

Definition at line 54 of file GhostData.h.

Constructor & Destructor Documentation

◆ GhostData() [1/3]

SpatialOps::GhostData::GhostData ( const int  nx,
const int  px,
const int  ny,
const int  py,
const int  nz,
const int  pz 
)
inline

Construct a GhostData.

Parameters
nxNumber of ghost cells on the -x face
pxNumber of ghost cells on the +x face
nyNumber of ghost cells on the -y face
pyNumber of ghost cells on the +y face
nzNumber of ghost cells on the -z face
pzNumber of ghost cells on the +z face

Definition at line 87 of file GhostData.h.

Referenced by GhostData(), and set_plus().

Here is the caller graph for this function:

◆ GhostData() [2/3]

SpatialOps::GhostData::GhostData ( const IntVec minus,
const IntVec plus 
)
inline

Construct a GhostData.

Parameters
minusNumber of ghost cells on the (-) x, y, and z faces
plusNumber of ghost cells on the (+) x, y, and z faces

Definition at line 101 of file GhostData.h.

◆ GhostData() [3/3]

SpatialOps::GhostData::GhostData ( const int  n = 0)
inline

construct a GhostData with the same number of ghost cells on each face

Parameters
nthe number of ghost cells on each face (defaults to zero)

Definition at line 112 of file GhostData.h.

References GhostData().

Here is the call graph for this function:

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