IJ_layout

IJ_layout#

#include <IJ_layout.h>
Brief description

: This class describes an IJ plane of an IJK_Field_local.

How to reference this class#

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`IJ\_layout <class-ij-layout>`

[IJ\_layout](#class-ij-layout)

Detailed description#

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

List of Public Methods#

Complete Member Function Documentation#

ghost#

Definition
int IJ_layout::ghost() const
Brief description
Detailed description
References
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`int IJ_layout::ghost() const <ij-layout-public-int-ij-layout-ghost-const>`

[int IJ_layout::ghost() const](#ij-layout-public-int-ij-layout-ghost-const)

IJ_layout#

Definition
IJ_layout::IJ_layout(const T &f)
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`IJ_layout::IJ_layout(const T &f) <ij-layout-public-ij-layout-ij-layout-const-t-ref-f>`

[IJ_layout::IJ_layout(const T &f)](#ij-layout-public-ij-layout-ij-layout-const-t-ref-f)

j_stride#

Definition
int IJ_layout::j_stride() const
Brief description
Detailed description
References
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`int IJ_layout::j_stride() const <ij-layout-public-int-ij-layout-j-stride-const>`

[int IJ_layout::j_stride() const](#ij-layout-public-int-ij-layout-j-stride-const)

linear#

Definition
const T & IJ_layout::linear(const T *origin, int linear_index) const
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`const T & IJ_layout::linear(const T *origin, int linear_index) const <ij-layout-public-const-t-ref-ij-layout-linear-const-t-ptr-origin-int-linear-index-const>`

[const T & IJ_layout::linear(const T *origin, int linear_index) const](#ij-layout-public-const-t-ref-ij-layout-linear-const-t-ptr-origin-int-linear-index-const)

linear#

Definition
T & IJ_layout::linear(T *origin, int linear_index) const
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`T & IJ_layout::linear(T *origin, int linear_index) const <ij-layout-public-t-ref-ij-layout-linear-t-ptr-origin-int-linear-index-const>`

[T & IJ_layout::linear(T *origin, int linear_index) const](#ij-layout-public-t-ref-ij-layout-linear-t-ptr-origin-int-linear-index-const)

linear_to_ij#

Definition
void IJ_layout::linear_to_ij(int linear_index, int &i, int &j) const
Brief description
Detailed description
References
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`void IJ_layout::linear_to_ij(int linear_index, int &i, int &j) const <ij-layout-public-void-ij-layout-linear-to-ij-int-linear-index-int-ref-i-int-ref-j-const>`

[void IJ_layout::linear_to_ij(int linear_index, int &i, int &j) const](#ij-layout-public-void-ij-layout-linear-to-ij-int-linear-index-int-ref-i-int-ref-j-const)

ni#

Definition
int IJ_layout::ni() const
Brief description
Detailed description
References
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`int IJ_layout::ni() const <ij-layout-public-int-ij-layout-ni-const>`

[int IJ_layout::ni() const](#ij-layout-public-int-ij-layout-ni-const)

nj#

Definition
int IJ_layout::nj() const
Brief description
Detailed description
References
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`int IJ_layout::nj() const <ij-layout-public-int-ij-layout-nj-const>`

[int IJ_layout::nj() const](#ij-layout-public-int-ij-layout-nj-const)

operator()#

Definition
const T & IJ_layout::operator()(const T *origin, int i, int j) const
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`const T & IJ_layout::operator()(const T *origin, int i, int j) const <ij-layout-public-const-t-ref-ij-layout-operator-const-t-ptr-origin-int-i-int-j-const>`

[const T & IJ_layout::operator()(const T *origin, int i, int j) const](#ij-layout-public-const-t-ref-ij-layout-operator-const-t-ptr-origin-int-i-int-j-const)

operator()#

Definition
T & IJ_layout::operator()(T *origin, int i, int j) const
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`T & IJ_layout::operator()(T *origin, int i, int j) const <ij-layout-public-t-ref-ij-layout-operator-t-ptr-origin-int-i-int-j-const>`

[T & IJ_layout::operator()(T *origin, int i, int j) const](#ij-layout-public-t-ref-ij-layout-operator-t-ptr-origin-int-i-int-j-const)

Attributes Documentation#

ghost_ (public)
int IJ_layout::ghost_
j_stride_ (public)
int IJ_layout::j_stride_
ni_ (public)
int IJ_layout::ni_
nj_ (public)
int IJ_layout::nj_
Contents