IJ_layout Class Reference

: This class describes an IJ plane of an IJK_Field_local. More...

#include <IJ_layout.h>

Public Member Functions
int	ni () const
int	nj () const
int	ghost () const
int	j_stride () const
template<typename T>
	IJ_layout (const T &f)
template<typename T>
T &	operator() (T *origin, int i, int j) const
template<typename T>
const T &	operator() (const T *origin, int i, int j) const
template<typename T>
T &	linear (T *origin, int linear_index) const
template<typename T>
const T &	linear (const T *origin, int linear_index) const
void	linear_to_ij (int linear_index, int &i, int &j) const

Public Attributes
int	ni_
int	nj_
int	ghost_
int	j_stride_

Detailed Description

: This class describes an IJ plane of an IJK_Field_local.

It just encapsulates the offset computation: j * j_stride_ + i with bound checking in debug... This class is usefull to safely optimize the code !

Definition at line 26 of file IJ_layout.h.

Constructor & Destructor Documentation

IJ_layout()

template<typename T>

IJ_layout::IJ_layout ( const T & f )

inline

Definition at line 35 of file IJ_layout.h.

Member Function Documentation

ghost()

int IJ_layout::ghost ( ) const

inline

Definition at line 31 of file IJ_layout.h.

j_stride()

int IJ_layout::j_stride ( ) const

inline

Definition at line 32 of file IJ_layout.h.

linear() [1/2]

template<typename T>

const T & IJ_layout::linear ( const T * origin, int linear_index ) const

inline

Definition at line 65 of file IJ_layout.h.

linear() [2/2]

template<typename T>

T & IJ_layout::linear ( T * origin, int linear_index ) const

inline

Definition at line 57 of file IJ_layout.h.

linear_to_ij()

void IJ_layout::linear_to_ij ( int linear_index, int & i, int & j ) const

inline

Definition at line 72 of file IJ_layout.h.

ni()

int IJ_layout::ni ( ) const

inline

Definition at line 29 of file IJ_layout.h.

nj()

int IJ_layout::nj ( ) const

inline

Definition at line 30 of file IJ_layout.h.

operator()() [1/2]

template<typename T>

const T & IJ_layout::operator() ( const T * origin, int i, int j ) const

inline

Definition at line 48 of file IJ_layout.h.

operator()() [2/2]

template<typename T>

T & IJ_layout::operator() ( T * origin, int i, int j ) const

inline

Definition at line 39 of file IJ_layout.h.

Member Data Documentation

ghost_

int IJ_layout::ghost_

Definition at line 82 of file IJ_layout.h.

j_stride_

int IJ_layout::j_stride_

Definition at line 82 of file IJ_layout.h.

ni_

int IJ_layout::ni_

Definition at line 82 of file IJ_layout.h.

nj_

int IJ_layout::nj_

Definition at line 82 of file IJ_layout.h.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/cea-trust-platform/checkouts/master/src/Kernel/IJK/Champs/IJ_layout.h