This class implements a accessor to IJK_Field values. More...

#include <ConstIJK_ptr.h>

Inheritance diagram for ConstIJK_ptr< _TYPE_, _TYPE_ARRAY_ >:

Public Member Functions
	ConstIJK_ptr (const IJK_Field_local_template< _TYPE_, _TYPE_ARRAY_ > &field, int i, int j, int k)
	builds a pointer to field(i,j,k);
void	next_j ()
	increments the pointer by j_stride (eg, j = j+1)
void	get_center (int i_offset, _TYPE_ &center) const
	returns field(i+i_offset, j, k)
void	get_left_center (DIRECTION _DIR_, int i_offset, _TYPE_ &left, _TYPE_ &center) const
	returns left=field(i+i_offset-1, j, k) and center=field(i+i_offset, j, k)
void	get_center_right (DIRECTION _DIR_, int i_offset, _TYPE_ &center, _TYPE_ &right) const
void	get_left_center_right (DIRECTION _DIR_, int i_offset, _TYPE_ &left, _TYPE_ &center, _TYPE_ &right) const
void	get_leftleft_left_center_right (DIRECTION _DIR_, int i_offset, _TYPE_ &leftleft, _TYPE_ &left, _TYPE_ &center, _TYPE_ &right) const
void	get_center (int i_offset, Simd_template< _TYPE_ > &center) const
void	get_left_center (DIRECTION _DIR_, int i_offset, Simd_template< _TYPE_ > &left, Simd_template< _TYPE_ > &center) const
void	get_center_right (DIRECTION _DIR_, int i_offset, Simd_template< _TYPE_ > &center, Simd_template< _TYPE_ > &right) const
void	get_left_center_right (DIRECTION _DIR_, int i_offset, Simd_template< _TYPE_ > &left, Simd_template< _TYPE_ > &center, Simd_template< _TYPE_ > &right) const
void	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
void	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

Protected Attributes
const _TYPE_ *	ptr_
int	j_stride_
int	k_stride_
int	i_min_
int	i_max_
int	j_min_
int	j_max_
int	k_min_
int	k_max_
int	i_
int	j_
int	k_

Detailed Description

template<typename _TYPE_, typename _TYPE_ARRAY_>
class ConstIJK_ptr< _TYPE_, _TYPE_ARRAY_ >

This class implements a accessor to IJK_Field values.

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

Definition at line 30 of file ConstIJK_ptr.h.

Constructor & Destructor Documentation

◆ ConstIJK_ptr()

template<typename _TYPE_, typename _TYPE_ARRAY_>

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

inline

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

Definition at line 36 of file ConstIJK_ptr.h.

Member Function Documentation

◆ get_center() [1/2]

template<typename _TYPE_, typename _TYPE_ARRAY_>

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

inline

returns field(i+i_offset, j, k)

Definition at line 68 of file ConstIJK_ptr.h.

◆ get_center() [2/2]

template<typename _TYPE_, typename _TYPE_ARRAY_>

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

inline

Definition at line 186 of file ConstIJK_ptr.h.

◆ get_center_right() [1/2]

template<typename _TYPE_, typename _TYPE_ARRAY_>

void ConstIJK_ptr< _TYPE_, _TYPE_ARRAY_ >::get_center_right	(	DIRECTION	_DIR_,
		int	i_offset,
		_TYPE_ &	center,
		_TYPE_ &	right ) const

inline

Definition at line 101 of file ConstIJK_ptr.h.

◆ get_center_right() [2/2]

template<typename _TYPE_, typename _TYPE_ARRAY_>

void ConstIJK_ptr< _TYPE_, _TYPE_ARRAY_ >::get_center_right	(	DIRECTION	_DIR_,
		int	i_offset,
		Simd_template< _TYPE_ > &	center,
		Simd_template< _TYPE_ > &	right ) const

inline

Definition at line 217 of file ConstIJK_ptr.h.

◆ get_left_center() [1/2]

template<typename _TYPE_, typename _TYPE_ARRAY_>

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

inline

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

Definition at line 77 of file ConstIJK_ptr.h.

◆ get_left_center() [2/2]

template<typename _TYPE_, typename _TYPE_ARRAY_>

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

inline

Definition at line 192 of file ConstIJK_ptr.h.

◆ get_left_center_c1c2()

template<typename _TYPE_, typename _TYPE_ARRAY_>

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

inline

Definition at line 294 of file ConstIJK_ptr.h.

◆ get_left_center_right() [1/2]

template<typename _TYPE_, typename _TYPE_ARRAY_>

void ConstIJK_ptr< _TYPE_, _TYPE_ARRAY_ >::get_left_center_right	(	DIRECTION	_DIR_,
		int	i_offset,
		_TYPE_ &	left,
		_TYPE_ &	center,
		_TYPE_ &	right ) const

inline

Definition at line 126 of file ConstIJK_ptr.h.

