Container for boundary offsets in k direction. More...

#include <KBoundary.h>

Public Member Functions
	KBoundary (const KBoundary &other)

KBoundary &	operator= (const KBoundary &other)

bool	operator== (const KBoundary &other) const

void	Init (const int kMinusOffset, const int kPlusOffset)
	Init the container. More...

int	kMinusOffset () const
	Offset in k-minus direction.

int	kPlusOffset () const
	Offset in k-plus direction

Detailed Description

Container for boundary offsets in k direction.

Positive numbers indicate count arrow direction, negative numbers the opposite. Therefore k-minus is typically negative.

///     ^ k-plus
///     |
///     v k-minus
///

Definition at line 34 of file KBoundary.h.

Member Function Documentation

void serialbox::stella::KBoundary::Init	(	const int	kMinusOffset,
		const int	kPlusOffset
	)

inline

Init the container.

Parameters

kMinusOffset	Offset of boundary in k-minus direction of domain
kPlusOffset	Offset of boundary in k-plus direction of domain

Definition at line 58 of file KBoundary.h.

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