serialbox::stella::IJKBoundary Class Reference

Container for the boundary size. More...

#include <IJKBoundary.h>

Public Member Functions
	IJKBoundary (const IJKBoundary &other)
IJKBoundary &	operator= (const IJKBoundary &other)
bool	operator== (const IJKBoundary &other) const
void	Init (const int iMinusOffset, const int iPlusOffset, const int jMinusOffset, const int jPlusOffset, const int kMinusOffset, const int kPlusOffset)
	Init the container. More...
int	iMinusOffset () const
	Offset in i-minus direction.
int	iPlusOffset () const
	Offset in i-plus direction.
int	jMinusOffset () const
	Offset in j-minus direction.
int	jPlusOffset () const
	Offset in j-plus direction.
int	kMinusOffset () const
	Offset in k-minus direction.
int	kPlusOffset () const
	Offset in k-plus direction.

Detailed Description

Container for the boundary size.

Container for boundary offsets in all directions of 3D domain. Positive numbers indicate count arrow direction, negative numbers the opposite. Therefore i-/j-/k-minus are typically negative.

///            ^ j-plus
///            |
/// i-minus <-----> i-plus
///            |
///            v j-minus
/// 

Definition at line 36 of file IJKBoundary.h.

Member Function Documentation

Init()

void serialbox::stella::IJKBoundary::Init ( const int  iMinusOffset, const int  iPlusOffset, const int  jMinusOffset, const int  jPlusOffset, const int  kMinusOffset, const int  kPlusOffset  )

inline

Init the container.

Parameters

iMinusOffset	Offset of boundary in i-minus direction of domain
iPlusOffset	Offset of boundary in i-plus direction of domain
jMinusOffset	Offset of boundary in j-minus direction of domain
jPlusOffset	Offset of boundary in j-plus direction of domain
kMinusOffset	Offset of boundary in k-minus direction of domain
kPlusOffset	Offset of boundary in k-plus direction of domain

Definition at line 75 of file IJKBoundary.h.

---

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

• src/serialbox/core/frontend/stella/IJKBoundary.h