◆ get_left_center_right() [2/2]

template<typename _TYPE_, typename _TYPE_ARRAY_>

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

inline

Definition at line 241 of file ConstIJK_ptr.h.

◆ get_leftleft_left_center_right() [1/2]

template<typename _TYPE_, typename _TYPE_ARRAY_>

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

inline

Definition at line 154 of file ConstIJK_ptr.h.

◆ get_leftleft_left_center_right() [2/2]

template<typename _TYPE_, typename _TYPE_ARRAY_>

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

inline

Definition at line 267 of file ConstIJK_ptr.h.

◆ next_j()

template<typename _TYPE_, typename _TYPE_ARRAY_>

void ConstIJK_ptr< _TYPE_, _TYPE_ARRAY_ >::next_j ( )

inline

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

Definition at line 57 of file ConstIJK_ptr.h.

Member Data Documentation

◆ i_

template<typename _TYPE_, typename _TYPE_ARRAY_>

int ConstIJK_ptr< _TYPE_, _TYPE_ARRAY_ >::i_

protected

Definition at line 330 of file ConstIJK_ptr.h.

◆ i_max_

template<typename _TYPE_, typename _TYPE_ARRAY_>

int ConstIJK_ptr< _TYPE_, _TYPE_ARRAY_ >::i_max_

protected

Definition at line 328 of file ConstIJK_ptr.h.

◆ i_min_

template<typename _TYPE_, typename _TYPE_ARRAY_>

int ConstIJK_ptr< _TYPE_, _TYPE_ARRAY_ >::i_min_

protected

Definition at line 328 of file ConstIJK_ptr.h.

◆ j_

template<typename _TYPE_, typename _TYPE_ARRAY_>

int ConstIJK_ptr< _TYPE_, _TYPE_ARRAY_ >::j_

protected

Definition at line 330 of file ConstIJK_ptr.h.

◆ j_max_

template<typename _TYPE_, typename _TYPE_ARRAY_>

int ConstIJK_ptr< _TYPE_, _TYPE_ARRAY_ >::j_max_

protected

Definition at line 328 of file ConstIJK_ptr.h.

◆ j_min_

template<typename _TYPE_, typename _TYPE_ARRAY_>

int ConstIJK_ptr< _TYPE_, _TYPE_ARRAY_ >::j_min_

protected

Definition at line 328 of file ConstIJK_ptr.h.

◆ j_stride_

template<typename _TYPE_, typename _TYPE_ARRAY_>

int ConstIJK_ptr< _TYPE_, _TYPE_ARRAY_ >::j_stride_

protected

Definition at line 324 of file ConstIJK_ptr.h.

◆ k_

template<typename _TYPE_, typename _TYPE_ARRAY_>

int ConstIJK_ptr< _TYPE_, _TYPE_ARRAY_ >::k_

protected

Definition at line 330 of file ConstIJK_ptr.h.

◆ k_max_

template<typename _TYPE_, typename _TYPE_ARRAY_>

int ConstIJK_ptr< _TYPE_, _TYPE_ARRAY_ >::k_max_

protected

Definition at line 328 of file ConstIJK_ptr.h.

◆ k_min_

template<typename _TYPE_, typename _TYPE_ARRAY_>

int ConstIJK_ptr< _TYPE_, _TYPE_ARRAY_ >::k_min_

protected

Definition at line 328 of file ConstIJK_ptr.h.

◆ k_stride_

template<typename _TYPE_, typename _TYPE_ARRAY_>

int ConstIJK_ptr< _TYPE_, _TYPE_ARRAY_ >::k_stride_

protected

Definition at line 325 of file ConstIJK_ptr.h.

◆ ptr_

template<typename _TYPE_, typename _TYPE_ARRAY_>

const _TYPE_* ConstIJK_ptr< _TYPE_, _TYPE_ARRAY_ >::ptr_

protected

Definition at line 323 of file ConstIJK_ptr.h.

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

/home/docs/checkouts/readthedocs.org/user_builds/cea-trust-platform/checkouts/v1.9.8/src/Kernel/IJK/Champs/ConstIJK_ptr.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ConstIJK_ptr()

Member Function Documentation

◆ get_center() [1/2]

◆ get_center() [2/2]

◆ get_center_right() [1/2]

◆ get_center_right() [2/2]

◆ get_left_center() [1/2]

◆ get_left_center() [2/2]

◆ get_left_center_c1c2()

◆ get_left_center_right() [1/2]

◆ get_left_center_right() [2/2]

◆ get_leftleft_left_center_right() [1/2]

◆ get_leftleft_left_center_right() [2/2]

◆ next_j()

Member Data Documentation

◆ i_

◆ i_max_

◆ i_min_

◆ j_

◆ j_max_

◆ j_min_

◆ j_stride_

◆ k_

◆ k_max_

◆ k_min_

◆ k_stride_

◆ ptr_