ConstIJK_ptr

ConstIJK_ptr#

#include <ConstIJK_ptr.h>
Brief description

This class implements a accessor to IJK_Field values.

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:`ConstIJK\_ptr <class-template-constijk-ptr>`

[ConstIJK\_ptr](#class-template-constijk-ptr)

Detailed description#

It provides efficient access to center, left and right neighbours en i, j, and k directions and checks if i,j,k are within the bounds

Inherited by#

  • public : IJK_ptr <_TYPE_, _TYPE_ARRAY_>

Inheritance graph#

If the image is too small, right-click and open in new tab

../../../../../_images/classConstIJK__ptr__inherit__graph.png

List of Public Methods#

List of Private Methods#

Complete Member Function Documentation#

ConstIJK_ptr#

Definition
ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::ConstIJK_ptr(const IJK_Field_local_template< _TYPE_, _TYPE_ARRAY_ > &field, int i, int j, int k)
Brief description

builds a pointer to field(i,j,k);

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:`ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::ConstIJK_ptr(const IJK_Field_local_template< _TYPE_, _TYPE_ARRAY_ > &field, int i, int j, int k) <constijk-ptr-public-constijk-ptr-type-type-array-constijk-ptr-const-ijk-field-local-template-type-type-array-ref-field-int-i-int-j-int-k>`

[ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::ConstIJK_ptr(const IJK_Field_local_template< _TYPE_, _TYPE_ARRAY_ > &field, int i, int j, int k)](#constijk-ptr-public-constijk-ptr-type-type-array-constijk-ptr-const-ijk-field-local-template-type-type-array-ref-field-int-i-int-j-int-k)

get_center#

Definition
void ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_center(int i_offset, _TYPE_ &center) const
Brief description

returns field(i + i_offset, j, k)

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 ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_center(int i_offset, _TYPE_ &center) const <constijk-ptr-public-void-constijk-ptr-type-type-array-get-center-int-i-offset-type-ref-center-const>`

[void ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_center(int i_offset, _TYPE_ &center) const](#constijk-ptr-public-void-constijk-ptr-type-type-array-get-center-int-i-offset-type-ref-center-const)

get_center#

Definition
void ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_center(int i_offset, Simd_template< _TYPE_ > &center) 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 ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_center(int i_offset, Simd_template< _TYPE_ > &center) const <constijk-ptr-public-void-constijk-ptr-type-type-array-get-center-int-i-offset-simd-template-type-ref-center-const>`

[void ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_center(int i_offset, Simd_template< _TYPE_ > &center) const](#constijk-ptr-public-void-constijk-ptr-type-type-array-get-center-int-i-offset-simd-template-type-ref-center-const)

get_center_right#

Definition
void ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_center_right(DIRECTION _DIR_, int i_offset, _TYPE_ &center, _TYPE_ &right) const
Brief description
Detailed description
Referenced By
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 ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_center_right(DIRECTION _DIR_, int i_offset, _TYPE_ &center, _TYPE_ &right) const <constijk-ptr-public-void-constijk-ptr-type-type-array-get-center-right-direction-dir-int-i-offset-type-ref-center-type-ref-right-const>`

[void ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_center_right(DIRECTION _DIR_, int i_offset, _TYPE_ &center, _TYPE_ &right) const](#constijk-ptr-public-void-constijk-ptr-type-type-array-get-center-right-direction-dir-int-i-offset-type-ref-center-type-ref-right-const)

get_center_right#

Definition
void ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_center_right(DIRECTION _DIR_, int i_offset, Simd_template< _TYPE_ > &center, Simd_template< _TYPE_ > &right) 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:`void ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_center_right(DIRECTION _DIR_, int i_offset, Simd_template< _TYPE_ > &center, Simd_template< _TYPE_ > &right) const <constijk-ptr-public-void-constijk-ptr-type-type-array-get-center-right-direction-dir-int-i-offset-simd-template-type-ref-center-simd-template-type-ref-right-const>`

[void ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_center_right(DIRECTION _DIR_, int i_offset, Simd_template< _TYPE_ > &center, Simd_template< _TYPE_ > &right) const](#constijk-ptr-public-void-constijk-ptr-type-type-array-get-center-right-direction-dir-int-i-offset-simd-template-type-ref-center-simd-template-type-ref-right-const)

get_left_center#

Definition
void ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_left_center(DIRECTION _DIR_, int i_offset, _TYPE_ &left, _TYPE_ &center) const
Brief description

returns left = field(i + i_offset - 1, j, k) and center = field(i + i_offset, j, k)

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:`void ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_left_center(DIRECTION _DIR_, int i_offset, _TYPE_ &left, _TYPE_ &center) const <constijk-ptr-public-void-constijk-ptr-type-type-array-get-left-center-direction-dir-int-i-offset-type-ref-left-type-ref-center-const>`

[void ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_left_center(DIRECTION _DIR_, int i_offset, _TYPE_ &left, _TYPE_ &center) const](#constijk-ptr-public-void-constijk-ptr-type-type-array-get-left-center-direction-dir-int-i-offset-type-ref-left-type-ref-center-const)

get_left_center#

Definition
void ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_left_center(DIRECTION _DIR_, int i_offset, Simd_template< _TYPE_ > &left, Simd_template< _TYPE_ > &center) 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:`void ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_left_center(DIRECTION _DIR_, int i_offset, Simd_template< _TYPE_ > &left, Simd_template< _TYPE_ > &center) const <constijk-ptr-public-void-constijk-ptr-type-type-array-get-left-center-direction-dir-int-i-offset-simd-template-type-ref-left-simd-template-type-ref-center-const>`

[void ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_left_center(DIRECTION _DIR_, int i_offset, Simd_template< _TYPE_ > &left, Simd_template< _TYPE_ > &center) const](#constijk-ptr-public-void-constijk-ptr-type-type-array-get-left-center-direction-dir-int-i-offset-simd-template-type-ref-left-simd-template-type-ref-center-const)

get_left_center_c1c2#

Definition
void ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_left_center_c1c2(DIRECTION _COMPO1_, DIRECTION _COMPO2_, int i_offset, Simd_template< _TYPE_ > &leftc1_leftc2, Simd_template< _TYPE_ > &leftc1_centerc2, Simd_template< _TYPE_ > &centerc1_leftc2, Simd_template< _TYPE_ > &centerc1_centerc2) 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:`void ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_left_center_c1c2(DIRECTION _COMPO1_, DIRECTION _COMPO2_, int i_offset, Simd_template< _TYPE_ > &leftc1_leftc2, Simd_template< _TYPE_ > &leftc1_centerc2, Simd_template< _TYPE_ > &centerc1_leftc2, Simd_template< _TYPE_ > &centerc1_centerc2) const <constijk-ptr-public-void-constijk-ptr-type-type-array-get-left-center-c1c2-direction-compo1-direction-compo2-int-i-offset-simd-template-type-ref-leftc1-leftc2-simd-template-type-ref-leftc1-centerc2-simd-template-type-ref-centerc1-leftc2-simd-template-type-ref-centerc1-centerc2-const>`

[void ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_left_center_c1c2(DIRECTION _COMPO1_, DIRECTION _COMPO2_, int i_offset, Simd_template< _TYPE_ > &leftc1_leftc2, Simd_template< _TYPE_ > &leftc1_centerc2, Simd_template< _TYPE_ > &centerc1_leftc2, Simd_template< _TYPE_ > &centerc1_centerc2) const](#constijk-ptr-public-void-constijk-ptr-type-type-array-get-left-center-c1c2-direction-compo1-direction-compo2-int-i-offset-simd-template-type-ref-leftc1-leftc2-simd-template-type-ref-leftc1-centerc2-simd-template-type-ref-centerc1-leftc2-simd-template-type-ref-centerc1-centerc2-const)

get_left_center_right#

Definition
void ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_left_center_right(DIRECTION _DIR_, int i_offset, _TYPE_ &left, _TYPE_ &center, _TYPE_ &right) 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:`void ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_left_center_right(DIRECTION _DIR_, int i_offset, _TYPE_ &left, _TYPE_ &center, _TYPE_ &right) const <constijk-ptr-public-void-constijk-ptr-type-type-array-get-left-center-right-direction-dir-int-i-offset-type-ref-left-type-ref-center-type-ref-right-const>`

[void ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_left_center_right(DIRECTION _DIR_, int i_offset, _TYPE_ &left, _TYPE_ &center, _TYPE_ &right) const](#constijk-ptr-public-void-constijk-ptr-type-type-array-get-left-center-right-direction-dir-int-i-offset-type-ref-left-type-ref-center-type-ref-right-const)

get_left_center_right#

Definition
void ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_left_center_right(DIRECTION _DIR_, int i_offset, Simd_template< _TYPE_ > &left, Simd_template< _TYPE_ > &center, Simd_template< _TYPE_ > &right) 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:`void ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_left_center_right(DIRECTION _DIR_, int i_offset, Simd_template< _TYPE_ > &left, Simd_template< _TYPE_ > &center, Simd_template< _TYPE_ > &right) const <constijk-ptr-public-void-constijk-ptr-type-type-array-get-left-center-right-direction-dir-int-i-offset-simd-template-type-ref-left-simd-template-type-ref-center-simd-template-type-ref-right-const>`

[void ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_left_center_right(DIRECTION _DIR_, int i_offset, Simd_template< _TYPE_ > &left, Simd_template< _TYPE_ > &center, Simd_template< _TYPE_ > &right) const](#constijk-ptr-public-void-constijk-ptr-type-type-array-get-left-center-right-direction-dir-int-i-offset-simd-template-type-ref-left-simd-template-type-ref-center-simd-template-type-ref-right-const)

get_leftleft_left_center_right#

Definition
void ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_leftleft_left_center_right(DIRECTION _DIR_, int i_offset, _TYPE_ &leftleft, _TYPE_ &left, _TYPE_ &center, _TYPE_ &right) 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:`void ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_leftleft_left_center_right(DIRECTION _DIR_, int i_offset, _TYPE_ &leftleft, _TYPE_ &left, _TYPE_ &center, _TYPE_ &right) const <constijk-ptr-public-void-constijk-ptr-type-type-array-get-leftleft-left-center-right-direction-dir-int-i-offset-type-ref-leftleft-type-ref-left-type-ref-center-type-ref-right-const>`

[void ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_leftleft_left_center_right(DIRECTION _DIR_, int i_offset, _TYPE_ &leftleft, _TYPE_ &left, _TYPE_ &center, _TYPE_ &right) const](#constijk-ptr-public-void-constijk-ptr-type-type-array-get-leftleft-left-center-right-direction-dir-int-i-offset-type-ref-leftleft-type-ref-left-type-ref-center-type-ref-right-const)

get_leftleft_left_center_right#

Definition
void ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_leftleft_left_center_right(DIRECTION _DIR_, int i_offset, Simd_template< _TYPE_ > &leftleft, Simd_template< _TYPE_ > &left, Simd_template< _TYPE_ > &center, Simd_template< _TYPE_ > &right) 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:`void ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_leftleft_left_center_right(DIRECTION _DIR_, int i_offset, Simd_template< _TYPE_ > &leftleft, Simd_template< _TYPE_ > &left, Simd_template< _TYPE_ > &center, Simd_template< _TYPE_ > &right) const <constijk-ptr-public-void-constijk-ptr-type-type-array-get-leftleft-left-center-right-direction-dir-int-i-offset-simd-template-type-ref-leftleft-simd-template-type-ref-left-simd-template-type-ref-center-simd-template-type-ref-right-const>`

[void ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_leftleft_left_center_right(DIRECTION _DIR_, int i_offset, Simd_template< _TYPE_ > &leftleft, Simd_template< _TYPE_ > &left, Simd_template< _TYPE_ > &center, Simd_template< _TYPE_ > &right) const](#constijk-ptr-public-void-constijk-ptr-type-type-array-get-leftleft-left-center-right-direction-dir-int-i-offset-simd-template-type-ref-leftleft-simd-template-type-ref-left-simd-template-type-ref-center-simd-template-type-ref-right-const)

next_j#

Definition
void ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::next_j()
Brief description

increments the pointer by j_stride (eg, j = j + 1)

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 ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::next_j() <constijk-ptr-public-void-constijk-ptr-type-type-array-next-j>`

[void ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::next_j()](#constijk-ptr-public-void-constijk-ptr-type-type-array-next-j)

get_stride#

Definition
int ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_stride(DIRECTION _COMPO_)
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:`int ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_stride(DIRECTION _COMPO_) <constijk-ptr-private-int-constijk-ptr-type-type-array-get-stride-direction-compo>`

[int ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::get_stride(DIRECTION _COMPO_)](#constijk-ptr-private-int-constijk-ptr-type-type-array-get-stride-direction-compo)

Attributes Documentation#

i_ (protected)
int ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::i_
i_max_ (protected)
int ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::i_max_
i_min_ (protected)
int ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::i_min_
j_ (protected)
int ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::j_
j_max_ (protected)
int ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::j_max_
j_min_ (protected)
int ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::j_min_
j_stride_ (protected)
int ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::j_stride_
k_ (protected)
int ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::k_
k_max_ (protected)
int ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::k_max_
k_min_ (protected)
int ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::k_min_
k_stride_ (protected)
int ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::k_stride_
ptr_ (protected)
const _TYPE_* ConstIJK_ptr<_TYPE_, _TYPE_ARRAY_>::ptr_
Contents