SLIP  1.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
slip::RegularVector3dField3d< T, GridT > Class Template Reference

This is a Regular Vector3d Field. This container statisfies the BidirectionnalContainer concepts of the STL. It is also an 3d extension of the RandomAccessContainer concept. That is to say the bracket element access is replaced by the triple bracket element access. It is a specialization of GenericMultiComponent3d using slip::Vector3d blocks. It implements arithmetic and mathematical operators (divergence, vorticity, derivative...) and read/write methods (tecplot file format). The points of the Vector field grid are assumed to be spaced by two regular steps. The inital point (closest point from the physical axis origin) of the grid is also stored within the data structure. More...

#include <RegularVector3dField3d.hpp>

Inheritance diagram for slip::RegularVector3dField3d< T, GridT >:
Inheritance graph

Public Types

typedef slip::Vector3d< T > value_type
 
typedef RegularVector3dField3d
< T, GridT > 
self
 
typedef const
RegularVector3dField3d< T,
GridT > 
const_self
 
typedef
GenericMultiComponent3d
< slip::Vector3d< T > > 
base
 
typedef value_typepointer
 
typedef const value_typeconst_pointer
 
typedef value_typereference
 
typedef const value_typeconst_reference
 
typedef ptrdiff_t difference_type
 
typedef std::size_t size_type
 
typedef pointer iterator
 
typedef const_pointer const_iterator
 
typedef std::reverse_iterator
< iterator
reverse_iterator
 
typedef std::reverse_iterator
< const_iterator
const_reverse_iterator
 
typedef pointer row_iterator
 
typedef const_pointer const_row_iterator
 
typedef slip::stride_iterator
< pointer
col_iterator
 
typedef slip::stride_iterator
< const_pointer
const_col_iterator
 
typedef std::reverse_iterator
< iterator
reverse_row_iterator
 
typedef std::reverse_iterator
< const_iterator
const_reverse_row_iterator
 
typedef std::reverse_iterator
< col_iterator
reverse_col_iterator
 
typedef std::reverse_iterator
< const_col_iterator
const_reverse_col_iterator
 
typedef
slip::GenericMultiComponent3d
< slip::Vector3d< T >
>::iterator3d 
iterator3d
 
typedef
slip::GenericMultiComponent3d
< slip::Vector3d< T >
>::const_iterator2d 
const_iterator3d
 
typedef T vector3d_value_type
 
typedef GridT grid_value_type
 
typedef vector3d_value_typevector3d_pointer
 
typedef const vector3d_value_typeconst_vector3d_pointer
 
typedef vector3d_value_typevector3d_reference
 
typedef const vector3d_value_type const_vector3d_reference
 
typedef slip::kstride_iterator
< vector3d_pointer, 3 > 
vector3d_iterator
 
typedef slip::kstride_iterator
< const_vector3d_pointer, 3 > 
const_vector3d_iterator
 
typedef slip::lin_alg_traits
< value_type >::value_type 
norm_type
 
typedef slip::stride_iterator
< pointer
slice_iterator
 
typedef slip::stride_iterator
< const_pointer
const_slice_iterator
 
typedef slip::stride_iterator
< slice_iterator
slice_range_iterator
 
typedef slip::stride_iterator
< const_slice_iterator
const_slice_range_iterator
 
typedef slip::stride_iterator
< pointer
row_range_iterator
 
typedef slip::stride_iterator
< const_pointer
const_row_range_iterator
 
typedef slip::stride_iterator
< col_iterator
col_range_iterator
 
typedef slip::stride_iterator
< const_col_iterator
const_col_range_iterator
 
typedef std::reverse_iterator
< slice_iterator
reverse_slice_iterator
 
typedef std::reverse_iterator
< const_slice_iterator
const_reverse_slice_iterator
 
typedef std::reverse_iterator
< slice_range_iterator
reverse_slice_range_iterator
 
typedef std::reverse_iterator
< const_slice_range_iterator
const_reverse_slice_range_iterator
 
typedef std::reverse_iterator
< row_range_iterator
reverse_row_range_iterator
 
typedef std::reverse_iterator
< const_row_range_iterator
const_reverse_row_range_iterator
 
typedef std::reverse_iterator
< col_range_iterator
reverse_col_range_iterator
 
typedef std::reverse_iterator
< const_col_range_iterator
const_reverse_col_range_iterator
 
typedef slip::Array3d
< slip::Vector3d< T >
>::iterator2d 
iterator2d
 
typedef slip::Array3d
< slip::Vector3d< T >
>::const_iterator2d 
const_iterator2d
 
typedef std::reverse_iterator
< iterator2d
reverse_iterator2d
 
typedef std::reverse_iterator
< const_iterator2d
const_reverse_iterator2d
 
typedef slip::Array3d
< slip::Vector3d< T >
>::iterator3d_range 
iterator3d_range
 
typedef slip::Array3d
< slip::Vector3d< T >
>::const_iterator3d_range 
const_iterator3d_range
 
typedef std::reverse_iterator
< iterator3d
reverse_iterator3d
 
typedef std::reverse_iterator
< const_iterator3d
const_reverse_iterator3d
 
typedef std::reverse_iterator
< iterator3d_range
reverse_iterator3d_range
 
typedef std::reverse_iterator
< const_iterator3d_range
const_reverse_iterator3d_range
 
typedef slip::Vector3d< T >
::value_type 
block_value_type
 
typedef block_value_typeblock_pointer
 
typedef const block_value_typeconst_block_pointer
 
typedef block_value_typeblock_reference
 
typedef const block_value_type const_block_reference
 
typedef slip::kstride_iterator
< typename slip::Vector3d< T >
::pointer, slip::Vector3d< T >
::SIZE > 
component_iterator
 
typedef slip::kstride_iterator
< typename slip::Vector3d< T >
::const_pointer,
slip::Vector3d< T >::SIZE > 
const_component_iterator
 
typedef std::reverse_iterator
< component_iterator
reverse_component_iterator
 
typedef std::reverse_iterator
< const_component_iterator
const_reverse_component_iterator
 
typedef slip::stride_iterator
< block_pointer
component_slice_iterator
 
typedef slip::stride_iterator
< const_block_pointer
const_component_slice_iterator
 
typedef slip::stride_iterator
< block_pointer
component_slice_range_iterator
 
typedef slip::stride_iterator
< const_block_pointer
const_component_slice_range_iterator
 
typedef component_iterator component_row_iterator
 
typedef const_component_iterator const_component_row_iterator
 
typedef slip::stride_iterator
< block_pointer
component_row_range_iterator
 
typedef slip::stride_iterator
< const_block_pointer
const_component_row_range_iterator
 
typedef slip::stride_iterator
< block_pointer
component_col_iterator
 
typedef slip::stride_iterator
< const_block_pointer
const_component_col_iterator
 
typedef slip::stride_iterator
< block_pointer
component_col_range_iterator
 
typedef slip::stride_iterator
< const_block_pointer
const_component_col_range_iterator
 
typedef std::reverse_iterator
< component_slice_iterator
reverse_component_slice_iterator
 
typedef std::reverse_iterator
< const_component_slice_iterator
const_reverse_component_slice_iterator
 
typedef std::reverse_iterator
< component_slice_range_iterator
reverse_component_slice_range_iterator
 
typedef std::reverse_iterator
< const_component_slice_range_iterator
const_reverse_component_slice_range_iterator
 
typedef std::reverse_iterator
< component_row_iterator
reverse_component_row_iterator
 
typedef std::reverse_iterator
< const_component_row_iterator
const_reverse_component_row_iterator
 
typedef std::reverse_iterator
< component_row_range_iterator
reverse_component_row_range_iterator
 
typedef std::reverse_iterator
< const_component_row_range_iterator
const_reverse_component_row_range_iterator
 
typedef std::reverse_iterator
< component_col_iterator
reverse_component_col_iterator
 
typedef std::reverse_iterator
< const_component_col_iterator
const_reverse_component_col_iterator
 
typedef std::reverse_iterator
< component_col_range_iterator
reverse_component_col_range_iterator
 
typedef std::reverse_iterator
< const_component_col_range_iterator
const_reverse_component_col_range_iterator
 
typedef
slip::component_iterator3d_box
< self, slip::Vector3d< T >
::SIZE > 
component_iterator3d
 
typedef std::reverse_iterator
< component_iterator3d
reverse_component_iterator3d
 
typedef
slip::const_component_iterator3d_box
< const_self, slip::Vector3d
< T >::SIZE > 
const_component_iterator3d
 
typedef std::reverse_iterator
< const_component_iterator3d
const_reverse_component_iterator3d
 
typedef
slip::component_iterator3d_range
< self, slip::Vector3d< T >
::SIZE > 
component_iterator3d_range
 
typedef std::reverse_iterator
< component_iterator3d_range
reverse_component_iterator3d_range
 
typedef
slip::const_component_iterator3d_range
< const_self, slip::Vector3d
< T >::SIZE > 
const_component_iterator3d_range
 
typedef std::reverse_iterator
< const_component_iterator3d_range
const_reverse_component_iterator3d_range
 
typedef iterator3d default_iterator
 
typedef const_iterator3d const_default_iterator
 

Public Member Functions

std::string name () const
 Returns the name of the class. More...
 
void resize (const size_type slices, const size_type rows, const size_type cols, const slip::Vector3d< T > &val=slip::Vector3d< T >())
 Resizes a GenericMultiComponent3d. More...
 
size_type dim1 () const
 Returns the number of slices (first dimension size) in the GenericMultiComponent3d. More...
 
size_type slices () const
 Returns the number of slices (first dimension size) in the GenericMultiComponent3d. More...
 
size_type dim2 () const
 Returns the number of rows (second dimension size) in the GenericMultiComponent3d. More...
 
size_type rows () const
 Returns the number of rows (first dimension size) in the GenericMultiComponent3d. More...
 
size_type dim3 () const
 Returns the number of columns (third dimension size) in the GenericMultiComponent3d. More...
 
size_type columns () const
 Returns the number of columns (third dimension size) in the GenericMultiComponent3d. More...
 
size_type cols () const
 Returns the number of columns (third dimension size) in the GenericMultiComponent3d. More...
 
size_type size () const
 Returns the number of elements in the GenericMultiComponent3d. More...
 
size_type max_size () const
 Returns the maximal size (number of elements) in the GenericMultiComponent3d. More...
 
size_type slice_size () const
 Returns the number of elements in a slice of the GenericMultiComponent3d. More...
 
bool empty () const
 Returns true if the GenericMultiComponent3d is empty. (Thus size() == 0) More...
 
void swap (self &M)
 Swaps data with another GenericMultiComponent3d. More...
 
slip::Vector3d< T > min () const
 Returns the min elements of the GenericMultiComponent3d according to the operator <. More...
 
slip::Vector3d< T > max () const
 Returns the max elements of the GenericMultiComponent3d according to the operator <. More...
 
GenericMultiComponent3d
< slip::Vector3d< T > > & 
apply (slip::Vector3d< T >(*fun)(slip::Vector3d< T >))
 Returns the sums of the elements of the GenericMultiComponent3d. More...
 
GenericMultiComponent3d
< slip::Vector3d< T > > & 
apply (slip::Vector3d< T >(*fun)(const slip::Vector3d< T > &))
 Applys the one-parameter C-function fun to each element of the GenericMultiComponent3d. More...
 
Constructors & Destructors
 RegularVector3dField3d ()
 Constructs a RegularVector3dField3d. More...
 
 RegularVector3dField3d (const size_type slices, const size_type rows, const size_type cols)
 Constructs a RegularVector3dField3d. More...
 
 RegularVector3dField3d (const size_type slices, const size_type rows, const size_type cols, const slip::Point3d< GridT > &init_point, const slip::Point3d< GridT > &grid_step)
 Constructs a RegularVector3dField3d. More...
 
 RegularVector3dField3d (const size_type slices, const size_type rows, const size_type cols, const slip::Vector3d< T > &val)
 Constructs a RegularVector3dField3d initialized by the scalar value val. More...
 
 RegularVector3dField3d (const size_type slices, const size_type rows, const size_type cols, const slip::Point3d< GridT > &init_point, const slip::Point3d< GridT > &grid_step, const slip::Vector3d< T > &val)
 Constructs a RegularVector3dField3d initialized by the scalar value val. More...
 
 RegularVector3dField3d (const size_type slices, const size_type rows, const size_type cols, const T *val)
 Constructs a RegularVector3dField3d initialized by an array val. More...
 
 RegularVector3dField3d (const size_type slices, const size_type rows, const size_type cols, const slip::Point3d< GridT > &init_point, const slip::Point3d< GridT > &grid_step, const T *val)
 Constructs a RegularVector3dField3d initialized by an array val. More...
 
 RegularVector3dField3d (const size_type slices, const size_type rows, const size_type cols, const slip::Vector3d< T > *val)
 Constructs a RegularVector3dField3d initialized by an array val. More...
 
 RegularVector3dField3d (const size_type slices, const size_type rows, const size_type cols, const slip::Point3d< GridT > &init_point, const slip::Point3d< GridT > &grid_step, const slip::Vector3d< T > *val)
 Constructs a RegularVector3dField3d initialized by an array val. More...
 
template<typename InputIterator >
 RegularVector3dField3d (const size_type slices, const size_type rows, const size_type cols, InputIterator first, InputIterator last)
 Contructs a RegularVector3dField3d from a range. More...
 
template<typename InputIterator >
 RegularVector3dField3d (const size_type slices, const size_type rows, const size_type cols, const slip::Point3d< GridT > &init_point, const slip::Point3d< GridT > &grid_step, InputIterator first, InputIterator last)
 Contructs a RegularVector3dField3d from a range. More...
 
template<typename InputIterator >
 RegularVector3dField3d (const size_type slices, const size_type rows, const size_type cols, InputIterator first1, InputIterator last1, InputIterator first2, InputIterator first3)
 Contructs a RegularVector3dField3d from a 3 ranges. More...
 
template<typename InputIterator >
 RegularVector3dField3d (const size_type slices, const size_type rows, const size_type cols, const slip::Point3d< GridT > &init_point, const slip::Point3d< GridT > &grid_step, InputIterator first1, InputIterator last1, InputIterator first2, InputIterator first3)
 Contructs a RegularVector3dField3d from a 3 ranges. More...
 
 RegularVector3dField3d (const self &rhs)
 Constructs a copy of the RegularVector3dField3d rhs. More...
 
 ~RegularVector3dField3d ()
 Destructor of the RegularVector3dField3d. More...
 
Assignment operators and methods
selfoperator= (const slip::Vector3d< T > &val)
 Affects all the element of the RegularVector3dField3d by val. More...
 
selfoperator= (const T &val)
 Affects all the element of the RegularVector3dField3d by val. More...
 
Element access operators
T & Vx1 (const size_type k, const size_type i, const size_type j)
 Subscript access to first element of the data contained in the RegularVector3dField3d. More...
 
const T & Vx1 (const size_type k, const size_type i, const size_type j) const
 Subscript access to first element of the data contained in the RegularVector3dField3d. More...
 
T & u (const size_type k, const size_type i, const size_type j)
 Subscript access to first element of the data contained in the RegularVector3dField3d. More...
 
const T & u (const size_type k, const size_type i, const size_type j) const
 Subscript access to first element of the data contained in the RegularVector3dField3d. More...
 
T & Vx2 (const size_type k, const size_type i, const size_type j)
 Subscript access to second element of the data contained in the RegularVector3dField3d. More...
 
const T & Vx2 (const size_type k, const size_type i, const size_type j) const
 Subscript access to second element of the data contained in the RegularVector3dField3d. More...
 
T & v (const size_type k, const size_type i, const size_type j)
 Subscript access to second element of the data contained in the RegularVector3dField3d. More...
 
const T & v (const size_type k, const size_type i, const size_type j) const
 Subscript access to second element of the data contained in the RegularVector3dField3d. More...
 
T & Vx3 (const size_type k, const size_type i, const size_type j)
 Subscript access to third element of the data contained in the RegularVector3dField3d. More...
 
const T & Vx3 (const size_type k, const size_type i, const size_type j) const
 Subscript access to third element of the data contained in the RegularVector3dField3d. More...
 
T & w (const size_type k, const size_type i, const size_type j)
 Subscript access to third element of the data contained in the RegularVector3dField3d. More...
 
const T & w (const size_type k, const size_type i, const size_type j) const
 Subscript access to third element of the data contained in the RegularVector3dField3d. More...
 
norm_type norm (const size_type k, const size_type i, const size_type j) const
 Subscript access to a local norm contained in the RegularVector3dField3d. More...
 
const GridT x1 (const size_type k, const size_type i, const size_type j) const
 Subscript access to the real x1 value of the indexed (k,i,j) point of the RegularVector3dField3d. More...
 
const GridT x2 (const size_type k, const size_type i, const size_type j) const
 Subscript access to the real x2 value of the indexed (k,i,j) point of the RegularVector3dField3d. More...
 
const GridT x3 (const size_type k, const size_type i, const size_type j) const
 Subscript access to the real x3 value of the indexed (k,i,j) point of the RegularVector3dField3d. More...
 
const GridT x (const size_type k, const size_type i, const size_type j) const
 Subscript access to the real x1 value of the indexed (k,i,j) point of the RegularVector3dField3d. More...
 
const GridT y (const size_type k, const size_type i, const size_type j) const
 Subscript access to the real x2 value of the indexed (k,i,j) point of the RegularVector3dField3d. More...
 
const GridT z (const size_type k, const size_type i, const size_type j) const
 Subscript access to the real x3 value of the indexed (k,i,j) point of the RegularVector3dField3d. More...
 
void set_init_point (const slip::Point3d< GridT > &init_point)
 Write access to the init point of the grid. More...
 
const slip::Point3d< GridT > & get_init_point () const
 Read access to the init point of the grid. More...
 
void set_grid_step (const slip::Point3d< GridT > &grid_step)
 Write access to the grid step of the grid. More...
 
const slip::Point3d< GridT > & get_grid_step () const
 Read access to the init point of the grid. More...
 
Arithmetic operators
selfoperator+= (const T &val)
 Add val to each element of the RegularVector3dField3d. More...
 
selfoperator-= (const T &val)
 
selfoperator*= (const T &val)
 
selfoperator/= (const T &val)
 
self operator- () const
 
selfoperator+= (const slip::Vector3d< T > &val)
 Add val to each element of the RegularVector3dField3d. More...
 
selfoperator-= (const slip::Vector3d< T > &val)
 
selfoperator*= (const slip::Vector3d< T > &val)
 
selfoperator/= (const slip::Vector3d< T > &val)
 
selfoperator+= (const self &rhs)
 
selfoperator-= (const self &rhs)
 
selfoperator*= (const self &rhs)
 
selfoperator/= (const self &rhs)
 
Mathematical operators
template<typename Container3D >
void derivative (const std::size_t component, const slip::SPATIAL_DIRECTION der_dir, const std::size_t der_order, const std::size_t sch_order, Container3D &result) const
 Computes finite differences derivatives of a RegularVector3dField3d. More...
 
template<typename Container3D >
void derivative (const std::size_t component, const slip::SPATIAL_DIRECTION der_dir, const std::size_t der_order, const std::size_t sch_order, const slip::Box3d< int > box, Container3D &result) const
 Computes finite differences derivatives of a RegularVector3dField3d in a box. More...
 
template<typename Container3D >
void divergence (const std::size_t sch_order, Container3D &result) const
 Computes finite differences divergence of a RegularVector3dField3d. More...
 
template<typename Container3D >
void vorticity (const std::size_t sch_order, Container3D &result) const
 Computes finite differences vorticity of a RegularVector3dField3d. More...
 
template<typename Container3D , typename Container3D1 , typename Container3D2 , typename Container3D3 >
void lambda (const std::size_t sch_order, Container3D &Lambda, Container3D1 &LambdaV1, Container3D2 &LambdaV2, Container3D3 &LambdaV3) const
 Computes finite differences lambda of a RegularVector3dField3d. More...
 
template<typename Container3D >
void lambda (const std::size_t sch_order, Container3D &Lambda) const
 Computes finite differences lambda of a RegularVector3dField3d. More...
 
template<typename Container3D >
void norm (Container3D &result) const
 Computes Eucliean norm of each element in the field and write it to a Container3D. More...
 
One dimensional global iterators
iterator begin ()
 Returns a read/write iterator that points to the first element in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...
 
const_iterator begin () const
 Returns a read-only (constant) iterator that points to the first element in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...
 
iterator end ()
 Returns a read/write iterator that points one past the last element in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...
 
const_iterator end () const
 Returns a read-only (constant) iterator that points one past the last element in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...
 
reverse_iterator rbegin ()
 Returns a read/write reverse iterator that points to the last element in the GenericMultiComponent3d. Iteration is done in reverse element order. More...
 
const_reverse_iterator rbegin () const
 Returns a read-only (constant) reverse iterator that points to the last element in the GenericMultiComponent3d. Iteration is done in reverse element order. More...
 
reverse_iterator rend ()
 Returns a read/write reverse iterator that points to one before the first element in the GenericMultiComponent3d. Iteration is done in reverse element order. More...
 
const_reverse_iterator rend () const
 Returns a read-only (constant) reverse iterator that points to one before the first element in the GenericMultiComponent3d. Iteration is done in reverse element order. More...
 
One dimensional component global iterators
component_iterator begin (const std::size_t component)
 Returns a read/write iterator that points to the first element in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...
 
const_component_iterator begin (const std::size_t component) const
 Returns a read-only (constant) iterator that points to the first element in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...
 
component_iterator end (const std::size_t component)
 Returns a read/write iterator that points one past the last element in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...
 
const_component_iterator end (const std::size_t component) const
 Returns a read-only (constant) iterator that points one past the last element in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...
 
reverse_component_iterator rbegin (const std::size_t component)
 Returns a read/write iterator that points to the first element in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...
 
const_reverse_component_iterator rbegin (const std::size_t component) const
 Returns a read-only (constant) iterator that points to the first element in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...
 
reverse_component_iterator rend (const std::size_t component)
 Returns a read/write iterator that points one past the last element in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...
 
const_reverse_component_iterator rend (const std::size_t component) const
 Returns a read-only (constant) iterator that points one past the last element in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...
 
One dimensional slice iterators
slice_iterator slice_begin (const size_type row, const size_type col)
 Returns a read/write iterator that points to the first element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order (increasing slice number). More...
 
const_slice_iterator slice_begin (const size_type row, const size_type col) const
 Returns a read-only (constant) iterator that points to the first element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order (increasing slice number). More...
 
slice_iterator slice_end (const size_type row, const size_type col)
 Returns a read/write iterator that points to the one past the end element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order (increasing slice number). More...
 
const_slice_iterator slice_end (const size_type row, const size_type col) const
 Returns a read-only (constant) iterator that points to the one past the end element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order (increasing slice number). More...
 
reverse_slice_iterator slice_rbegin (const size_type row, const size_type col)
 Returns a read/write iterator that points to the last element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order (decreasing slice number). More...
 
const_reverse_slice_iterator slice_rbegin (const size_type row, const size_type col) const
 Returns a read-only (constant) iterator that points to the last element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order (decreasing slice number). More...
 
reverse_slice_iterator slice_rend (const size_type row, const size_type col)
 Returns a read/write iterator that points to the one before the first element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order (decreasing slice number). More...
 
const_reverse_slice_iterator slice_rend (const size_type row, const size_type col) const
 Returns a read (constant) iterator that points to the one before the first element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order (decreasing slice number). More...
 
One dimensional slice range iterators
slice_range_iterator slice_begin (const size_type row, const size_type col, const slip::Range< int > &range)
 Returns a read/write iterator that points to the first element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...
 
const_slice_range_iterator slice_begin (const size_type row, const size_type col, const slip::Range< int > &range) const
 Returns a read only (constant) iterator that points to the first element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...
 
slice_range_iterator slice_end (const size_type row, const size_type col, const slip::Range< int > &range)
 Returns a read/write iterator that points one past the end element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...
 
const_slice_range_iterator slice_end (const size_type row, const size_type col, const slip::Range< int > &range) const
 Returns a read_only iterator that points one past the last element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...
 
reverse_slice_range_iterator slice_rbegin (const size_type row, const size_type col, const slip::Range< int > &range)
 Returns a read/write iterator that points to the last element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...
 
const_reverse_slice_range_iterator slice_rbegin (const size_type row, const size_type col, const slip::Range< int > &range) const
 Returns a read only (constant) iterator that points to the last element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order according to the Range. More...
 
reverse_slice_range_iterator slice_rend (const size_type row, const size_type col, const slip::Range< int > &range)
 Returns a read/write iterator that points to the first element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order according to the Range. More...
 
const_reverse_slice_range_iterator slice_rend (const size_type row, const size_type col, const slip::Range< int > &range) const
 Returns a read_only iterator that points one past the lastto the first element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order according to the Range. More...
 
One dimensional component slice iterators
component_slice_iterator slice_begin (const std::size_t component, const size_type row, const size_type col)
 Returns a read/write iterator that points to the first element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order (increasing slice number). More...
 
const_component_slice_iterator slice_begin (const std::size_t component, const size_type row, const size_type col) const
 Returns a read-only (constant) iterator that points to the first element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order (increasing slice number). More...
 
component_slice_iterator slice_end (const std::size_t component, const size_type row, const size_type col)
 Returns a read/write iterator that points to the one past the end element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order (increasing slice number). More...
 
const_component_slice_iterator slice_end (const std::size_t component, const size_type row, const size_type col) const
 Returns a read-only (constant) iterator that points to the one past the end element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order (increasing slice number). More...
 
reverse_component_slice_iterator slice_rbegin (const std::size_t component, const size_type row, const size_type col)
 Returns a read/write iterator that points to the last element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order (decreasing slice number). More...
 
const_reverse_component_slice_iterator slice_rbegin (const std::size_t component, const size_type row, const size_type col) const
 Returns a read-only (constant) iterator that points to the last element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order (decreasing slice number). More...
 
reverse_component_slice_iterator slice_rend (const std::size_t component, const size_type row, const size_type col)
 Returns a read/write iterator that points to the one before the first element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order (decreasing slice number). More...
 
const_reverse_component_slice_iterator slice_rend (const std::size_t component, const size_type row, const size_type col) const
 Returns a read (constant) iterator that points to the one before the first element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order (decreasing slice number). More...
 
One dimensional component slice range iterators
component_slice_range_iterator slice_begin (const std::size_t component, const size_type row, const size_type col, const slip::Range< int > &range)
 Returns a read/write iterator that points to the first element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...
 
const_component_slice_range_iterator slice_begin (const std::size_t component, const size_type row, const size_type col, const slip::Range< int > &range) const
 Returns a read only (constant) iterator that points to the first element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...
 
component_slice_range_iterator slice_end (const std::size_t component, const size_type row, const size_type col, const slip::Range< int > &range)
 Returns a read/write iterator that points one past the end element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...
 
const_component_slice_range_iterator slice_end (const std::size_t component, const size_type row, const size_type col, const slip::Range< int > &range) const
 Returns a read_only iterator that points one past the last element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...
 
reverse_component_slice_range_iterator slice_rbegin (const std::size_t component, const size_type row, const size_type col, const slip::Range< int > &range)
 Returns a read/write iterator that points to the last element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...
 
const_reverse_component_slice_range_iterator slice_rbegin (const std::size_t component, const size_type row, const size_type col, const slip::Range< int > &range) const
 Returns a read only (constant) iterator that points to the last element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order according to the Range. More...
 
reverse_component_slice_range_iterator slice_rend (const std::size_t component, const size_type row, const size_type col, const slip::Range< int > &range)
 Returns a read/write iterator that points to the first element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order according to the Range. More...
 
const_reverse_component_slice_range_iterator slice_rend (const std::size_t component, const size_type row, const size_type col, const slip::Range< int > &range) const
 Returns a read_only iterator that points one past the lastto the first element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order according to the Range. More...
 
One dimensional row iterators
row_iterator row_begin (const size_type slice, const size_type row)
 Returns a read/write iterator that points to the first element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...
 
const_row_iterator row_begin (const size_type slice, const size_type row) const
 Returns a read_only iterator that points to the first element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...
 
row_iterator row_end (const size_type slice, const size_type row)
 Returns a read/write iterator that points to the past-the-end element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...
 
const_row_iterator row_end (const size_type slice, const size_type row) const
 Returns a read_only iterator that points to the past-the-end element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...
 
reverse_row_iterator row_rbegin (const size_type slice, const size_type row)
 Returns a read/write reverse iterator that points to the last element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in reverse element order. More...
 
const_reverse_row_iterator row_rbegin (const size_type slice, const size_type row) const
 Returns a read_only reverse iterator that points to the last element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in reverse element order. More...
 
reverse_row_iterator row_rend (const size_type slice, const size_type row)
 Returns a read/write reverse iterator that points to the first element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in reverse element order. More...
 
const_reverse_row_iterator row_rend (const size_type slice, const size_type row) const
 Returns a read_only reverse iterator that points to the first element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in reverse element order. More...
 
One dimensional row range iterators
row_range_iterator row_begin (const size_type slice, const size_type row, const slip::Range< int > &range)
 Returns a read/write iterator that points to the first element of the Range range of the row row in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...
 
const_row_range_iterator row_begin (const size_type slice, const size_type row, const slip::Range< int > &range) const
 Returns a read-only iterator that points to the first element of the Range range of the row row in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...
 
row_range_iterator row_end (const size_type slice, const size_type row, const slip::Range< int > &range)
 Returns a read/write iterator that points one past the end element of the Range range of the row row in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...
 
const_row_range_iterator row_end (const size_type slice, const size_type row, const slip::Range< int > &range) const
 Returns a read_only iterator that points one past the last element of the Range range of the row row in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...
 
reverse_row_range_iterator row_rbegin (const size_type slice, const size_type row, const slip::Range< int > &range)
 Returns a read-write iterator that points to the last element of the Range range of the row of a slice row and slice in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...
 
const_reverse_row_range_iterator row_rbegin (const size_type slice, const size_type row, const slip::Range< int > &range) const
 Returns a read-only iterator that points to the last element of the Range range of the row of a slice row in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...
 
reverse_row_range_iterator row_rend (const size_type slice, const size_type row, const slip::Range< int > &range)
 Returns a read-write iterator that points one before the first element of the Range range of the row of a slice row in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...
 
const_reverse_row_range_iterator row_rend (const size_type slice, const size_type row, const slip::Range< int > &range) const
 Returns a read-only iterator that points one before the first element of the Range range of the row of a slice row in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...
 
One dimensional component row iterators
component_row_iterator row_begin (const std::size_t component, const size_type slice, const size_type row)
 Returns a read/write iterator that points to the first element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...
 
const_component_row_iterator row_begin (const std::size_t component, const size_type slice, const size_type row) const
 Returns a read_only iterator that points to the first element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...
 
component_row_iterator row_end (const std::size_t component, const size_type slice, const size_type row)
 Returns a read/write iterator that points to the past-the-end element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...
 
const_component_row_iterator row_end (const std::size_t component, const size_type slice, const size_type row) const
 Returns a read_only iterator that points to the past-the-end element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...
 
reverse_component_row_iterator row_rbegin (const std::size_t component, const size_type slice, const size_type row)
 Returns a read/write reverse iterator that points to the last element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in reverse element order. More...
 
const_reverse_component_row_iterator row_rbegin (const std::size_t component, const size_type slice, const size_type row) const
 Returns a read_only reverse iterator that points to the last element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in reverse element order. More...
 
reverse_component_row_iterator row_rend (const std::size_t component, const size_type slice, const size_type row)
 Returns a read/write reverse iterator that points to the first element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in reverse element order. More...
 
const_reverse_component_row_iterator row_rend (const std::size_t component, const size_type slice, const size_type row) const
 Returns a read_only reverse iterator that points to the first element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in reverse element order. More...
 
One dimensional component row range iterators
component_row_range_iterator row_begin (const std::size_t component, const size_type slice, const size_type row, const slip::Range< int > &range)
 Returns a read/write iterator that points to the first element of the Range range of the row row in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...
 
const_component_row_range_iterator row_begin (const std::size_t component, const size_type slice, const size_type row, const slip::Range< int > &range) const
 Returns a read-only iterator that points to the first element of the Range range of the row row in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...
 
component_row_range_iterator row_end (const std::size_t component, const size_type slice, const size_type row, const slip::Range< int > &range)
 Returns a read/write iterator that points one past the end element of the Range range of the row row in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...
 
const_component_row_range_iterator row_end (const std::size_t component, const size_type slice, const size_type row, const slip::Range< int > &range) const
 Returns a read_only iterator that points one past the last element of the Range range of the row row in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...
 
reverse_component_row_range_iterator row_rbegin (const std::size_t component, const size_type slice, const size_type row, const slip::Range< int > &range)
 Returns a read-write iterator that points to the last element of the Range range of the row of a slice row and slice in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...
 
const_reverse_component_row_range_iterator row_rbegin (const std::size_t component, const size_type slice, const size_type row, const slip::Range< int > &range) const
 Returns a read-only iterator that points to the last element of the Range range of the row of a slice row in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...
 
reverse_component_row_range_iterator row_rend (const std::size_t component, const size_type slice, const size_type row, const slip::Range< int > &range)
 Returns a read-write iterator that points one before the first element of the Range range of the row of a slice row in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...
 
const_reverse_component_row_range_iterator row_rend (const std::size_t component, const size_type slice, const size_type row, const slip::Range< int > &range) const
 Returns a read-only iterator that points one before the first element of the Range range of the row of a slice row in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...
 
One dimensional col iterators
col_iterator col_begin (const size_type slice, const size_type col)
 Returns a read/write iterator that points to the first element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns. More...
 
const_col_iterator col_begin (const size_type slice, const size_type col) const
 Returns a read_only iterator that points to the first element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns. More...
 
col_iterator col_end (const size_type slice, const size_type col)
 Returns a read/write iterator that points to the past-the-end element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns. More...
 
const_col_iterator col_end (const size_type slice, const size_type col) const
 Returns a read_only iterator that points to the past-the-end element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns. More...
 
reverse_col_iterator col_rbegin (const size_type slice, const size_type col)
 Returns a read/write reverse iterator that points to the last element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns. More...
 
const_reverse_col_iterator col_rbegin (const size_type slice, const size_type col) const
 Returns a read_only reverse iterator that points to the last element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns. More...
 
reverse_col_iterator col_rend (const size_type slice, const size_type col)
 Returns a read/write reverse iterator that points to the first element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns. More...
 
const_reverse_col_iterator col_rend (const size_type slice, const size_type col) const
 Returns a read_only reverse iterator that points to the first element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns. More...
 
One dimensional col range iterators
col_range_iterator col_begin (const size_type slice, const size_type col, const slip::Range< int > &range)
 Returns a read-write iterator that points to the first element of the Range range of the col col in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...
 
const_col_range_iterator col_begin (const size_type slice, const size_type col, const slip::Range< int > &range) const
 Returns a read-only iterator that points to the first element of the Range range of the col col in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...
 
col_range_iterator col_end (const size_type slice, const size_type col, const slip::Range< int > &range)
 Returns a read-write iterator that points to the past the end element of the Range range of the col col in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...
 
const_col_range_iterator col_end (const size_type slice, const size_type col, const slip::Range< int > &range) const
 Returns a read-only iterator that points to the past the end element of the Range range of the col col in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...
 
reverse_col_range_iterator col_rbegin (const size_type slice, const size_type col, const slip::Range< int > &range)
 Returns a read-write iterator that points to the last element of the Range range of the col of a slice col in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...
 
const_reverse_col_range_iterator col_rbegin (const size_type slice, const size_type col, const slip::Range< int > &range) const
 Returns a read_only iterator that points to the last element of the Range & range of the col of a slice col in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...
 
reverse_col_range_iterator col_rend (const size_type slice, const size_type col, const slip::Range< int > &range)
 Returns a read-write iterator that points to one before the first element of the Range range of the col of a slice col in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...
 
const_reverse_col_range_iterator col_rend (const size_type slice, const size_type col, const slip::Range< int > &range) const
 Returns a read-only iterator that points to the first element of the Range range of the col of a slice col in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...
 
One dimensional component col iterators
component_col_iterator col_begin (const std::size_t component, const size_type slice, const size_type col)
 Returns a read/write iterator that points to the first element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns. More...
 
const_component_col_iterator col_begin (const std::size_t component, const size_type slice, const size_type col) const
 Returns a read_only iterator that points to the first element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns. More...
 
component_col_iterator col_end (const std::size_t component, const size_type slice, const size_type col)
 Returns a read/write iterator that points to the past-the-end element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns. More...
 
const_component_col_iterator col_end (const std::size_t component, const size_type slice, const size_type col) const
 Returns a read_only iterator that points to the past-the-end element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns. More...
 
reverse_component_col_iterator col_rbegin (const std::size_t component, const size_type slice, const size_type col)
 Returns a read/write reverse iterator that points to the last element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns. More...
 
const_reverse_component_col_iterator col_rbegin (const std::size_t component, const size_type slice, const size_type col) const
 Returns a read_only reverse iterator that points to the last element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns. More...
 
reverse_component_col_iterator col_rend (const std::size_t component, const size_type slice, const size_type col)
 Returns a read/write reverse iterator that points to the first element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns. More...
 
const_reverse_component_col_iterator col_rend (const std::size_t component, const size_type slice, const size_type col) const
 Returns a read_only reverse iterator that points to the first element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns. More...
 
One dimensional component col range iterators
component_col_range_iterator col_begin (const std::size_t component, const size_type slice, const size_type col, const slip::Range< int > &range)
 Returns a read-write iterator that points to the first element of the Range range of the col col in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...
 
const_component_col_range_iterator col_begin (const std::size_t component, const size_type slice, const size_type col, const slip::Range< int > &range) const
 Returns a read-only iterator that points to the first element of the Range range of the col col in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...
 
component_col_range_iterator col_end (const std::size_t component, const size_type slice, const size_type col, const slip::Range< int > &range)
 Returns a read-write iterator that points to the past the end element of the Range range of the col col in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...
 
const_component_col_range_iterator col_end (const std::size_t component, const size_type slice, const size_type col, const slip::Range< int > &range) const
 Returns a read-only iterator that points to the past the end element of the Range range of the col col in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...
 
reverse_component_col_range_iterator col_rbegin (const std::size_t component, const size_type slice, const size_type col, const slip::Range< int > &range)
 Returns a read-write iterator that points to the last element of the Range range of the col of a slice col in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...
 
const_reverse_component_col_range_iterator col_rbegin (const std::size_t component, const size_type slice, const size_type col, const slip::Range< int > &range) const
 Returns a read_only iterator that points to the last element of the Range & range of the col of a slice col in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...
 
reverse_component_col_range_iterator col_rend (const std::size_t component, const size_type slice, const size_type col, const slip::Range< int > &range)
 Returns a read-write iterator that points to one before the first element of the Range range of the col of a slice col in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...
 
const_reverse_component_col_range_iterator col_rend (const std::size_t component, const size_type slice, const size_type col, const slip::Range< int > &range) const
 Returns a read-only iterator that points to the first element of the Range range of the col of a slice col in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...
 
One dimensional global plane iterators
iterator plane_begin (const size_type slice)
 Returns a read/write iterator that points to the first element in the in the slice plane of the GenericMultiComponent3d. Iteration is done in ordinary element order. More...
 
const_iterator plane_begin (const size_type slice) const
 Returns a read-only (constant) iterator that points to the first element in the slice plane of the GenericMultiComponent3d. Iteration is done in ordinary element order. More...
 
iterator plane_end (const size_type slice)
 Returns a read/write iterator that points one past the last element in the slice plane of the GenericMultiComponent3d. Iteration is done in ordinary element order. More...
 
const_iterator plane_end (const size_type slice) const
 Returns a read-only (constant) iterator that points one past the last element in the slice plane of the GenericMultiComponent3d. Iteration is done in ordinary element order. More...
 
reverse_iterator plane_rbegin (const size_type slice)
 Returns a read/write reverse iterator that points to the last element in the slice plane of the GenericMultiComponent3d. Iteration is done in reverse element order. More...
 
const_reverse_iterator plane_rbegin (const size_type slice) const
 Returns a read-only (constant) reverse iterator that points to the last element in the slice plane k of the GenericMultiComponent3d. Iteration is done in reverse element order. More...
 
reverse_iterator plane_rend (const size_type slice)
 Returns a read/write reverse iterator that points to one before the first element in the slice plane of the GenericMultiComponent3d. Iteration is done in reverse element order. More...
 
const_reverse_iterator plane_rend (const size_type slice) const
 Returns a read-only (constant) reverse iterator that points to one before the first element in the slice plane of the GenericMultiComponent3d. Iteration is done in reverse element order. More...
 
One dimensional component global plane iterators
component_iterator plane_begin (const std::size_t component, const size_type slice)
 Returns a read/write iterator that points to the first element in the in the slice plane of the GenericMultiComponent3d. Iteration is done in ordinary element order. More...
 
const_component_iterator plane_begin (const std::size_t component, const size_type slice) const
 Returns a read-only (constant) iterator that points to the first element in the slice plane of the GenericMultiComponent3d. Iteration is done in ordinary element order. More...
 
component_iterator plane_end (const std::size_t component, const size_type slice)
 Returns a read/write iterator that points one past the last element in the slice plane of the GenericMultiComponent3d. Iteration is done in ordinary element order. More...
 
const_component_iterator plane_end (const std::size_t component, const size_type slice) const
 Returns a read-only (constant) iterator that points one past the last element in the slice plane of the GenericMultiComponent3d. Iteration is done in ordinary element order. More...
 
reverse_component_iterator plane_rbegin (const std::size_t component, const size_type slice)
 Returns a read/write reverse iterator that points to the last element in the slice plane of the GenericMultiComponent3d. Iteration is done in reverse element order. More...
 
const_reverse_component_iterator plane_rbegin (const std::size_t component, const size_type slice) const
 Returns a read-only (constant) reverse iterator that points to the last element in the slice plane k of the GenericMultiComponent3d. Iteration is done in reverse element order. More...
 
reverse_component_iterator plane_rend (const std::size_t component, const size_type slice)
 Returns a read/write reverse iterator that points to one before the first element in the slice plane of the GenericMultiComponent3d. Iteration is done in reverse element order. More...
 
const_reverse_component_iterator plane_rend (const std::size_t component, const size_type slice) const
 Returns a read-only (constant) reverse iterator that points to one before the first element in the slice plane of the GenericMultiComponent3d. Iteration is done in reverse element order. More...
 
two dimensionnal plane iterators : Global iterators
iterator2d plane_upper_left (PLANE_ORIENTATION P, const size_type plane_coordinate)
 Returns a read/write iterator that points to the first element of the plane in the GenericMultiComponent3d. It points to the upper left element of the plane Iteration is done in ordinary element order. More...
 
const_iterator2d plane_upper_left (PLANE_ORIENTATION P, const size_type plane_coordinate) const
 Returns a read/write const iterator that points to the first element of the plane in the GenericMultiComponent3d. It points to the upper left element of the plane Iteration is done in ordinary element order. More...
 
iterator2d plane_bottom_right (PLANE_ORIENTATION P, const size_type plane_coordinate)
 Returns a read/write iterator that points to the last element of the plane in the GenericMultiComponent3d. It points to past the end element of the bottom right element of the plane Iteration is done in ordinary element order. More...
 
const_iterator2d plane_bottom_right (PLANE_ORIENTATION P, const size_type plane_coordinate) const
 Returns a read/write const iterator that points to the last element of the plane in the GenericMultiComponent3d. It points to past the end element of the bottom right element of the plane Iteration is done in ordinary element order. More...
 
reverse_iterator2d plane_rupper_left (PLANE_ORIENTATION P, const size_type plane_coordinate)
 Returns a read/write reverse_iterator that points to the bottom right element of the plane in the GenericMultiComponent3d. Iteration is done in backward element order. More...
 
const_reverse_iterator2d plane_rupper_left (PLANE_ORIENTATION P, const size_type plane_coordinate) const
 Returns a read/write const reverse iterator that points to the bottom right element of the plane in the GenericMultiComponent3d. Iteration is done in backward element order. More...
 
reverse_iterator2d plane_rbottom_right (PLANE_ORIENTATION P, const size_type plane_coordinate)
 Returns a read/write reverse_iterator that points to the upper left element of the plane in the GenericMultiComponent3d. Iteration is done in backward element order. More...
 
const_reverse_iterator2d plane_rbottom_right (PLANE_ORIENTATION P, const size_type plane_coordinate) const
 Returns a read/write const reverse iterator that points to the upper left element of the plane in the GenericMultiComponent3d. Iteration is done in backward element order. More...
 
two dimensionnal plane iterators : box iterators
iterator2d plane_upper_left (PLANE_ORIENTATION P, const size_type plane_coordinate, const Box2d< int > &b)
 Returns a read/write iterator that points to the first element of a box within a plane in the GenericMultiComponent3d. It points to the upper left element of the box Iteration is done in ordinary element order. More...
 
const_iterator2d plane_upper_left (PLANE_ORIENTATION P, const size_type plane_coordinate, const Box2d< int > &b) const
 Returns a read/write const iterator that points to the first element of a box within a plane in the GenericMultiComponent3d. It points to the upper left element of the plane Iteration is done in ordinary element order. More...
 
iterator2d plane_bottom_right (PLANE_ORIENTATION P, const size_type plane_coordinate, const Box2d< int > &b)
 Returns a read/write iterator that points to the last element of a box within a plane in the GenericMultiComponent3d. It points to past the end element of the bottom right element of the plane Iteration is done in ordinary element order. More...
 
const_iterator2d plane_bottom_right (PLANE_ORIENTATION P, const size_type plane_coordinate, const Box2d< int > &b) const
 Returns a read/write const iterator that points to the last element of a box within a plane in the GenericMultiComponent3d. It points to past the end element of the bottom right element of the plane Iteration is done in ordinary element order. More...
 
reverse_iterator2d plane_rupper_left (PLANE_ORIENTATION P, const size_type plane_coordinate, const Box2d< int > &b)
 Returns a read/write reverse iterator that points to the last element of a box within a plane in the GenericMultiComponent3d. It points to the bottom right element of the box Iteration is done in backward element order. More...
 
const_reverse_iterator2d plane_rupper_left (PLANE_ORIENTATION P, const size_type plane_coordinate, const Box2d< int > &b) const
 Returns a read/write const reverse iterator that points to the last element of a box within a plane in the GenericMultiComponent3d. It points to the bottom right element of the plane Iteration is done in backward element order. More...
 
reverse_iterator2d plane_rbottom_right (PLANE_ORIENTATION P, const size_type plane_coordinate, const Box2d< int > &b)
 Returns a read/write reverse iterator that points to the first element of a box within a plane in the GenericMultiComponent3d. It points to the upper left element of the plane Iteration is done in backward element order. More...
 
const_reverse_iterator2d plane_rbottom_right (PLANE_ORIENTATION P, const size_type plane_coordinate, const Box2d< int > &b) const
 Returns a read/write const reverse iterator that points to the first element of a box within a plane in the GenericMultiComponent3d. It points to the bottom right element of the plane Iteration is done in backward element order. More...
 
three dimensionnal iterators : Global iterators
iterator3d front_upper_left ()
 Returns a read/write iterator3d that points to the first element of the GenericMultiComponent3d. It points to the front upper left element of the GenericMultiComponent3d. More...
 
const_iterator3d front_upper_left () const
 Returns a read-only iterator3d that points to the first element of the GenericMultiComponent3d. It points to the front upper left element of the GenericMultiComponent3d. More...
 
iterator3d back_bottom_right ()
 Returns a read/write iterator3d that points to the past the end element of the GenericMultiComponent3d. It points to past the end element of the back bottom right element of the GenericMultiComponent3d. More...
 
const_iterator3d back_bottom_right () const
 Returns a read-only iterator3d that points to the past the end element of the GenericMultiComponent3d. It points to past the end element of the back bottom right element of the GenericMultiComponent3d. More...
 
reverse_iterator3d rfront_upper_left ()
 Returns a read/write reverse iterator3d. It points to the back bottom right element of the GenericMultiComponent3d. Iteration is done within the GenericMultiComponent3d in the reverse order. More...
 
const_reverse_iterator3d rfront_upper_left () const
 Returns a read only reverse iterator3d that points. It points to the back bottom right element of the GenericMultiComponent3d. Iteration is done within the GenericMultiComponent3d in the reverse order. More...
 
reverse_iterator3d rback_bottom_right ()
 Returns a read/write reverse iterator3d. It points to past the front upper left element of the GenericMultiComponent3d. Iteration is done in the reverse order. More...
 
const_reverse_iterator3d rback_bottom_right () const
 Returns a read only reverse iterator3d. It points to past the front upper left element of the GenericMultiComponent3d. Iteration is done in the reverse order. More...
 
three dimensionnal iterators : Box iterators
iterator3d front_upper_left (const Box3d< int > &box)
 Returns a read/write iterator3d that points to the first element of the GenericMultiComponent3d. It points to the front upper left element of the Box3d associated to the GenericMultiComponent3d. More...
 
const_iterator3d front_upper_left (const Box3d< int > &box) const
 Returns a read only iterator3d that points to the first element of the GenericMultiComponent3d. It points to the front upper left element of the Box3d associated to the GenericMultiComponent3d. More...
 
iterator3d back_bottom_right (const Box3d< int > &box)
 Returns a read/write iterator3d that points to the past the end element of the GenericMultiComponent3d. It points to past the end element of the back bottom right element of the Box3d associated to the GenericMultiComponent3d. More...
 
const_iterator3d back_bottom_right (const Box3d< int > &box) const
 Returns a read only iterator3d that points to the past the end element of the GenericMultiComponent3d. It points to past the end element of the back bottom right element of the Box3d associated to the GenericMultiComponent3d. More...
 
reverse_iterator3d rfront_upper_left (const Box3d< int > &box)
 Returns a read/write reverse iterator3d. It points to the back bottom right element of the Box3d associated to the GenericMultiComponent3d. Iteration is done in the reverse order. More...
 
const_reverse_iterator3d rfront_upper_left (const Box3d< int > &box) const
 Returns a read only reverse iterator3d. It points to the back bottom right element of the Box3d box associated to the GenericMultiComponent3d. Iteration is done in the reverse order. More...
 
reverse_iterator3d rback_bottom_right (const Box3d< int > &box)
 Returns a read/write reverse iterator3d. It points to one before the front upper left element of the Box3d box associated to the GenericMultiComponent3d. More...
 
const_reverse_iterator3d rback_bottom_right (const Box3d< int > &box) const
 Returns a read-only reverse iterator3d. It points to one before the front upper left element of the Box3d box associated to the GenericMultiComponent3d. More...
 
three dimensionnal iterators : Range iterators
iterator3d_range front_upper_left (const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range)
 Returns a read/write iterator3d_range that points to the front upper left element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d. More...
 
const_iterator3d_range front_upper_left (const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range) const
 Returns a read-only iterator3d_range that points to the to the front upper left element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d. More...
 
iterator3d_range back_bottom_right (const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range)
 Returns a read/write iterator3d_range that points to the past the end back bottom right element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d. More...
 
const_iterator3d_range back_bottom_right (const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range) const
 Returns a read-only iterator3d_range that points to the past the end back bottom right element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d. More...
 
reverse_iterator3d_range rfront_upper_left (const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range)
 Returns a read/write reverse_iterator3d_range that points to the past the back bottom right element of the ranges row_range and col_range associated to the GenericMultiComponent3d. Iteration is done in the reverse order. More...
 
const_reverse_iterator3d_range rfront_upper_left (const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range) const
 Returns a read-only reverse_iterator3d_range that points to the past the back bottom right element of the ranges row_range and col_range associated to the GenericMultiComponent3d. Iteration is done in the reverse order. More...
 
reverse_iterator3d_range rback_bottom_right (const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range)
 Returns a read/write reverse_iterator3d_range that points to one before the front upper left element of the ranges row_range and col_range associated to the GenericMultiComponent3d. Iteration is done in the reverse order. More...
 
const_reverse_iterator3d_range rback_bottom_right (const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range) const
 Returns a read-only reverse_iterator3d_range that points to one before the front upper left element of the ranges row_range and col_range associated to the GenericMultiComponent3d.Iteration is done in the reverse order. More...
 
Three dimensionnal component iterators : Global component iterators
component_iterator3d front_upper_left (const std::size_t component)
 Returns a read/write component_iterator3d that points to the first element of the GenericMultiComponent3d. It points to the front upper left element of the GenericMultiComponent3d. More...
 
const_component_iterator3d front_upper_left (const std::size_t component) const
 Returns a read only const_component_iterator3d that points to the first element of the GenericMultiComponent3d. It points to the front upper left element of the GenericMultiComponent3d. More...
 
component_iterator3d front_upper_left (const std::size_t component, const Box3d< int > &box)
 Returns a read/write component iterator3d that points to the first element of the GenericMultiComponent3d. It points to the front upper left element of the Box3d associated to the GenericMultiComponent3d. More...
 
const_component_iterator3d front_upper_left (const std::size_t component, const Box3d< int > &box) const
 Returns a read only component iterator3d that points to the first element of the GenericMultiComponent3d. It points to the front upper left element of the Box3d associated to the GenericMultiComponent3d. More...
 
component_iterator3d_range front_upper_left (const std::size_t component, const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range)
 Returns a read/write component_iterator3d_range that points to the front upper left element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d. More...
 
const_component_iterator3d_range front_upper_left (const std::size_t component, const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range) const
 Returns a read/write component_const_iterator3d_range that points to the front upper left element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d. More...
 
component_iterator3d back_bottom_right (const std::size_t component)
 Returns a read/write component_iterator3d that points to the past the end element of the GenericMultiComponent3d. It points to past the end element of the back bottom right element of the GenericMultiComponent3d. More...
 
const_component_iterator3d back_bottom_right (const std::size_t component) const
 Returns a read only const_component_iterator3d that points to the past the end element of the GenericMultiComponent3d. It points to past the end element of the back bottom right element of the GenericMultiComponent3d. More...
 
component_iterator3d back_bottom_right (const std::size_t component, const Box3d< int > &box)
 Returns a read/write component iterator3d that points to the past the end element of the GenericMultiComponent3d. It points to past the end element of the back bottom right element of the Box3d associated to the GenericMultiComponent3d. More...
 
const_component_iterator3d back_bottom_right (const std::size_t component, const Box3d< int > &box) const
 Returns a read only component iterator3d that points to the past the end element of the GenericMultiComponent3d. It points to past the end element of the back bottom right element of the Box3d associated to the GenericMultiComponent3d. More...
 
component_iterator3d_range back_bottom_right (const std::size_t component, const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range)
 Returns a read/write component_iterator3d_range that points to the past the end back bottom right element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d. More...
 
const_component_iterator3d_range back_bottom_right (const std::size_t component, const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range) const
 Returns a read/write const_component iterator3d_range that points to the past the end back bottom right element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d. More...
 
reverse_component_iterator3d rfront_upper_left (const std::size_t component)
 Returns a read/write reverse component iterator3d. It points to the back bottom right element of the GenericMultiComponent3d. Iteration is done within the GenericMultiComponent3d in the reverse order. More...
 
const_reverse_component_iterator3d rfront_upper_left (const std::size_t component) const
 Returns a read only reverse component iterator3d that points. It points to the back bottom right element of the GenericMultiComponent3d. Iteration is done within the GenericMultiComponent3d in the reverse order. More...
 
reverse_component_iterator3d rfront_upper_left (const std::size_t component, const Box3d< int > &box)
 Returns a read/write reverse component iterator3d. It points to the back bottom right element of the Box3d associated to the GenericMultiComponent3d. Iteration is done in the reverse order. More...
 
const_reverse_component_iterator3d rfront_upper_left (const std::size_t component, const Box3d< int > &box) const
 Returns a read only reverse component iterator3d. It points to the back bottom right element of the Box3d box associated to the GenericMultiComponent3d. Iteration is done in the reverse order. More...
 
reverse_component_iterator3d_range rfront_upper_left (const std::size_t component, const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range)
 Returns a read/write reverse_component_iterator3d_range. It points to the back bottom right element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d. More...
 
const_reverse_component_iterator3d_range rfront_upper_left (const std::size_t component, const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range) const
 Returns a read/write reverse_const_component_iterator3d_range. It points to the back bottom right element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d. More...
 
reverse_component_iterator3d rback_bottom_right (const std::size_t component)
 Returns a read/write reverse component iterator3d. It points to past the front upper left element of the GenericMultiComponent3d. Iteration is done in the reverse order. More...
 
const_reverse_component_iterator3d rback_bottom_right (const std::size_t component) const
 Returns a read only reverse component iterator3d. It points to past the front upper left element of the GenericMultiComponent3d. Iteration is done in the reverse order. More...
 
reverse_component_iterator3d rback_bottom_right (const std::size_t component, const Box3d< int > &box)
 Returns a read/write reverse component iterator3d. It points to one before the front upper left element of the Box3d box associated to the GenericMultiComponent3d. More...
 
const_reverse_component_iterator3d rback_bottom_right (const std::size_t component, const Box3d< int > &box) const
 Returns a read-only reverse component iterator3d. It points to one before the front upper left element of the Box3d box associated to the GenericMultiComponent3d. More...
 
reverse_component_iterator3d_range rback_bottom_right (const std::size_t component, const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range)
 Returns a read/write reverse_component_iterator3d_range. It points to one before the front upper left element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d. More...
 
const_reverse_component_iterator3d_range rback_bottom_right (const std::size_t component, const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range) const
 Returns a read/write reverse_const_component_iterator3d_range. It points to one before the front upper left element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d. More...
 
Assignment operators and methods
void fill (const slip::Vector3d< T > &value)
 Fills the container range [begin(),begin()+size()) with copies of value. More...
 
void fill (const typename slip::Vector3d< T >::pointer value)
 Fills the container range [begin(),begin()+size()) with a copy of the value array. More...
 
void fill (const slip::Vector3d< T > *value)
 Fills the container range [begin(),begin()+size()) with a copy of the value array. More...
 
void fill (InputIterator first, InputIterator last)
 Fills the container range [begin(),begin()+size()) with a copy of the range [first,last) More...
 
void fill (std::vector< InputIterator > first_iterators_list, InputIterator last)
 Fills the container range [begin(),begin()+size()) with a copy of the range [first,last) More...
 
void fill (std::size_t component, InputIterator first, InputIterator last)
 Fills the container range [begin(),begin()+size()) with a copy of the range [first,last) More...
 
Element access operators

Less than comparison operator (GenericMultiComponent3d ordering relation)

Parameters
xA GenericMultiComponent3d
yA GenericMultiComponent3d of the same type of x
Returns
true iff x is lexicographically less than y
Precondition
x.size() == y.size()

More than comparison operator

Parameters
xA GenericMultiComponent3d
yA GenericMultiComponent3d of the same type of x
Returns
true iff y > x
Precondition
x.size() == y.size()

Less than equal comparison operator

Parameters
xA GenericMultiComponent3d
yA GenericMultiComponent3d of the same type of x
Returns
true iff !(y > x)
Precondition
x.size() == y.size()

More than equal comparison operator

Parameters
xA GenericMultiComponent3d
yA GenericMultiComponent3d of the same type of x
Returns
true iff !(x < y)
Precondition
x.size() == y.size()
pointeroperator[] (const size_type k)
 Subscript access to the slice datas contained in the GenericMultiComponent3d. More...
 
const_pointer const * operator[] (const size_type k) const
 Subscript access to the slice datas contained in the GenericMultiComponent3d. More...
 
reference operator() (const size_type k, const size_type i, const size_type j)
 Subscript access to the data contained in the GenericMultiComponent3d. More...
 
const_reference operator() (const size_type k, const size_type i, const size_type j) const
 Subscript access to the data contained in the GenericMultiComponent3d. More...
 

Static Public Attributes

static const std::size_t DIM = 3
 
static const std::size_t COMPONENTS
 

Friends

class boost::serialization::access
 

i/o operators

std::ostream & operator<< (std::ostream &out, const self &a)
 Write the RegularVector3dField3d to the ouput stream. More...
 
void write_tecplot (const std::string &file_path_name, const std::string &title, const std::string &zone) const
 Writes a RegularVector3dField3d to a tecplot file path name. More...
 
void write_tecplot_bin (const std::string &file_path_name, const std::string &title, const std::string &zone) const
 Writes a RegularVector3dField3d to a tecplot binary file. More...
 
void read_tecplot (const std::string &file_path_name)
 Reads a RegularVector3dField3d from a tecplot file path name. More...
 
void read_tecplot_bin (const std::string &file_path_name, const int zone_loaded=1)
 Reads a RegularVector3dField3d from a binary tecplot file. More...
 

Detailed Description

template<typename T, typename GridT>
class slip::RegularVector3dField3d< T, GridT >

This is a Regular Vector3d Field. This container statisfies the BidirectionnalContainer concepts of the STL. It is also an 3d extension of the RandomAccessContainer concept. That is to say the bracket element access is replaced by the triple bracket element access. It is a specialization of GenericMultiComponent3d using slip::Vector3d blocks. It implements arithmetic and mathematical operators (divergence, vorticity, derivative...) and read/write methods (tecplot file format). The points of the Vector field grid are assumed to be spaced by two regular steps. The inital point (closest point from the physical axis origin) of the grid is also stored within the data structure.

Author
Benoit Tremblais <tremblais_AT_sic.univ-poitiers.fr>
Version
0.0.4
Date
2014/04/02
Parameters
TType of object in the RegularVector3dField3d
iterator3d_conventions.jpg
axis and notation conventions
Examples:
regularvector3dfield3d_op.cpp.

Definition at line 134 of file RegularVector3dField3d.hpp.

Member Typedef Documentation

template<typename T, typename GridT>
typedef GenericMultiComponent3d<slip::Vector3d<T> > slip::RegularVector3dField3d< T, GridT >::base

Definition at line 168 of file RegularVector3dField3d.hpp.

Definition at line 256 of file GenericMultiComponent3d.hpp.

Definition at line 258 of file GenericMultiComponent3d.hpp.

Definition at line 255 of file GenericMultiComponent3d.hpp.

template<typename T, typename GridT>
typedef slip::stride_iterator<pointer> slip::RegularVector3dField3d< T, GridT >::col_iterator

Definition at line 188 of file RegularVector3dField3d.hpp.

Definition at line 213 of file GenericMultiComponent3d.hpp.

Definition at line 276 of file GenericMultiComponent3d.hpp.

Definition at line 278 of file GenericMultiComponent3d.hpp.

Definition at line 260 of file GenericMultiComponent3d.hpp.

Definition at line 296 of file GenericMultiComponent3d.hpp.

Definition at line 301 of file GenericMultiComponent3d.hpp.

Definition at line 272 of file GenericMultiComponent3d.hpp.

Definition at line 274 of file GenericMultiComponent3d.hpp.

Definition at line 268 of file GenericMultiComponent3d.hpp.

Definition at line 270 of file GenericMultiComponent3d.hpp.

Definition at line 257 of file GenericMultiComponent3d.hpp.

Definition at line 259 of file GenericMultiComponent3d.hpp.

template<typename T, typename GridT>
typedef slip::stride_iterator<const_pointer> slip::RegularVector3dField3d< T, GridT >::const_col_iterator

Definition at line 189 of file RegularVector3dField3d.hpp.

Definition at line 214 of file GenericMultiComponent3d.hpp.

Definition at line 277 of file GenericMultiComponent3d.hpp.

Definition at line 279 of file GenericMultiComponent3d.hpp.

Definition at line 261 of file GenericMultiComponent3d.hpp.

Definition at line 298 of file GenericMultiComponent3d.hpp.

Definition at line 303 of file GenericMultiComponent3d.hpp.

Definition at line 273 of file GenericMultiComponent3d.hpp.

Definition at line 275 of file GenericMultiComponent3d.hpp.

Definition at line 269 of file GenericMultiComponent3d.hpp.

Definition at line 271 of file GenericMultiComponent3d.hpp.

Definition at line 309 of file GenericMultiComponent3d.hpp.

template<typename T, typename GridT>
typedef const_pointer slip::RegularVector3dField3d< T, GridT >::const_iterator

Definition at line 180 of file RegularVector3dField3d.hpp.

Definition at line 239 of file GenericMultiComponent3d.hpp.

template<typename T, typename GridT>
typedef slip::GenericMultiComponent3d<slip::Vector3d<T> >::const_iterator2d slip::RegularVector3dField3d< T, GridT >::const_iterator3d

Definition at line 197 of file RegularVector3dField3d.hpp.

Definition at line 247 of file GenericMultiComponent3d.hpp.

template<typename T, typename GridT>
typedef const value_type* slip::RegularVector3dField3d< T, GridT >::const_pointer

Definition at line 172 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
typedef const value_type& slip::RegularVector3dField3d< T, GridT >::const_reference

Definition at line 174 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
typedef std::reverse_iterator<const_col_iterator> slip::RegularVector3dField3d< T, GridT >::const_reverse_col_iterator

Definition at line 194 of file RegularVector3dField3d.hpp.

Definition at line 227 of file GenericMultiComponent3d.hpp.

Definition at line 290 of file GenericMultiComponent3d.hpp.

Definition at line 292 of file GenericMultiComponent3d.hpp.

Definition at line 264 of file GenericMultiComponent3d.hpp.

Definition at line 299 of file GenericMultiComponent3d.hpp.

Definition at line 304 of file GenericMultiComponent3d.hpp.

Definition at line 286 of file GenericMultiComponent3d.hpp.

Definition at line 288 of file GenericMultiComponent3d.hpp.

Definition at line 282 of file GenericMultiComponent3d.hpp.

Definition at line 284 of file GenericMultiComponent3d.hpp.

template<typename T, typename GridT>
typedef std::reverse_iterator<const_iterator> slip::RegularVector3dField3d< T, GridT >::const_reverse_iterator

Definition at line 183 of file RegularVector3dField3d.hpp.

Definition at line 241 of file GenericMultiComponent3d.hpp.

Definition at line 250 of file GenericMultiComponent3d.hpp.

Definition at line 252 of file GenericMultiComponent3d.hpp.

template<typename T, typename GridT>
typedef std::reverse_iterator<const_iterator> slip::RegularVector3dField3d< T, GridT >::const_reverse_row_iterator

Definition at line 192 of file RegularVector3dField3d.hpp.

Definition at line 225 of file GenericMultiComponent3d.hpp.

Definition at line 217 of file GenericMultiComponent3d.hpp.

Definition at line 223 of file GenericMultiComponent3d.hpp.

template<typename T, typename GridT>
typedef const_pointer slip::RegularVector3dField3d< T, GridT >::const_row_iterator

Definition at line 187 of file RegularVector3dField3d.hpp.

Definition at line 212 of file GenericMultiComponent3d.hpp.

template<typename T, typename GridT>
typedef const RegularVector3dField3d<T,GridT> slip::RegularVector3dField3d< T, GridT >::const_self

Definition at line 167 of file RegularVector3dField3d.hpp.

Definition at line 204 of file GenericMultiComponent3d.hpp.

Definition at line 210 of file GenericMultiComponent3d.hpp.

template<typename T, typename GridT>
typedef slip::kstride_iterator<const_vector3d_pointer,3> slip::RegularVector3dField3d< T, GridT >::const_vector3d_iterator

Definition at line 206 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
typedef const vector3d_value_type* slip::RegularVector3dField3d< T, GridT >::const_vector3d_pointer

Definition at line 202 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
typedef const vector3d_value_type slip::RegularVector3dField3d< T, GridT >::const_vector3d_reference

Definition at line 204 of file RegularVector3dField3d.hpp.

Definition at line 308 of file GenericMultiComponent3d.hpp.

template<typename T, typename GridT>
typedef ptrdiff_t slip::RegularVector3dField3d< T, GridT >::difference_type

Definition at line 176 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
typedef GridT slip::RegularVector3dField3d< T, GridT >::grid_value_type

Definition at line 200 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
typedef pointer slip::RegularVector3dField3d< T, GridT >::iterator

Definition at line 179 of file RegularVector3dField3d.hpp.

Definition at line 238 of file GenericMultiComponent3d.hpp.

template<typename T, typename GridT>
typedef slip::GenericMultiComponent3d<slip::Vector3d<T> >::iterator3d slip::RegularVector3dField3d< T, GridT >::iterator3d

Definition at line 196 of file RegularVector3dField3d.hpp.

Definition at line 246 of file GenericMultiComponent3d.hpp.

template<typename T, typename GridT>
typedef slip::lin_alg_traits<value_type>::value_type slip::RegularVector3dField3d< T, GridT >::norm_type

Definition at line 208 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
typedef value_type* slip::RegularVector3dField3d< T, GridT >::pointer

Definition at line 171 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
typedef value_type& slip::RegularVector3dField3d< T, GridT >::reference

Definition at line 173 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
typedef std::reverse_iterator<col_iterator> slip::RegularVector3dField3d< T, GridT >::reverse_col_iterator

Definition at line 193 of file RegularVector3dField3d.hpp.

Definition at line 226 of file GenericMultiComponent3d.hpp.

Definition at line 289 of file GenericMultiComponent3d.hpp.

Definition at line 291 of file GenericMultiComponent3d.hpp.

Definition at line 263 of file GenericMultiComponent3d.hpp.

Definition at line 297 of file GenericMultiComponent3d.hpp.

Definition at line 302 of file GenericMultiComponent3d.hpp.

Definition at line 285 of file GenericMultiComponent3d.hpp.

Definition at line 287 of file GenericMultiComponent3d.hpp.

Definition at line 281 of file GenericMultiComponent3d.hpp.

Definition at line 283 of file GenericMultiComponent3d.hpp.

template<typename T, typename GridT>
typedef std::reverse_iterator<iterator> slip::RegularVector3dField3d< T, GridT >::reverse_iterator

Definition at line 182 of file RegularVector3dField3d.hpp.

typedef std::reverse_iterator<iterator2d> slip::GenericMultiComponent3d< slip::Vector3d< T > >::reverse_iterator2d
inherited

Definition at line 240 of file GenericMultiComponent3d.hpp.

typedef std::reverse_iterator<iterator3d> slip::GenericMultiComponent3d< slip::Vector3d< T > >::reverse_iterator3d
inherited

Definition at line 249 of file GenericMultiComponent3d.hpp.

Definition at line 251 of file GenericMultiComponent3d.hpp.

template<typename T, typename GridT>
typedef std::reverse_iterator<iterator> slip::RegularVector3dField3d< T, GridT >::reverse_row_iterator

Definition at line 191 of file RegularVector3dField3d.hpp.

Definition at line 224 of file GenericMultiComponent3d.hpp.

typedef std::reverse_iterator<slice_iterator> slip::GenericMultiComponent3d< slip::Vector3d< T > >::reverse_slice_iterator
inherited

Definition at line 216 of file GenericMultiComponent3d.hpp.

Definition at line 222 of file GenericMultiComponent3d.hpp.

template<typename T, typename GridT>
typedef pointer slip::RegularVector3dField3d< T, GridT >::row_iterator

Definition at line 186 of file RegularVector3dField3d.hpp.

Definition at line 211 of file GenericMultiComponent3d.hpp.

template<typename T, typename GridT>
typedef RegularVector3dField3d<T,GridT> slip::RegularVector3dField3d< T, GridT >::self

Definition at line 166 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
typedef std::size_t slip::RegularVector3dField3d< T, GridT >::size_type

Definition at line 177 of file RegularVector3dField3d.hpp.

Definition at line 203 of file GenericMultiComponent3d.hpp.

Definition at line 209 of file GenericMultiComponent3d.hpp.

template<typename T, typename GridT>
typedef slip::Vector3d<T> slip::RegularVector3dField3d< T, GridT >::value_type

Definition at line 165 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
typedef slip::kstride_iterator<vector3d_pointer,3> slip::RegularVector3dField3d< T, GridT >::vector3d_iterator

Definition at line 205 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
typedef vector3d_value_type* slip::RegularVector3dField3d< T, GridT >::vector3d_pointer

Definition at line 201 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
typedef vector3d_value_type& slip::RegularVector3dField3d< T, GridT >::vector3d_reference

Definition at line 203 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
typedef T slip::RegularVector3dField3d< T, GridT >::vector3d_value_type

Definition at line 199 of file RegularVector3dField3d.hpp.

Constructor & Destructor Documentation

template<typename T, typename GridT>
slip::RegularVector3dField3d< T, GridT >::RegularVector3dField3d ( )
inline

Constructs a RegularVector3dField3d.

Definition at line 219 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
slip::RegularVector3dField3d< T, GridT >::RegularVector3dField3d ( const size_type  slices,
const size_type  rows,
const size_type  cols 
)
inline

Constructs a RegularVector3dField3d.

Parameters
slicesfirst dimension of the GenericMultiComponent3d
rowssecond dimension of the GenericMultiComponent3d
colsthird dimension of the GenericMultiComponent3d

Definition at line 229 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
slip::RegularVector3dField3d< T, GridT >::RegularVector3dField3d ( const size_type  slices,
const size_type  rows,
const size_type  cols,
const slip::Point3d< GridT > &  init_point,
const slip::Point3d< GridT > &  grid_step 
)
inline

Constructs a RegularVector3dField3d.

Parameters
slicesfirst dimension of the GenericMultiComponent3d
rowssecond dimension of the GenericMultiComponent3d
colsthird dimension of the GenericMultiComponent3d
init_pointinit point of the RegularVector3dField3d
grid_stepgrid step of the RegularVector3dField3d

Definition at line 243 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
slip::RegularVector3dField3d< T, GridT >::RegularVector3dField3d ( const size_type  slices,
const size_type  rows,
const size_type  cols,
const slip::Vector3d< T > &  val 
)
inline

Constructs a RegularVector3dField3d initialized by the scalar value val.

Parameters
slicesfirst dimension of the GenericMultiComponent3d
rowssecond dimension of the GenericMultiComponent3d
colsthird dimension of the GenericMultiComponent3d
valinitialization value of the elements

Definition at line 259 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
slip::RegularVector3dField3d< T, GridT >::RegularVector3dField3d ( const size_type  slices,
const size_type  rows,
const size_type  cols,
const slip::Point3d< GridT > &  init_point,
const slip::Point3d< GridT > &  grid_step,
const slip::Vector3d< T > &  val 
)
inline

Constructs a RegularVector3dField3d initialized by the scalar value val.

Parameters
slicesfirst dimension of the GenericMultiComponent3d
rowssecond dimension of the GenericMultiComponent3d
colsthird dimension of the GenericMultiComponent3d
init_pointinit point of the RegularVector3dField3d
grid_stepgrid step of the RegularVector3dField3d
valinitialization value of the elements

Definition at line 275 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
slip::RegularVector3dField3d< T, GridT >::RegularVector3dField3d ( const size_type  slices,
const size_type  rows,
const size_type  cols,
const T *  val 
)
inline

Constructs a RegularVector3dField3d initialized by an array val.

Parameters
slicesfirst dimension of the GenericMultiComponent3d
rowssecond dimension of the GenericMultiComponent3d
colsthird dimension of the GenericMultiComponent3d
valinitialization linear array value of the elements

Definition at line 291 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
slip::RegularVector3dField3d< T, GridT >::RegularVector3dField3d ( const size_type  slices,
const size_type  rows,
const size_type  cols,
const slip::Point3d< GridT > &  init_point,
const slip::Point3d< GridT > &  grid_step,
const T *  val 
)
inline

Constructs a RegularVector3dField3d initialized by an array val.

Parameters
slicesfirst dimension of the GenericMultiComponent3d
rowssecond dimension of the GenericMultiComponent3d
colsthird dimension of the GenericMultiComponent3d
init_pointinit point of the RegularVector3dField3d
grid_stepgrid step of the RegularVector3dField3d
valinitialization linear array value of the elements

Definition at line 308 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
slip::RegularVector3dField3d< T, GridT >::RegularVector3dField3d ( const size_type  slices,
const size_type  rows,
const size_type  cols,
const slip::Vector3d< T > *  val 
)
inline

Constructs a RegularVector3dField3d initialized by an array val.

Parameters
slicesfirst dimension of the GenericMultiComponent3d
rowssecond dimension of the GenericMultiComponent3d
colsthird dimension of the GenericMultiComponent3d
valinitialization array value of the elements

Definition at line 324 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
slip::RegularVector3dField3d< T, GridT >::RegularVector3dField3d ( const size_type  slices,
const size_type  rows,
const size_type  cols,
const slip::Point3d< GridT > &  init_point,
const slip::Point3d< GridT > &  grid_step,
const slip::Vector3d< T > *  val 
)
inline

Constructs a RegularVector3dField3d initialized by an array val.

Parameters
slicesfirst dimension of the GenericMultiComponent3d
rowssecond dimension of the GenericMultiComponent3d
colsthird dimension of the GenericMultiComponent3d
init_pointinit point of the RegularVector3dField3d
grid_stepgrid step of the RegularVector3dField3d
valinitialization array value of the elements

Definition at line 341 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
template<typename InputIterator >
slip::RegularVector3dField3d< T, GridT >::RegularVector3dField3d ( const size_type  slices,
const size_type  rows,
const size_type  cols,
InputIterator  first,
InputIterator  last 
)
inline

Contructs a RegularVector3dField3d from a range.

Parameters
slicesfirst dimension of the GenericMultiComponent3d
rowssecond dimension of the GenericMultiComponent3d
colsthird dimension of the GenericMultiComponent3d
firstAn input iterator.
lastAn input iterator.

Create a RegularVector3dField3d consisting of copies of the elements from [first,last).

Definition at line 363 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
template<typename InputIterator >
slip::RegularVector3dField3d< T, GridT >::RegularVector3dField3d ( const size_type  slices,
const size_type  rows,
const size_type  cols,
const slip::Point3d< GridT > &  init_point,
const slip::Point3d< GridT > &  grid_step,
InputIterator  first,
InputIterator  last 
)
inline

Contructs a RegularVector3dField3d from a range.

Parameters
slicesfirst dimension of the GenericMultiComponent3d
rowssecond dimension of the GenericMultiComponent3d
colsthird dimension of the GenericMultiComponent3d
init_pointinit point of the RegularVector3dField3d
grid_stepgrid step of the RegularVector3dField3d
firstAn input iterator.
lastAn input iterator.

Create a RegularVector3dField3d consisting of copies of the elements from [first,last).

Definition at line 385 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
template<typename InputIterator >
slip::RegularVector3dField3d< T, GridT >::RegularVector3dField3d ( const size_type  slices,
const size_type  rows,
const size_type  cols,
InputIterator  first1,
InputIterator  last1,
InputIterator  first2,
InputIterator  first3 
)
inline

Contructs a RegularVector3dField3d from a 3 ranges.

Parameters
slicesfirst dimension of the GenericMultiComponent3d
rowssecond dimension of the GenericMultiComponent3d
colsthird dimension of the GenericMultiComponent3d
first1An input iterator.
last1An input iterator.
first2An input iterator.
first3An input iterator.

Create a RegularVector3dField3d consisting of copies of the elements from [first1,last1), [first2,first2 + (last1 - first1)), [first3,first3 + (last1 - first1)),

Definition at line 413 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
template<typename InputIterator >
slip::RegularVector3dField3d< T, GridT >::RegularVector3dField3d ( const size_type  slices,
const size_type  rows,
const size_type  cols,
const slip::Point3d< GridT > &  init_point,
const slip::Point3d< GridT > &  grid_step,
InputIterator  first1,
InputIterator  last1,
InputIterator  first2,
InputIterator  first3 
)
inline

Contructs a RegularVector3dField3d from a 3 ranges.

Parameters
slicesfirst dimension of the GenericMultiComponent3d
rowssecond dimension of the GenericMultiComponent3d
colsthird dimension of the GenericMultiComponent3d
init_pointinit point of the RegularVector3dField3d
grid_stepgrid step of the RegularVector3dField3d
first1An input iterator.
last1An input iterator.
first2An input iterator.
first3An input iterator.

Create a RegularVector3dField3d consisting of copies of the elements from [first1,last1), [first2,first2 + (last1 - first1)), [first3,first3 + (last1 - first1)),

Definition at line 450 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
slip::RegularVector3dField3d< T, GridT >::RegularVector3dField3d ( const self rhs)
inline

Constructs a copy of the RegularVector3dField3d rhs.

Definition at line 473 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
slip::RegularVector3dField3d< T, GridT >::~RegularVector3dField3d ( )
inline

Destructor of the RegularVector3dField3d.

Definition at line 480 of file RegularVector3dField3d.hpp.

Member Function Documentation

Returns the sums of the elements of the GenericMultiComponent3d.

Precondition
size() != 0

Applys the one-parameter C-function fun to each element of the GenericMultiComponent3d

Parameters
funThe one-parameter C function
Returns
the resulting GenericMultiComponent3d
GenericMultiComponent3d<slip::Vector3d< T > >& slip::GenericMultiComponent3d< slip::Vector3d< T > >::apply ( slip::Vector3d< T > (*)(const slip::Vector3d< T > &)  fun)
inherited

Applys the one-parameter C-function fun to each element of the GenericMultiComponent3d.

Parameters
funThe one-const-parameter C function
Returns
the resulting GenericMultiComponent3d
iterator3d slip::GenericMultiComponent3d< slip::Vector3d< T > >::back_bottom_right ( )
inherited

Returns a read/write iterator3d that points to the past the end element of the GenericMultiComponent3d. It points to past the end element of the back bottom right element of the GenericMultiComponent3d.

Returns
begin iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
Example
//Print M
std::ostream_iterator<slip::color<double> >(std::cout," "));
const_iterator3d slip::GenericMultiComponent3d< slip::Vector3d< T > >::back_bottom_right ( ) const
inherited

Returns a read-only iterator3d that points to the past the end element of the GenericMultiComponent3d. It points to past the end element of the back bottom right element of the GenericMultiComponent3d.

Returns
begin const iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
Example
//Print M
std::ostream_iterator<slip::color<double> >(std::cout," "));
iterator3d slip::GenericMultiComponent3d< slip::Vector3d< T > >::back_bottom_right ( const Box3d< int > &  box)
inherited

Returns a read/write iterator3d that points to the past the end element of the GenericMultiComponent3d. It points to past the end element of the back bottom right element of the Box3d associated to the GenericMultiComponent3d.

Parameters
boxa Box3d defining the range of indices to iterate within the GenericMultiComponent3d.
Returns
end iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
Precondition
The box indices must be inside the range of the GenericMultiComponent3d ones.
Example
slip::Box3d<int> b(1,1,1,2,2,3);
//Print M within a box
std::ostream_iterator<slip::color<double> >(std::cout," "));
const_iterator3d slip::GenericMultiComponent3d< slip::Vector3d< T > >::back_bottom_right ( const Box3d< int > &  box) const
inherited

Returns a read only iterator3d that points to the past the end element of the GenericMultiComponent3d. It points to past the end element of the back bottom right element of the Box3d associated to the GenericMultiComponent3d.

Parameters
boxa Box3d defining the range of indices to iterate within the GenericMultiComponent3d.
Returns
end const iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
Precondition
The box indices must be inside the range of the GenericMultiComponent3d ones.
Example
slip::Box3d<int> b(1,1,1,2,2,3);
//Print M within a box
std::ostream_iterator<slip::color<double> >(std::cout," "));
iterator3d_range slip::GenericMultiComponent3d< slip::Vector3d< T > >::back_bottom_right ( const Range< int > &  slice_range,
const Range< int > &  row_range,
const Range< int > &  col_range 
)
inherited

Returns a read/write iterator3d_range that points to the past the end back bottom right element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d.

Parameters
slice_rangeThe range of the slices.
row_rangeThe range of the rows.
col_rangeThe range of the columns.
Precondition
slice_range, row_range and col_range must be valid.
The ranges indices must be inside the ranges of the GenericMultiComponent3d ones.
Returns
iterator3d_range value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
Example
slip::Range<int> sr(0,2,2);
slip::Range<int> rr(0,3,2);
slip::Range<int> cr(0,4,2);
//Print M within a range
std::ostream_iterator<slip::color<double> >(std::cout," "));
const_iterator3d_range slip::GenericMultiComponent3d< slip::Vector3d< T > >::back_bottom_right ( const Range< int > &  slice_range,
const Range< int > &  row_range,
const Range< int > &  col_range 
) const
inherited

Returns a read-only iterator3d_range that points to the past the end back bottom right element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d.

Parameters
slice_rangeThe range of the slices.
row_rangeThe range of the rows.
col_rangeThe range of the columns.
Precondition
slice_range, row_range and col_range must be valid.
The ranges indices must be inside the ranges of the GenericMultiComponent3d ones.
Returns
const_iterator3d_range value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
Example
slip::Range<int> sr(0,2,2);
slip::Range<int> rr(0,3,2);
slip::Range<int> cr(0,4,2);
//Print M within a range
std::ostream_iterator<slip::color<double> >(std::cout," "));
component_iterator3d slip::GenericMultiComponent3d< slip::Vector3d< T > >::back_bottom_right ( const std::size_t  component)
inherited

Returns a read/write component_iterator3d that points to the past the end element of the GenericMultiComponent3d. It points to past the end element of the back bottom right element of the GenericMultiComponent3d.

Parameters
componentThe component number.
Returns
begin iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
Example:
//copy the first component of the elements of A1 in A2
std::copy(A1.front_upper_left(0),A1.back_bottom_right(0),A2.front_upper_left(0));
const_component_iterator3d slip::GenericMultiComponent3d< slip::Vector3d< T > >::back_bottom_right ( const std::size_t  component) const
inherited

Returns a read only const_component_iterator3d that points to the past the end element of the GenericMultiComponent3d. It points to past the end element of the back bottom right element of the GenericMultiComponent3d.

Parameters
componentThe component number.
Returns
begin iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
component_iterator3d slip::GenericMultiComponent3d< slip::Vector3d< T > >::back_bottom_right ( const std::size_t  component,
const Box3d< int > &  box 
)
inherited

Returns a read/write component iterator3d that points to the past the end element of the GenericMultiComponent3d. It points to past the end element of the back bottom right element of the Box3d associated to the GenericMultiComponent3d.

Parameters
componentThe component number.
boxa Box3d defining the range of indices to iterate within the GenericMultiComponent3d.
Returns
end iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
Precondition
The box indices must be inside the range of the GenericMultiComponent3d ones.
const_component_iterator3d slip::GenericMultiComponent3d< slip::Vector3d< T > >::back_bottom_right ( const std::size_t  component,
const Box3d< int > &  box 
) const
inherited

Returns a read only component iterator3d that points to the past the end element of the GenericMultiComponent3d. It points to past the end element of the back bottom right element of the Box3d associated to the GenericMultiComponent3d.

Parameters
componentThe component number.
boxa Box3d defining the range of indices to iterate within the GenericMultiComponent3d.
Returns
end const iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
Precondition
The box indices must be inside the range of the GenericMultiComponent3d ones.
component_iterator3d_range slip::GenericMultiComponent3d< slip::Vector3d< T > >::back_bottom_right ( const std::size_t  component,
const Range< int > &  slice_range,
const Range< int > &  row_range,
const Range< int > &  col_range 
)
inherited

Returns a read/write component_iterator3d_range that points to the past the end back bottom right element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d.

Parameters
componentThe component number.
slice_rangeThe range of the slices.
row_rangeThe range of the rows.
col_rangeThe range of the columns.
Precondition
slice_range, row_range and col_range must be valid.
The ranges indices must be inside the ranges of the GenericMultiComponent3d ones.
Returns
iterator3d_range value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
const_component_iterator3d_range slip::GenericMultiComponent3d< slip::Vector3d< T > >::back_bottom_right ( const std::size_t  component,
const Range< int > &  slice_range,
const Range< int > &  row_range,
const Range< int > &  col_range 
) const
inherited

Returns a read/write const_component iterator3d_range that points to the past the end back bottom right element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d.

Parameters
componentThe component number.
slice_rangeThe range of the slices.
row_rangeThe range of the rows.
col_rangeThe range of the columns.
Precondition
slice_range, row_range and col_range must be valid.
The ranges indices must be inside the ranges of the GenericMultiComponent3d ones.
Returns
iterator3d_range value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.

Returns a read/write iterator that points to the first element in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Returns
begin iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Example:
const_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::begin ( ) const
inherited

Returns a read-only (constant) iterator that points to the first element in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Returns
const begin iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Example:
component_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::begin ( const std::size_t  component)
inherited

Returns a read/write iterator that points to the first element in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters
componentThe component number.
Returns
begin component_iterator value
const_component_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::begin ( const std::size_t  component) const
inherited

Returns a read-only (constant) iterator that points to the first element in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters
componentThe component number.
Returns
const begin component_iterator value
col_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::col_begin ( const size_type  slice,
const size_type  col 
)
inherited

Returns a read/write iterator that points to the first element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns.

Parameters
sliceThe index of the slice.
colThe index of the column
Returns
begin col_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
const_col_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::col_begin ( const size_type  slice,
const size_type  col 
) const
inherited

Returns a read_only iterator that points to the first element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns.

Parameters
sliceThe index of the slice.
colThe index of the column
Returns
begin const_col_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
col_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::col_begin ( const size_type  slice,
const size_type  col,
const slip::Range< int > &  range 
)
inherited

Returns a read-write iterator that points to the first element of the Range range of the col col in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters
sliceThe index of the slice.
colThe index of the column to iterate.
rangeRange of the column to iterate
Returns
begin col_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
col must be compatible with the range of the GenericMultiComponent3d.
The range must be inside the whole range of the GenericMultiComponent3d.
Example:
slip::Range<int> range(0,A1.dim2()-1,2);
//copy the the elements of the column 0 of the slice 0 of A1 iterated according to the
//range in the column 1 of the slice 1 of A2
std::copy(A1.col_begin(0,0,range),A1.col_end(0,0,range),A2.col_begin(1,1));
const_col_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::col_begin ( const size_type  slice,
const size_type  col,
const slip::Range< int > &  range 
) const
inherited

Returns a read-only iterator that points to the first element of the Range range of the col col in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters
sliceThe index of the slice.
colThe index of the column to iterate.
rangeRange of the column to iterate.
Returns
begin const_col_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
col must be compatible with the range of the GenericMultiComponent3d.
The range must be inside the whole range of the GenericMultiComponent3d.
Example:
slip::Range<int> range(0,A1.dim2()-1,2);
//copy the the elements of the column 0 of the slice 0 of A1 iterated according to the
//range in the column 1 of the slice 1 of A2
std::copy(A1.col_begin(0,0,range),A1.col_end(0,0,range),A2.col_begin(1,1));
component_col_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::col_begin ( const std::size_t  component,
const size_type  slice,
const size_type  col 
)
inherited

Returns a read/write iterator that points to the first element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns.

Parameters
componentThe component number.
sliceThe index of the slice.
colThe index of the column
Returns
begin col_iterator value
const_component_col_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::col_begin ( const std::size_t  component,
const size_type  slice,
const size_type  col 
) const
inherited

Returns a read_only iterator that points to the first element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns.

Parameters
componentThe component number.
sliceThe index of the slice.
colThe index of the column
Returns
begin const_col_iterator value
component_col_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::col_begin ( const std::size_t  component,
const size_type  slice,
const size_type  col,
const slip::Range< int > &  range 
)
inherited

Returns a read-write iterator that points to the first element of the Range range of the col col in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters
componentThe component number.
sliceThe index of the slice.
colThe index of the column to iterate.
rangeRange of the column to iterate
Returns
begin col_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
col must be compatible with the range of the GenericMultiComponent3d.
The range must be inside the whole range of the GenericMultiComponent3d.
slip::Range<int> range(0,A1.dim1()-1,2);
//copy the the elements of the column 0 of A1 iterated according to the
//range in the column 1 of A2
std::copy(A1.col_begin(0,range),A1.col_end(0,range),A2.col_begin(1));
const_component_col_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::col_begin ( const std::size_t  component,
const size_type  slice,
const size_type  col,
const slip::Range< int > &  range 
) const
inherited

Returns a read-only iterator that points to the first element of the Range range of the col col in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters
componentThe component number.
sliceThe index of the slice.
colThe index of the column to iterate.
rangeRange of the column to iterate.
Returns
begin const_col_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
col must be compatible with the range of the GenericMultiComponent3d.
The range must be inside the whole range of the GenericMultiComponent3d.
slip::Range<int> range(0,A1.dim1()-1,2);
//copy the the elements of the column 0 of A1 iterated according to the
//range in the column 1 of A2
std::copy(A1.col_begin(0,range),A1.col_end(0,range),A2.col_begin(1));
col_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::col_end ( const size_type  slice,
const size_type  col 
)
inherited

Returns a read/write iterator that points to the past-the-end element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns.

Parameters
sliceThe index of the slice.
colThe index of the column
Returns
end col_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
const_col_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::col_end ( const size_type  slice,
const size_type  col 
) const
inherited

Returns a read_only iterator that points to the past-the-end element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns.

Parameters
sliceThe index of the slice.
colThe index of the column
Returns
end const_col_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
col_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::col_end ( const size_type  slice,
const size_type  col,
const slip::Range< int > &  range 
)
inherited

Returns a read-write iterator that points to the past the end element of the Range range of the col col in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters
sliceThe index of the slice.
colThe index of the column to iterate.
rangeRange of the column to iterate.
Returns
begin col_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
col must be compatible with the range of the GenericMultiComponent3d.
The range must be inside the whole range of the GenericMultiComponent3d.
Example:
slip::Range<int> range(0,A1.dim2()-1,2);
//copy the the elements of the column 0 of the slice 0 of A1 iterated according to the
//range in the column 1 of the slice 1 of A2
std::copy(A1.col_begin(0,0,range),A1.col_end(0,0,range),A2.col_begin(1,1));
const_col_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::col_end ( const size_type  slice,
const size_type  col,
const slip::Range< int > &  range 
) const
inherited

Returns a read-only iterator that points to the past the end element of the Range range of the col col in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters
sliceThe index of the slice.
colThe index of the column to iterate.
rangeRange of the column to iterate
Returns
begin const_col_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
col must be compatible with the range of the GenericMultiComponent3d.
The range must be inside the whole range of the GenericMultiComponent3d.
Example:
slip::Range<int> range(0,A1.dim2()-1,2);
//copy the the elements of the column 0 of the slice 0 of A1 iterated according to the
//range in the column 1 of the slice 1 of A2
std::copy(A1.col_begin(0,0,range),A1.col_end(0,0,range),A2.col_begin(1,1));
component_col_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::col_end ( const std::size_t  component,
const size_type  slice,
const size_type  col 
)
inherited

Returns a read/write iterator that points to the past-the-end element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns.

Parameters
componentThe component number.
sliceThe index of the slice.
colThe index of the column
Returns
end col_iterator value
const_component_col_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::col_end ( const std::size_t  component,
const size_type  slice,
const size_type  col 
) const
inherited

Returns a read_only iterator that points to the past-the-end element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns.

Parameters
componentThe component number.
sliceThe index of the slice.
colThe index of the column
Returns
end const_col_iterator value
component_col_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::col_end ( const std::size_t  component,
const size_type  slice,
const size_type  col,
const slip::Range< int > &  range 
)
inherited

Returns a read-write iterator that points to the past the end element of the Range range of the col col in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters
componentThe component number.
sliceThe index of the slice.
colThe index of the column to iterate.
rangeRange of the column to iterate.
Returns
begin col_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
col must be compatible with the range of the GenericMultiComponent3d.
The range must be inside the whole range of the GenericMultiComponent3d.
slip::Range<int> range(0,A1.dim1()-1,2);
//copy the the elements of the column 0 of A1 iterated according to the
//range in the column 1 of A2
std::copy(A1.col_begin(0,range),A1.col_end(0,range),A2.col_begin(1));
const_component_col_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::col_end ( const std::size_t  component,
const size_type  slice,
const size_type  col,
const slip::Range< int > &  range 
) const
inherited

Returns a read-only iterator that points to the past the end element of the Range range of the col col in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters
componentThe component number.
sliceThe index of the slice.
colThe index of the column to iterate.
rangeRange of the column to iterate.
Returns
begin const_col_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
col must be compatible with the range of the GenericMultiComponent3d.
The range must be inside the whole range of the GenericMultiComponent3d.
slip::Range<int> range(0,A1.dim1()-1,2);
//copy the the elements of the column 0 of A1 iterated according to the
//range in the column 1 of A2
std::copy(A1.col_begin(0,range),A1.col_end(0,range),A2.col_begin(1));
reverse_col_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::col_rbegin ( const size_type  slice,
const size_type  col 
)
inherited

Returns a read/write reverse iterator that points to the last element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns.

Parameters
sliceThe index of the slice.
colThe index of the column
Returns
begin reverse_col_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
const_reverse_col_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::col_rbegin ( const size_type  slice,
const size_type  col 
) const
inherited

Returns a read_only reverse iterator that points to the last element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns.

Parameters
sliceThe index of the slice.
colThe index of the column
Returns
begin const_reverse_col_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
reverse_col_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::col_rbegin ( const size_type  slice,
const size_type  col,
const slip::Range< int > &  range 
)
inherited

Returns a read-write iterator that points to the last element of the Range range of the col of a slice col in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters
sliceThe index of the slice.
colThe index of the column to iterate.
rangeRange of the column to iterate.
Returns
begin reverse_col_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
col must be compatible with the range of the GenericMultiComponent3d.
The range must be inside the whole range of the GenericMultiComponent3d.
const_reverse_col_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::col_rbegin ( const size_type  slice,
const size_type  col,
const slip::Range< int > &  range 
) const
inherited

Returns a read_only iterator that points to the last element of the Range & range of the col of a slice col in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters
sliceThe index of the slice.
colThe index of the column to iterate.
rangeRange of the column to iterate.
Returns
begin const_reverse_col_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
col must be compatible with the range of the GenericMultiComponent3d.
The range must be inside the whole range of the GenericMultiComponent3d.
reverse_component_col_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::col_rbegin ( const std::size_t  component,
const size_type  slice,
const size_type  col 
)
inherited

Returns a read/write reverse iterator that points to the last element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns.

Parameters
componentThe component number.
sliceThe index of the slice.
colThe index of the column
Returns
begin reverse_col_iterator value
const_reverse_component_col_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::col_rbegin ( const std::size_t  component,
const size_type  slice,
const size_type  col 
) const
inherited

Returns a read_only reverse iterator that points to the last element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns.

Parameters
componentThe component number.
sliceThe index of the slice.
colThe index of the column
Returns
begin const_reverse_col_iterator value
reverse_component_col_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::col_rbegin ( const std::size_t  component,
const size_type  slice,
const size_type  col,
const slip::Range< int > &  range 
)
inherited

Returns a read-write iterator that points to the last element of the Range range of the col of a slice col in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters
componentThe component number.
sliceThe index of the slice.
colThe index of the column to iterate.
rangeRange of the column to iterate.
Returns
begin reverse_col_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
col must be compatible with the range of the GenericMultiComponent3d.
The range must be inside the whole range of the GenericMultiComponent3d.
const_reverse_component_col_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::col_rbegin ( const std::size_t  component,
const size_type  slice,
const size_type  col,
const slip::Range< int > &  range 
) const
inherited

Returns a read_only iterator that points to the last element of the Range & range of the col of a slice col in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters
componentThe component number.
sliceThe index of the slice.
colThe index of the column to iterate.
rangeRange of the column to iterate.
Returns
begin const_reverse_col_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
col must be compatible with the range of the GenericMultiComponent3d.
The range must be inside the whole range of the GenericMultiComponent3d.
reverse_col_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::col_rend ( const size_type  slice,
const size_type  col 
)
inherited

Returns a read/write reverse iterator that points to the first element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns.

Parameters
sliceThe index of the slice.
colThe index of the column
Returns
end reverse_col_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
const_reverse_col_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::col_rend ( const size_type  slice,
const size_type  col 
) const
inherited

Returns a read_only reverse iterator that points to the first element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns.

Parameters
sliceThe index of the slice.
colThe index of the column
Returns
end const_reverse_col_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
reverse_col_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::col_rend ( const size_type  slice,
const size_type  col,
const slip::Range< int > &  range 
)
inherited

Returns a read-write iterator that points to one before the first element of the Range range of the col of a slice col in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters
sliceThe index of the slice.
colThe index of the column to iterate.
rangeRange of the column to iterate.
Returns
reverse_col_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
col must be compatible with the range of the GenericMultiComponent3d.
The range must be inside the whole range of the GenericMultiComponent3d.
const_reverse_col_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::col_rend ( const size_type  slice,
const size_type  col,
const slip::Range< int > &  range 
) const
inherited

Returns a read-only iterator that points to the first element of the Range range of the col of a slice col in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters
sliceThe index of the slice.
colThe index of the column to iterate.
rangeRange of the column to iterate.
Returns
const_reverse_col_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
col must be compatible with the range of the GenericMultiComponent3d.
The range must be inside the whole range of the GenericMultiComponent3d.
reverse_component_col_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::col_rend ( const std::size_t  component,
const size_type  slice,
const size_type  col 
)
inherited

Returns a read/write reverse iterator that points to the first element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns.

Parameters
componentThe component number.
sliceThe index of the slice.
colThe index of the column
Returns
end reverse_col_iterator value
const_reverse_component_col_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::col_rend ( const std::size_t  component,
const size_type  slice,
const size_type  col 
) const
inherited

Returns a read_only reverse iterator that points to the first element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns.

Parameters
componentThe component number.
sliceThe index of the slice.
colThe index of the column
Returns
end const_reverse_col_iterator value
reverse_component_col_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::col_rend ( const std::size_t  component,
const size_type  slice,
const size_type  col,
const slip::Range< int > &  range 
)
inherited

Returns a read-write iterator that points to one before the first element of the Range range of the col of a slice col in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters
componentThe component number.
sliceThe index of the slice.
colThe index of the column to iterate.
rangeRange of the column to iterate.
Returns
reverse_col_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
col must be compatible with the range of the GenericMultiComponent3d.
The range must be inside the whole range of the GenericMultiComponent3d.
const_reverse_component_col_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::col_rend ( const std::size_t  component,
const size_type  slice,
const size_type  col,
const slip::Range< int > &  range 
) const
inherited

Returns a read-only iterator that points to the first element of the Range range of the col of a slice col in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters
componentThe component number.
sliceThe index of the slice.
colThe index of the column to iterate.
rangeRange of the column to iterate.
Returns
const_reverse_col_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
col must be compatible with the range of the GenericMultiComponent3d.
The range must be inside the whole range of the GenericMultiComponent3d.
size_type slip::GenericMultiComponent3d< slip::Vector3d< T > >::cols ( ) const
inherited

Returns the number of columns (third dimension size) in the GenericMultiComponent3d.

size_type slip::GenericMultiComponent3d< slip::Vector3d< T > >::columns ( ) const
inherited

Returns the number of columns (third dimension size) in the GenericMultiComponent3d.

template<typename T, typename GridT>
template<typename Container3D >
void slip::RegularVector3dField3d< T, GridT >::derivative ( const std::size_t  component,
const slip::SPATIAL_DIRECTION  der_dir,
const std::size_t  der_order,
const std::size_t  sch_order,
Container3D &  result 
) const
inline

Computes finite differences derivatives of a RegularVector3dField3d.

Author
Benoit Tremblais <benoit.tremblais_AT_sic.univ-poitiers.fr>
Date
2008/05/25
Version
0.0.1
Parameters
componentComponent of the RegularVector3dField3d to derivate.
der_dirSPATIAL_DIRECTION of the derivative:
  • X_DIRECTION
  • Y_DIRECTION
  • Z_DIRECTION
der_orderDerivative order.
sch_orderOrder of derivation scheme.
resultA Container3D which contain the result of the derivative.
Precondition
component < 3
if der_dir == X_DIRECTION, rows() must be > sch_order
if der_dir == Y_DIRECTION, cols() must be > sch_order
if der_dir == 2_DIRECTION, slices() must be > sch_order
sch_order must be >= der_order
Example:
slip::Array3d<double> Matrice(3,6,7,0.0);
slip::iota(Matrice.begin(),Matrice.end(),1.0,1.0);
//copy M three time : in the first plane, in the second plane the third plane of VFM
slip::RegularVector3dField3d<double> VFM(3,6,7,Matrice.begin(),Matrice.end(),Matrice.begin(),Matrice.begin());
slip::Matrix3d<double> Result(3,6,7,0.0);
std::size_t plane = 0;
std::cout<<"Matrice="<<std::endl;
std::cout<<Matrice<<std::endl;
std::cout<<"-- direction X, ordre 1 (der), ordre 1 (sch), shift 1 --"<<std::endl;
VFM.derivative(plane,slip::X_DIRECTION,1,1,Result);
std::cout<<"Result="<<std::endl;
std::cout<<Result<<std::endl;

Definition at line 1072 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
template<typename Container3D >
void slip::RegularVector3dField3d< T, GridT >::derivative ( const std::size_t  component,
const slip::SPATIAL_DIRECTION  der_dir,
const std::size_t  der_order,
const std::size_t  sch_order,
const slip::Box3d< int >  box,
Container3D &  result 
) const
inline

Computes finite differences derivatives of a RegularVector3dField3d in a box.

Author
Adrien Berchet <adrien.berchet_AT_sic.univ-poitiers.fr>
Date
2014/04/14
Since
1.4.0
Version
0.0.1
Parameters
componentComponent of the RegularVector3dField3d to derivate.
der_dirSPATIAL_DIRECTION of the derivative:
  • X_DIRECTION
  • Y_DIRECTION
  • Z_DIRECTION
der_orderDerivative order.
sch_orderOrder of derivation scheme.
boxbox in which the derivation is processed.
resultA Container3D which contain the result of the derivative.
Precondition
component < 3
if der_dir == X_DIRECTION, rows() must be > sch_order
if der_dir == Y_DIRECTION, cols() must be > sch_order
if der_dir == 2_DIRECTION, slices() must be > sch_order
sch_order must be >= der_order
Example:
//computes some derivatives on the field VFM
slip::Array3d<double> Matrice(5,8,9,0.0);
slip::Point3d<int> min(0,1,2), max(4,6,7);
slip::iota(Matrice.begin(),Matrice.end(),1.0,1.0);
//copy M three time : in the first component, in the second component and in the third component of VFM
slip::RegularVector3dField3d<double> VFM(5,8,9,Matrice.begin(),Matrice.end(),Matrice.begin(),Matrice.begin());
slip::Matrix3d<double> Result(5,8,9,0.0);
std::cout<<"Matrice="<<std::endl;
std::cout<<Matrice<<std::endl;
std::size_t comp = 0; // the component to derivate
std::cout<<"-- component 0, direction X, ordre 1 (der), ordre 1 (sch), box3d --"<<std::endl;
VFM.derivative(comp,slip::X_DIRECTION,1,1,box3d,Result);
std::cout<<"Result="<<std::endl;
std::cout<<Result<<std::endl;

Definition at line 1199 of file RegularVector3dField3d.hpp.

size_type slip::GenericMultiComponent3d< slip::Vector3d< T > >::dim1 ( ) const
inherited

Returns the number of slices (first dimension size) in the GenericMultiComponent3d.

size_type slip::GenericMultiComponent3d< slip::Vector3d< T > >::dim2 ( ) const
inherited

Returns the number of rows (second dimension size) in the GenericMultiComponent3d.

size_type slip::GenericMultiComponent3d< slip::Vector3d< T > >::dim3 ( ) const
inherited

Returns the number of columns (third dimension size) in the GenericMultiComponent3d.

template<typename T, typename GridT>
template<typename Container3D >
void slip::RegularVector3dField3d< T, GridT >::divergence ( const std::size_t  sch_order,
Container3D &  result 
) const
inline

Computes finite differences divergence of a RegularVector3dField3d.

Author
Benoit Tremblais <benoit.tremblais_AT_sic.univ-poitiers.fr>
Date
2008/05/25
Version
0.0.1
Parameters
sch_orderOrder of derivation scheme.
resultA Container3D which contain the result of the divergence.
Precondition
sch_order must be >= 1
Example:
slip::Array3d<double> Matrice(3,6,7,0.0);
slip::iota(Matrice.begin(),Matrice.end(),1.0,1.0);
slip::RegularVector3dField3d<double> VFM(3,6,7,Matrice.begin(),Matrice.end(),Matrice.begin(),Matrice.begin());
slip::Matrix3d<double> div(VFM.slices(),VFM.rows(),VFM.cols());
VFM.divergence(1,div);
std::cout<<div<<std::endl;

Definition at line 1306 of file RegularVector3dField3d.hpp.

bool slip::GenericMultiComponent3d< slip::Vector3d< T > >::empty ( ) const
inherited

Returns true if the GenericMultiComponent3d is empty. (Thus size() == 0)

Returns a read/write iterator that points one past the last element in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Returns
end iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Example:

Returns a read-only (constant) iterator that points one past the last element in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Returns
const end iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Example:
component_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::end ( const std::size_t  component)
inherited

Returns a read/write iterator that points one past the last element in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters
componentThe component number.
Returns
end component_iterator value
const_component_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::end ( const std::size_t  component) const
inherited

Returns a read-only (constant) iterator that points one past the last element in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters
componentThe component number.
Returns
const end component_iterator value
void slip::GenericMultiComponent3d< slip::Vector3d< T > >::fill ( const slip::Vector3d< T > &  value)
inlineinherited

Fills the container range [begin(),begin()+size()) with copies of value.

Parameters
valueA reference-to-const of arbitrary type.

Definition at line 4929 of file GenericMultiComponent3d.hpp.

void slip::GenericMultiComponent3d< slip::Vector3d< T > >::fill ( const typename slip::Vector3d< T > ::pointer  value)
inlineinherited

Fills the container range [begin(),begin()+size()) with a copy of the value array.

Parameters
valueA pointer of arbitrary type.

Definition at line 4940 of file GenericMultiComponent3d.hpp.

void slip::GenericMultiComponent3d< slip::Vector3d< T > >::fill ( const slip::Vector3d< T > *  value)
inlineinherited

Fills the container range [begin(),begin()+size()) with a copy of the value array.

Parameters
valueA pointer of arbitrary type.

Definition at line 4951 of file GenericMultiComponent3d.hpp.

void slip::GenericMultiComponent3d< slip::Vector3d< T > >::fill ( InputIterator  first,
InputIterator  last 
)
inlineinherited

Fills the container range [begin(),begin()+size()) with a copy of the range [first,last)

Parameters
firstAn input iterator.
lastAn input iterator.

Definition at line 4965 of file GenericMultiComponent3d.hpp.

void slip::GenericMultiComponent3d< slip::Vector3d< T > >::fill ( std::vector< InputIterator >  first_iterators_list,
InputIterator  last 
)
inlineinherited

Fills the container range [begin(),begin()+size()) with a copy of the range [first,last)

Parameters
first_iterators_listAn input iterator list.
lastAn input iterator.

Definition at line 4980 of file GenericMultiComponent3d.hpp.

void slip::GenericMultiComponent3d< slip::Vector3d< T > >::fill ( std::size_t  component,
InputIterator  first,
InputIterator  last 
)
inlineinherited

Fills the container range [begin(),begin()+size()) with a copy of the range [first,last)

Parameters
componentThe component number.
firstAn input iterator.
lastAn input iterator.

Definition at line 5012 of file GenericMultiComponent3d.hpp.

iterator3d slip::GenericMultiComponent3d< slip::Vector3d< T > >::front_upper_left ( )
inherited

Returns a read/write iterator3d that points to the first element of the GenericMultiComponent3d. It points to the front upper left element of the GenericMultiComponent3d.

Returns
begin iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
Example
//Print M
std::ostream_iterator<slip::color<double> >(std::cout," "));
const_iterator3d slip::GenericMultiComponent3d< slip::Vector3d< T > >::front_upper_left ( ) const
inherited

Returns a read-only iterator3d that points to the first element of the GenericMultiComponent3d. It points to the front upper left element of the GenericMultiComponent3d.

Returns
begin const iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
Example
//Print M
std::ostream_iterator<slip::color<double> >(std::cout," "));
iterator3d slip::GenericMultiComponent3d< slip::Vector3d< T > >::front_upper_left ( const Box3d< int > &  box)
inherited

Returns a read/write iterator3d that points to the first element of the GenericMultiComponent3d. It points to the front upper left element of the Box3d associated to the GenericMultiComponent3d.

Parameters
boxA Box3d defining the range of indices to iterate within the GenericMultiComponent3d.
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
Returns
end iterator3d value
Precondition
The box indices must be inside the range of the GenericMultiComponent3d ones.
Example
slip::Box3d<int> b(1,1,1,2,2,3);
//Print M within a box
std::ostream_iterator<slip::color<double> >(std::cout," "));
const_iterator3d slip::GenericMultiComponent3d< slip::Vector3d< T > >::front_upper_left ( const Box3d< int > &  box) const
inherited

Returns a read only iterator3d that points to the first element of the GenericMultiComponent3d. It points to the front upper left element of the Box3d associated to the GenericMultiComponent3d.

Parameters
boxa Box3d defining the range of indices to iterate within the GenericMultiComponent3d.
Returns
end const iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
Precondition
The box indices must be inside the range of the GenericMultiComponent3d ones.
Example
slip::Box3d<int> b(1,1,1,2,2,3);
//Print M within a box
std::ostream_iterator<slip::color<double> >(std::cout," "));
iterator3d_range slip::GenericMultiComponent3d< slip::Vector3d< T > >::front_upper_left ( const Range< int > &  slice_range,
const Range< int > &  row_range,
const Range< int > &  col_range 
)
inherited

Returns a read/write iterator3d_range that points to the front upper left element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d.

Parameters
slice_rangeThe range of the slices.
row_rangeThe range of the rows.
col_rangeThe range of the columns.
Precondition
slice_range, row_range and col_range must be valid.
The ranges indices must be inside the ranges of the GenericMultiComponent3d ones.
Returns
iterator3d_range value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
Example
slip::Range<int> sr(0,2,2);
slip::Range<int> rr(0,3,2);
slip::Range<int> cr(0,4,2);
//Print M within a range
std::ostream_iterator<slip::color<double> >(std::cout," "));
const_iterator3d_range slip::GenericMultiComponent3d< slip::Vector3d< T > >::front_upper_left ( const Range< int > &  slice_range,
const Range< int > &  row_range,
const Range< int > &  col_range 
) const
inherited

Returns a read-only iterator3d_range that points to the to the front upper left element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d.

Parameters
slice_rangeThe range of the slices.
row_rangeThe range of the rows.
col_rangeThe range of the columns.
Precondition
slice_range, row_range and col_range must be valid.
The ranges indices must be inside the ranges of the GenericMultiComponent3d ones.
Returns
const_iterator3d_range value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
Example
slip::Range<int> sr(0,2,2);
slip::Range<int> rr(0,3,2);
slip::Range<int> cr(0,4,2);
//Print M within a range
std::ostream_iterator<slip::color<double> >(std::cout," "));
component_iterator3d slip::GenericMultiComponent3d< slip::Vector3d< T > >::front_upper_left ( const std::size_t  component)
inherited

Returns a read/write component_iterator3d that points to the first element of the GenericMultiComponent3d. It points to the front upper left element of the GenericMultiComponent3d.

Parameters
componentThe component number.
Returns
begin iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
//copy the first component of the elements of A1 in A2
std::copy(A1.front_upper_left(0),A1.back_bottom_right(0),A2.front_upper_left(0));
const_component_iterator3d slip::GenericMultiComponent3d< slip::Vector3d< T > >::front_upper_left ( const std::size_t  component) const
inherited

Returns a read only const_component_iterator3d that points to the first element of the GenericMultiComponent3d. It points to the front upper left element of the GenericMultiComponent3d.

Parameters
componentThe component number.
Returns
begin iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
component_iterator3d slip::GenericMultiComponent3d< slip::Vector3d< T > >::front_upper_left ( const std::size_t  component,
const Box3d< int > &  box 
)
inherited

Returns a read/write component iterator3d that points to the first element of the GenericMultiComponent3d. It points to the front upper left element of the Box3d associated to the GenericMultiComponent3d.

Parameters
componentThe component number.
boxA Box3d defining the range of indices to iterate within the GenericMultiComponent3d.
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
Returns
end iterator3d value
Precondition
The box indices must be inside the range of the GenericMultiComponent3d ones.
const_component_iterator3d slip::GenericMultiComponent3d< slip::Vector3d< T > >::front_upper_left ( const std::size_t  component,
const Box3d< int > &  box 
) const
inherited

Returns a read only component iterator3d that points to the first element of the GenericMultiComponent3d. It points to the front upper left element of the Box3d associated to the GenericMultiComponent3d.

Parameters
componentThe component number.
boxa Box3d defining the range of indices to iterate within the GenericMultiComponent3d.
Returns
end const iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
Precondition
The box indices must be inside the range of the GenericMultiComponent3d ones.
component_iterator3d_range slip::GenericMultiComponent3d< slip::Vector3d< T > >::front_upper_left ( const std::size_t  component,
const Range< int > &  slice_range,
const Range< int > &  row_range,
const Range< int > &  col_range 
)
inherited

Returns a read/write component_iterator3d_range that points to the front upper left element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d.

Parameters
componentThe component number.
slice_rangeThe range of the slices.
row_rangeThe range of the rows.
col_rangeThe range of the columns.
Precondition
slice_range, row_range and col_range must be valid.
The ranges indices must be inside the ranges of the GenericMultiComponent3d ones.
Returns
iterator3d_range value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
const_component_iterator3d_range slip::GenericMultiComponent3d< slip::Vector3d< T > >::front_upper_left ( const std::size_t  component,
const Range< int > &  slice_range,
const Range< int > &  row_range,
const Range< int > &  col_range 
) const
inherited

Returns a read/write component_const_iterator3d_range that points to the front upper left element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d.

Parameters
componentThe component number.
slice_rangeThe range of the slices.
row_rangeThe range of the rows.
col_rangeThe range of the columns.
Precondition
slice_range, row_range and col_range must be valid.
The ranges indices must be inside the ranges of the GenericMultiComponent3d ones.
Returns
iterator3d_range value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
template<typename T , typename GridT >
const slip::Point3d< GridT > & slip::RegularVector3dField3d< T, GridT >::get_grid_step ( ) const
inline

Read access to the init point of the grid.

Returns
A slip::Point3d<GridT>

Definition at line 2310 of file RegularVector3dField3d.hpp.

template<typename T , typename GridT >
const slip::Point3d< GridT > & slip::RegularVector3dField3d< T, GridT >::get_init_point ( ) const
inline

Read access to the init point of the grid.

Returns
A slip::Point3d<GridT>

Definition at line 2296 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
template<typename Container3D , typename Container3D1 , typename Container3D2 , typename Container3D3 >
void slip::RegularVector3dField3d< T, GridT >::lambda ( const std::size_t  sch_order,
Container3D &  Lambda,
Container3D1 &  LambdaV1,
Container3D2 &  LambdaV2,
Container3D3 &  LambdaV3 
) const
inline

Computes finite differences lambda of a RegularVector3dField3d.

Author
Benoit Tremblais <benoit.tremblais_AT_sic.univ-poitiers.fr>
Date
2008/05/25
Version
0.0.1
Parameters
sch_orderOrder of derivation scheme.
LambdaA Container3D which contains real part of lambda.
LambdaV1A Container3D which contains eigenvector #1.
LambdaV2A Container3D which contains eigenvector #2.
LambdaV3A Container3D which contains eigenvector #3.
Precondition
sch_order must be >= 1
Example:
slip::Array3d<double> Matrice(3,6,7,0.0);
slip::iota(Matrice.begin(),Matrice.end(),1.0,1.0);
slip::RegularVector3dField3d<double> VFM(3,6,7,Matrice.begin(),Matrice.end(),Matrice.begin(),Matrice.begin());
slip::RegularVector3dField3d<double> l(VFM.slices(),VFM.rows(),VFM.cols());
VFM.lambda(1,l);
std::cout<<l<<std::endl;

Definition at line 1528 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
template<typename Container3D >
void slip::RegularVector3dField3d< T, GridT >::lambda ( const std::size_t  sch_order,
Container3D &  Lambda 
) const
inline

Computes finite differences lambda of a RegularVector3dField3d.

Author
Benoit Tremblais <benoit.tremblais_AT_sic.univ-poitiers.fr>
Date
2008/05/25
Version
0.0.1
Parameters
sch_orderOrder of derivation scheme.
LambdaA Container3D which contains real part of lambda.
Precondition
sch_order must be >= 1
Example:
slip::Array3d<double> Matrice(3,6,7,0.0);
slip::iota(Matrice.begin(),Matrice.end(),1.0,1.0);
slip::RegularVector3dField3d<double> VFM(3,6,7,Matrice.begin(),Matrice.end(),Matrice.begin(),Matrice.begin());
slip::RegularVector3dField3d<double> l(VFM.slices(),VFM.rows(),VFM.cols());
VFM.lambda(1,l);
std::cout<<l<<std::endl;

Definition at line 1682 of file RegularVector3dField3d.hpp.

slip::Vector3d< T > slip::GenericMultiComponent3d< slip::Vector3d< T > >::max ( ) const
inherited

Returns the max elements of the GenericMultiComponent3d according to the operator <.

Precondition
size() != 0
size_type slip::GenericMultiComponent3d< slip::Vector3d< T > >::max_size ( ) const
inherited

Returns the maximal size (number of elements) in the GenericMultiComponent3d.

slip::Vector3d< T > slip::GenericMultiComponent3d< slip::Vector3d< T > >::min ( ) const
inherited

Returns the min elements of the GenericMultiComponent3d according to the operator <.

Precondition
size() != 0
template<typename T , typename GridT >
std::string slip::RegularVector3dField3d< T, GridT >::name ( ) const
inline

Returns the name of the class.

Definition at line 2507 of file RegularVector3dField3d.hpp.

template<typename T , typename GridT >
RegularVector3dField3d< T, GridT >::norm_type slip::RegularVector3dField3d< T, GridT >::norm ( const size_type  k,
const size_type  i,
const size_type  j 
) const
inline

Subscript access to a local norm contained in the RegularVector3dField3d.

Parameters
kThe index of the slice for which the data should be accessed.
iThe index of the row for which the data should be accessed.
jThe index of the columns for which the data should be accessed.
Returns
Read_only (constant) reference to data.
Precondition
k < slices()
i < rows()
j < columns()

This operator allows for easy, 3d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.

Definition at line 2233 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
template<typename Container3D >
void slip::RegularVector3dField3d< T, GridT >::norm ( Container3D &  result) const
inline

Computes Eucliean norm of each element in the field and write it to a Container3D.

Author
Benoit Tremblais <benoit.tremblais_AT_sic.univ-poitiers.fr>
Date
2008/05/25
Version
0.0.1
Parameters
resultA Container3D which contain the norm of each element.

Definition at line 1807 of file RegularVector3dField3d.hpp.

reference slip::GenericMultiComponent3d< slip::Vector3d< T > >::operator() ( const size_type  k,
const size_type  i,
const size_type  j 
)
inherited

Subscript access to the data contained in the GenericMultiComponent3d.

Parameters
kThe index of the slice for which the data should be accessed.
iThe index of the row for which the data should be accessed.
jThe index of the column for which the data should be accessed.
Returns
Read/Write reference to data.
Precondition
k < slices()
i < rows()
j < cols() This operator allows for easy, 3d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.
const_reference slip::GenericMultiComponent3d< slip::Vector3d< T > >::operator() ( const size_type  k,
const size_type  i,
const size_type  j 
) const
inherited

Subscript access to the data contained in the GenericMultiComponent3d.

Parameters
kThe index of the slice for which the data should be accessed.
iThe index of the row for which the data should be accessed.
jThe index of the column for which the data should be accessed.
Returns
Read_only (constant) reference to data.
Precondition
k < slices()
i < rows()
j < cols() This operator allows for easy, 3d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.
template<typename T, typename GridT >
RegularVector3dField3d< T, GridT > & slip::RegularVector3dField3d< T, GridT >::operator*= ( const T &  val)
inline

Definition at line 2340 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT >
RegularVector3dField3d< T, GridT > & slip::RegularVector3dField3d< T, GridT >::operator*= ( const slip::Vector3d< T > &  val)
inline

Definition at line 2374 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT >
RegularVector3dField3d< T, GridT > & slip::RegularVector3dField3d< T, GridT >::operator*= ( const self rhs)
inline

Definition at line 2439 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT >
RegularVector3dField3d< T, GridT > & slip::RegularVector3dField3d< T, GridT >::operator+= ( const T &  val)
inline

Add val to each element of the RegularVector3dField3d.

Parameters
valvalue
Returns
reference to the resulting RegularVector3dField3d

Definition at line 2324 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT >
RegularVector3dField3d< T, GridT > & slip::RegularVector3dField3d< T, GridT >::operator+= ( const slip::Vector3d< T > &  val)
inline

Add val to each element of the RegularVector3dField3d.

Parameters
valvalue
Returns
reference to the resulting RegularVector3dField3d

Definition at line 2358 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT >
RegularVector3dField3d< T, GridT > & slip::RegularVector3dField3d< T, GridT >::operator+= ( const self rhs)
inline

Definition at line 2401 of file RegularVector3dField3d.hpp.

template<typename T , typename GridT >
RegularVector3dField3d< T, GridT > slip::RegularVector3dField3d< T, GridT >::operator- ( ) const
inline

Definition at line 2392 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT >
RegularVector3dField3d< T, GridT > & slip::RegularVector3dField3d< T, GridT >::operator-= ( const T &  val)
inline

Definition at line 2332 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT >
RegularVector3dField3d< T, GridT > & slip::RegularVector3dField3d< T, GridT >::operator-= ( const slip::Vector3d< T > &  val)
inline

Definition at line 2366 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT >
RegularVector3dField3d< T, GridT > & slip::RegularVector3dField3d< T, GridT >::operator-= ( const self rhs)
inline

Definition at line 2420 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT >
RegularVector3dField3d< T, GridT > & slip::RegularVector3dField3d< T, GridT >::operator/= ( const T &  val)
inline

Definition at line 2348 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT >
RegularVector3dField3d< T, GridT > & slip::RegularVector3dField3d< T, GridT >::operator/= ( const slip::Vector3d< T > &  val)
inline

Definition at line 2382 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT >
RegularVector3dField3d< T, GridT > & slip::RegularVector3dField3d< T, GridT >::operator/= ( const self rhs)
inline

Definition at line 2458 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT >
RegularVector3dField3d< T, GridT > & slip::RegularVector3dField3d< T, GridT >::operator= ( const slip::Vector3d< T > &  val)
inline

Affects all the element of the RegularVector3dField3d by val.

Parameters
valaffectation value
Returns
reference to corresponding RegularVector3dField3d

Definition at line 2102 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT >
RegularVector3dField3d< T, GridT > & slip::RegularVector3dField3d< T, GridT >::operator= ( const T &  val)
inline

Affects all the element of the RegularVector3dField3d by val.

Parameters
valaffectation value
Returns
reference to corresponding RegularVector3dField3d

Definition at line 2111 of file RegularVector3dField3d.hpp.

pointer* slip::GenericMultiComponent3d< slip::Vector3d< T > >::operator[] ( const size_type  k)
inherited

Subscript access to the slice datas contained in the GenericMultiComponent3d.

Parameters
kThe index of the slice for which data should be accessed.
Returns
Read/write pointer to the slice data.
Precondition
k < slices()

This operator allows for easy, 3d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.

const_pointer const* slip::GenericMultiComponent3d< slip::Vector3d< T > >::operator[] ( const size_type  k) const
inherited

Subscript access to the slice datas contained in the GenericMultiComponent3d.

Parameters
kThe index of the slice for which data should be accessed.
Returns
Read-only (constant) pointer* to the slice data.
Precondition
k < slices()

This operator allows for easy, 3d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.

iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::plane_begin ( const size_type  slice)
inherited

Returns a read/write iterator that points to the first element in the in the slice plane of the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters
slicethe slice coordinate of the plane
Returns
begin iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Example:
//copy the first plane (in slice direction) of A1 in A2
std::copy(A1.plane_begin(0),A1.plane_end(0),A2.plane_begin(0));
const_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::plane_begin ( const size_type  slice) const
inherited

Returns a read-only (constant) iterator that points to the first element in the slice plane of the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters
slicethe slice coordinate of the plane
Returns
const begin iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Example:
//copy the first plane (in slice direction) of A1 in A2
std::copy(A1.plane_begin(0),A1.plane_end(0),A2.plane_begin(0));
component_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::plane_begin ( const std::size_t  component,
const size_type  slice 
)
inherited

Returns a read/write iterator that points to the first element in the in the slice plane of the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters
componentThe component number.
slicethe slice coordinate of the plane
Returns
begin component iterator value
const_component_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::plane_begin ( const std::size_t  component,
const size_type  slice 
) const
inherited

Returns a read-only (constant) iterator that points to the first element in the slice plane of the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters
componentThe component number.
slicethe slice coordinate of the plane
Returns
const begin component iterator value
iterator2d slip::GenericMultiComponent3d< slip::Vector3d< T > >::plane_bottom_right ( PLANE_ORIENTATION  P,
const size_type  plane_coordinate 
)
inherited

Returns a read/write iterator that points to the last element of the plane in the GenericMultiComponent3d. It points to past the end element of the bottom right element of the plane Iteration is done in ordinary element order.

Parameters
Pnumber of the plane axe (PLANE_ORIENTATION).
plane_coordinateThe constant coordinate
Returns
begin iterator2d value
Precondition
P must be 0,1 or 2
Remarks
This iterator is compatible with BidirectionnalAccessIterator algorithms.
Example:
//Print the 2nd plane of M in the KI_PLANE direction
slip::KI_PLANE,2),std::ostream_iterator<slip::color<double> >(std::cout," "));
const_iterator2d slip::GenericMultiComponent3d< slip::Vector3d< T > >::plane_bottom_right ( PLANE_ORIENTATION  P,
const size_type  plane_coordinate 
) const
inherited

Returns a read/write const iterator that points to the last element of the plane in the GenericMultiComponent3d. It points to past the end element of the bottom right element of the plane Iteration is done in ordinary element order.

Parameters
Pnumber of the plane axe (PLANE_ORIENTATION).
plane_coordinateThe constant coordinate
Returns
begin const_iterator2d value
Precondition
P must be 0,1 or 2
Remarks
This iterator is compatible with BidirectionnalAccessIterator algorithms.
Example:
//Print the 2nd plane of M in the KI_PLANE direction
slip::KI_PLANE,2),std::ostream_iterator<slip::color<double> >(std::cout," "));
iterator2d slip::GenericMultiComponent3d< slip::Vector3d< T > >::plane_bottom_right ( PLANE_ORIENTATION  P,
const size_type  plane_coordinate,
const Box2d< int > &  b 
)
inherited

Returns a read/write iterator that points to the last element of a box within a plane in the GenericMultiComponent3d. It points to past the end element of the bottom right element of the plane Iteration is done in ordinary element order.

Parameters
Pnumber of the plane axe (PLANE_ORIENTATION).
plane_coordinateThe constant coordinate
bThe box within the plane
Returns
begin iterator2d value
Precondition
P must be 0,1 or 2
b must be within the plane
Remarks
This iterator is compatible with BidirectionnalAccessIterator algorithms.
Example
slip::Box2d<int> b(1,1,3,3);
//Print the 2nd plane of M in the KI_PLANE direction within a box
slip::KI_PLANE,2,b),std::ostream_iterator<slip::color<double> >(std::cout," "));
const_iterator2d slip::GenericMultiComponent3d< slip::Vector3d< T > >::plane_bottom_right ( PLANE_ORIENTATION  P,
const size_type  plane_coordinate,
const Box2d< int > &  b 
) const
inherited

Returns a read/write const iterator that points to the last element of a box within a plane in the GenericMultiComponent3d. It points to past the end element of the bottom right element of the plane Iteration is done in ordinary element order.

Parameters
Pnumber of the plane axe (PLANE_ORIENTATION).
plane_coordinateThe constant coordinate
bThe box within the plane
Returns
begin const_iterator2d value
Precondition
P must be 0,1 or 2
b must be within the plane
Remarks
This iterator is compatible with BidirectionnalAccessIterator algorithms.
Example
slip::Box2d<int> b(1,1,3,3);
//Print the 2nd plane of M in the KI_PLANE direction within a box
slip::KI_PLANE,2,b),std::ostream_iterator<slip::color<double> >(std::cout," "));
iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::plane_end ( const size_type  slice)
inherited

Returns a read/write iterator that points one past the last element in the slice plane of the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters
slicethe slice coordinate of the plane
Returns
end iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Example:
//copy the first plane (in slice direction) of A1 in A2
std::copy(A1.plane_begin(0),A1.plane_end(0),A2.plane_begin(0));
const_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::plane_end ( const size_type  slice) const
inherited

Returns a read-only (constant) iterator that points one past the last element in the slice plane of the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters
slicethe slice coordinate of the plane
Returns
const end iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Example:
//copy the first plane (in slice direction) of A1 in A2
std::copy(A1.plane_begin(0),A1.plane_end(0),A2.plane_begin(0));
component_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::plane_end ( const std::size_t  component,
const size_type  slice 
)
inherited

Returns a read/write iterator that points one past the last element in the slice plane of the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters
componentThe component number.
slicethe slice coordinate of the plane
Returns
end component iterator value
const_component_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::plane_end ( const std::size_t  component,
const size_type  slice 
) const
inherited

Returns a read-only (constant) iterator that points one past the last element in the slice plane of the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters
componentThe component number.
slicethe slice coordinate of the plane
Returns
const end component iterator value
reverse_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::plane_rbegin ( const size_type  slice)
inherited

Returns a read/write reverse iterator that points to the last element in the slice plane of the GenericMultiComponent3d. Iteration is done in reverse element order.

Parameters
slicethe slice coordinate of the plane
Returns
reverse begin iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Example:
//copy the first plane (in slice direction) of A1 in A2 in reverse order
std::copy(A1.plane_rbegin(0),A1.plane_rend(0),A2.plane_begin(0));
const_reverse_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::plane_rbegin ( const size_type  slice) const
inherited

Returns a read-only (constant) reverse iterator that points to the last element in the slice plane k of the GenericMultiComponent3d. Iteration is done in reverse element order.

Parameters
slicethe slice coordinate of the plane
Returns
const reverse begin iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Example:
//copy the first plane (in slice direction) of A1 in A2 in reverse order
std::copy(A1.plane_rbegin(0),A1.plane_rend(0),A2.plane_begin(0));
reverse_component_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::plane_rbegin ( const std::size_t  component,
const size_type  slice 
)
inherited

Returns a read/write reverse iterator that points to the last element in the slice plane of the GenericMultiComponent3d. Iteration is done in reverse element order.

Parameters
componentThe component number.
slicethe slice coordinate of the plane
Returns
reverse begin component iterator value
const_reverse_component_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::plane_rbegin ( const std::size_t  component,
const size_type  slice 
) const
inherited

Returns a read-only (constant) reverse iterator that points to the last element in the slice plane k of the GenericMultiComponent3d. Iteration is done in reverse element order.

Parameters
componentThe component number.
slicethe slice coordinate of the plane
Returns
const reverse begin component iterator value
reverse_iterator2d slip::GenericMultiComponent3d< slip::Vector3d< T > >::plane_rbottom_right ( PLANE_ORIENTATION  P,
const size_type  plane_coordinate 
)
inherited

Returns a read/write reverse_iterator that points to the upper left element of the plane in the GenericMultiComponent3d. Iteration is done in backward element order.

Parameters
Pnumber of the plane axe (PLANE_ORIENTATION).
plane_coordinateThe constant coordinate
Returns
begin iterator2d value
Precondition
P must be 0,1 or 2
Remarks
This iterator is compatible with BidirectionnalAccessIterator algorithms.
Example:
//Print the 2nd plane of M in the KI_PLANE direction in reverse order
slip::KI_PLANE,2),std::ostream_iterator<slip::color<double> >(std::cout," "));
const_reverse_iterator2d slip::GenericMultiComponent3d< slip::Vector3d< T > >::plane_rbottom_right ( PLANE_ORIENTATION  P,
const size_type  plane_coordinate 
) const
inherited

Returns a read/write const reverse iterator that points to the upper left element of the plane in the GenericMultiComponent3d. Iteration is done in backward element order.

Parameters
Pnumber of the plane axe (PLANE_ORIENTATION).
plane_coordinateThe constant coordinate
Returns
begin const_iterator2d value
Precondition
P must be 0,1 or 2
Remarks
This iterator is compatible with BidirectionnalAccessIterator algorithms.
Example:
//Print the 2nd plane of M in the KI_PLANE direction in reverse order
slip::KI_PLANE,2),std::ostream_iterator<slip::color<double> >(std::cout," "));
reverse_iterator2d slip::GenericMultiComponent3d< slip::Vector3d< T > >::plane_rbottom_right ( PLANE_ORIENTATION  P,
const size_type  plane_coordinate,
const Box2d< int > &  b 
)
inherited

Returns a read/write reverse iterator that points to the first element of a box within a plane in the GenericMultiComponent3d. It points to the upper left element of the plane Iteration is done in backward element order.

Parameters
Pnumber of the plane axe (PLANE_ORIENTATION).
plane_coordinateThe constant coordinate
bThe box within the plane
Returns
begin reverse_iterator2d value
Precondition
P must be 0,1 or 2
b must be within the plane
Remarks
This iterator is compatible with BidirectionnalAccessIterator algorithms.
Example
slip::Box2d<int> b(1,1,3,3);
//Print the 2nd plane of M in the KI_PLANE direction within a box in reverse order
slip::KI_PLANE,2,b),std::ostream_iterator<slip::color<double> >(std::cout," "));
const_reverse_iterator2d slip::GenericMultiComponent3d< slip::Vector3d< T > >::plane_rbottom_right ( PLANE_ORIENTATION  P,
const size_type  plane_coordinate,
const Box2d< int > &  b 
) const
inherited

Returns a read/write const reverse iterator that points to the first element of a box within a plane in the GenericMultiComponent3d. It points to the bottom right element of the plane Iteration is done in backward element order.

Parameters
Pnumber of the plane axe (PLANE_ORIENTATION).
plane_coordinateThe constant coordinate
bThe box within the plane
Returns
begin const_reverse_iterator2d value
Precondition
P must be 0,1 or 2
b must be within the plane
Remarks
This iterator is compatible with BidirectionnalAccessIterator algorithms.
Example
slip::Box2d<int> b(1,1,3,3);
//Print the 2nd plane of M in the KI_PLANE direction within a box in reverse order
slip::KI_PLANE,2,b),std::ostream_iterator<slip::color<double> >(std::cout," "));
reverse_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::plane_rend ( const size_type  slice)
inherited

Returns a read/write reverse iterator that points to one before the first element in the slice plane of the GenericMultiComponent3d. Iteration is done in reverse element order.

Parameters
slicethe slice coordinate of the plane
Returns
reverse end iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Example:
//copy the first plane (in slice direction) of A1 in A2 in reverse order
std::copy(A1.plane_rbegin(0),A1.plane_rend(0),A2.plane_begin(0));
const_reverse_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::plane_rend ( const size_type  slice) const
inherited

Returns a read-only (constant) reverse iterator that points to one before the first element in the slice plane of the GenericMultiComponent3d. Iteration is done in reverse element order.

Parameters
slicethe slice coordinate of the plane
Returns
const reverse end iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Example:
//copy the first plane (in slice direction) of A1 in A2 in reverse order
std::copy(A1.plane_rbegin(0),A1.plane_rend(0),A2.plane_begin(0));
reverse_component_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::plane_rend ( const std::size_t  component,
const size_type  slice 
)
inherited

Returns a read/write reverse iterator that points to one before the first element in the slice plane of the GenericMultiComponent3d. Iteration is done in reverse element order.

Parameters
componentThe component number.
slicethe slice coordinate of the plane
Returns
reverse end component iterator value
const_reverse_component_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::plane_rend ( const std::size_t  component,
const size_type  slice 
) const
inherited

Returns a read-only (constant) reverse iterator that points to one before the first element in the slice plane of the GenericMultiComponent3d. Iteration is done in reverse element order.

Parameters
componentThe component number.
slicethe slice coordinate of the plane
Returns
const reverse end component iterator value
reverse_iterator2d slip::GenericMultiComponent3d< slip::Vector3d< T > >::plane_rupper_left ( PLANE_ORIENTATION  P,
const size_type  plane_coordinate 
)
inherited

Returns a read/write reverse_iterator that points to the bottom right element of the plane in the GenericMultiComponent3d. Iteration is done in backward element order.

Parameters
Pnumber of the plane axe (PLANE_ORIENTATION).
plane_coordinateThe constant coordinate
Returns
begin iterator2d value
Precondition
P must be 0,1 or 2
Remarks
This iterator is compatible with BidirectionnalAccessIterator algorithms.
Example:
//Print the 2nd plane of M in the KI_PLANE direction in reverse order
slip::KI_PLANE,2),std::ostream_iterator<slip::color<double> >(std::cout," "));
const_reverse_iterator2d slip::GenericMultiComponent3d< slip::Vector3d< T > >::plane_rupper_left ( PLANE_ORIENTATION  P,
const size_type  plane_coordinate 
) const
inherited

Returns a read/write const reverse iterator that points to the bottom right element of the plane in the GenericMultiComponent3d. Iteration is done in backward element order.

Parameters
Pnumber of the plane axe (PLANE_ORIENTATION).
plane_coordinateThe constant coordinate
Returns
begin const_iterator2d value
Precondition
P must be 0,1 or 2
Remarks
This iterator is compatible with BidirectionnalAccessIterator algorithms.
Example:
//Print the 2nd plane of M in the KI_PLANE direction in reverse order
slip::KI_PLANE,2),std::ostream_iterator<slip::color<double> >(std::cout," "));
reverse_iterator2d slip::GenericMultiComponent3d< slip::Vector3d< T > >::plane_rupper_left ( PLANE_ORIENTATION  P,
const size_type  plane_coordinate,
const Box2d< int > &  b 
)
inherited

Returns a read/write reverse iterator that points to the last element of a box within a plane in the GenericMultiComponent3d. It points to the bottom right element of the box Iteration is done in backward element order.

Parameters
Pnumber of the plane axe (PLANE_ORIENTATION).
plane_coordinateThe constant coordinate
bThe box within the plane
Returns
begin reverse_iterator2d value
Precondition
P must be 0,1 or 2
b must be within the plane
Remarks
This iterator is compatible with BidirectionnalAccessIterator algorithms.
Example
slip::Box2d<int> b(1,1,3,3);
//Print the 2nd plane of M in the KI_PLANE direction within a box in reverse order
slip::KI_PLANE,2,b),std::ostream_iterator<slip::color<double> >(std::cout," "));
const_reverse_iterator2d slip::GenericMultiComponent3d< slip::Vector3d< T > >::plane_rupper_left ( PLANE_ORIENTATION  P,
const size_type  plane_coordinate,
const Box2d< int > &  b 
) const
inherited

Returns a read/write const reverse iterator that points to the last element of a box within a plane in the GenericMultiComponent3d. It points to the bottom right element of the plane Iteration is done in backward element order.

Parameters
Pnumber of the plane axe (PLANE_ORIENTATION).
plane_coordinateThe constant coordinate
bThe box within the plane
Returns
begin const_reverse_iterator2d value
Precondition
P must be 0,1 or 2
b must be within the plane
Remarks
This iterator is compatible with BidirectionnalAccessIterator algorithms.
Example
slip::Box2d<int> b(1,1,3,3);
//Print the 2nd plane of M in the KI_PLANE direction within a box in reverse order
slip::KI_PLANE,2,b),std::ostream_iterator<slip::color<double> >(std::cout," "));
iterator2d slip::GenericMultiComponent3d< slip::Vector3d< T > >::plane_upper_left ( PLANE_ORIENTATION  P,
const size_type  plane_coordinate 
)
inherited

Returns a read/write iterator that points to the first element of the plane in the GenericMultiComponent3d. It points to the upper left element of the plane Iteration is done in ordinary element order.

Parameters
Pnumber of the plane axe (PLANE_ORIENTATION).
plane_coordinateThe constant coordinate
Returns
begin iterator2d value
Precondition
P must be 0,1 or 2
Remarks
This iterator is compatible with BidirectionnalAccessIterator algorithms.
Example:
//Print the 2nd plane of M in the KI_PLANE direction
slip::KI_PLANE,2),std::ostream_iterator<slip::color<double> >(std::cout," "));
const_iterator2d slip::GenericMultiComponent3d< slip::Vector3d< T > >::plane_upper_left ( PLANE_ORIENTATION  P,
const size_type  plane_coordinate 
) const
inherited

Returns a read/write const iterator that points to the first element of the plane in the GenericMultiComponent3d. It points to the upper left element of the plane Iteration is done in ordinary element order.

Parameters
Pnumber of the plane axe (PLANE_ORIENTATION).
plane_coordinateThe constant coordinate
Returns
begin const_iterator2d value
Precondition
P must be 0,1 or 2
Remarks
This iterator is compatible with BidirectionnalAccessIterator algorithms.
Example:
//Print the 2nd plane of M in the KI_PLANE direction
slip::KI_PLANE,2),std::ostream_iterator<slip::color<double> >(std::cout," "));
iterator2d slip::GenericMultiComponent3d< slip::Vector3d< T > >::plane_upper_left ( PLANE_ORIENTATION  P,
const size_type  plane_coordinate,
const Box2d< int > &  b 
)
inherited

Returns a read/write iterator that points to the first element of a box within a plane in the GenericMultiComponent3d. It points to the upper left element of the box Iteration is done in ordinary element order.

Parameters
Pnumber of the plane axe (PLANE_ORIENTATION).
plane_coordinateThe constant coordinate
bThe box within the plane
Returns
begin iterator2d value
Precondition
P must be 0,1 or 2
b must be within the plane
Remarks
This iterator is compatible with BidirectionnalAccessIterator algorithms.
Example
slip::Box2d<int> b(1,1,3,3);
//Print the 2nd plane of M in the KI_PLANE direction within a box
slip::KI_PLANE,2,b),std::ostream_iterator<slip::color<double> >(std::cout," "));
const_iterator2d slip::GenericMultiComponent3d< slip::Vector3d< T > >::plane_upper_left ( PLANE_ORIENTATION  P,
const size_type  plane_coordinate,
const Box2d< int > &  b 
) const
inherited

Returns a read/write const iterator that points to the first element of a box within a plane in the GenericMultiComponent3d. It points to the upper left element of the plane Iteration is done in ordinary element order.

Parameters
Pnumber of the plane axe (PLANE_ORIENTATION).
plane_coordinateThe constant coordinate
bThe box within the plane
Returns
begin const_iterator2d value
Precondition
P must be 0,1 or 2
b must be within the plane
Remarks
This iterator is compatible with BidirectionnalAccessIterator algorithms.
Example
slip::Box2d<int> b(1,1,3,3);
//Print the 2nd plane of M in the KI_PLANE direction within a box
slip::KI_PLANE,2,b),std::ostream_iterator<slip::color<double> >(std::cout," "));
reverse_iterator3d slip::GenericMultiComponent3d< slip::Vector3d< T > >::rback_bottom_right ( )
inherited

Returns a read/write reverse iterator3d. It points to past the front upper left element of the GenericMultiComponent3d. Iteration is done in the reverse order.

Returns
reverse iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
Example
//Print M in reverse order
std::ostream_iterator<slip::color<double> >(std::cout," "));
const_reverse_iterator3d slip::GenericMultiComponent3d< slip::Vector3d< T > >::rback_bottom_right ( ) const
inherited

Returns a read only reverse iterator3d. It points to past the front upper left element of the GenericMultiComponent3d. Iteration is done in the reverse order.

Returns
const reverse iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
Example
//Print M in reverse order
std::ostream_iterator<slip::color<double> >(std::cout," "));
reverse_iterator3d slip::GenericMultiComponent3d< slip::Vector3d< T > >::rback_bottom_right ( const Box3d< int > &  box)
inherited

Returns a read/write reverse iterator3d. It points to one before the front upper left element of the Box3d box associated to the GenericMultiComponent3d.

Parameters
boxA Box3d defining the range of indices to iterate within the GenericMultiComponent3d.
Precondition
The box indices must be inside the range of the GenericMultiComponent3d ones.
Returns
reverse iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
Example
slip::Box3d<int> b(1,1,1,2,2,3);
//Print M within a box in reverse order
std::ostream_iterator<slip::color<double> >(std::cout," "));
const_reverse_iterator3d slip::GenericMultiComponent3d< slip::Vector3d< T > >::rback_bottom_right ( const Box3d< int > &  box) const
inherited

Returns a read-only reverse iterator3d. It points to one before the front upper left element of the Box3d box associated to the GenericMultiComponent3d.

Parameters
boxA Box3d defining the range of indices to iterate within the GenericMultiComponent3d.
Precondition
The box indices must be inside the range of the GenericMultiComponent3d ones.
Returns
const reverse iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
Example
slip::Box3d<int> b(1,1,1,2,2,3);
//Print M within a box in reverse order
std::ostream_iterator<slip::color<double> >(std::cout," "));
reverse_iterator3d_range slip::GenericMultiComponent3d< slip::Vector3d< T > >::rback_bottom_right ( const Range< int > &  slice_range,
const Range< int > &  row_range,
const Range< int > &  col_range 
)
inherited

Returns a read/write reverse_iterator3d_range that points to one before the front upper left element of the ranges row_range and col_range associated to the GenericMultiComponent3d. Iteration is done in the reverse order.

Parameters
slice_rangeThe range of the slices.
row_rangeThe range of the rows.
col_rangeThe range of the columns.
Precondition
slice_range, row_range and col_range must be valid.
The ranges indices must be inside the ranges of the GenericMultiComponent3d ones.
Returns
reverse_iterator3d_range value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
Example
slip::Range<int> sr(0,2,2);
slip::Range<int> rr(0,3,2);
slip::Range<int> cr(0,4,2);
//Print M within a range in reverse order
std::ostream_iterator<slip::color<double> >(std::cout," "));
const_reverse_iterator3d_range slip::GenericMultiComponent3d< slip::Vector3d< T > >::rback_bottom_right ( const Range< int > &  slice_range,
const Range< int > &  row_range,
const Range< int > &  col_range 
) const
inherited

Returns a read-only reverse_iterator3d_range that points to one before the front upper left element of the ranges row_range and col_range associated to the GenericMultiComponent3d.Iteration is done in the reverse order.

Parameters
slice_rangeThe range of the slices.
row_rangeThe range of the rows.
col_rangeThe range of the columns.
Precondition
slice_range, row_range and col_range must be valid.
The ranges indices must be inside the ranges of the GenericMultiComponent3d ones.
Returns
const_reverse_iterator3d_range value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
Example
slip::Range<int> sr(0,2,2);
slip::Range<int> rr(0,3,2);
slip::Range<int> cr(0,4,2);
//Print M within a range in reverse order
std::ostream_iterator<slip::color<double> >(std::cout," "));
reverse_component_iterator3d slip::GenericMultiComponent3d< slip::Vector3d< T > >::rback_bottom_right ( const std::size_t  component)
inherited

Returns a read/write reverse component iterator3d. It points to past the front upper left element of the GenericMultiComponent3d. Iteration is done in the reverse order.

Parameters
componentThe component number.
Returns
reverse component iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
const_reverse_component_iterator3d slip::GenericMultiComponent3d< slip::Vector3d< T > >::rback_bottom_right ( const std::size_t  component) const
inherited

Returns a read only reverse component iterator3d. It points to past the front upper left element of the GenericMultiComponent3d. Iteration is done in the reverse order.

Parameters
componentThe component number.
Returns
const reverse component iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
reverse_component_iterator3d slip::GenericMultiComponent3d< slip::Vector3d< T > >::rback_bottom_right ( const std::size_t  component,
const Box3d< int > &  box 
)
inherited

Returns a read/write reverse component iterator3d. It points to one before the front upper left element of the Box3d box associated to the GenericMultiComponent3d.

Parameters
componentThe component number.
boxA Box3d defining the range of indices to iterate within the GenericMultiComponent3d.
Precondition
The box indices must be inside the range of the GenericMultiComponent3d ones.
Returns
reverse iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
const_reverse_component_iterator3d slip::GenericMultiComponent3d< slip::Vector3d< T > >::rback_bottom_right ( const std::size_t  component,
const Box3d< int > &  box 
) const
inherited

Returns a read-only reverse component iterator3d. It points to one before the front upper left element of the Box3d box associated to the GenericMultiComponent3d.

Parameters
componentThe component number.
boxA Box3d defining the range of indices to iterate within the GenericMultiComponent3d.
Precondition
The box indices must be inside the range of the GenericMultiComponent3d ones.
Returns
const reverse iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
reverse_component_iterator3d_range slip::GenericMultiComponent3d< slip::Vector3d< T > >::rback_bottom_right ( const std::size_t  component,
const Range< int > &  slice_range,
const Range< int > &  row_range,
const Range< int > &  col_range 
)
inherited

Returns a read/write reverse_component_iterator3d_range. It points to one before the front upper left element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d.

Parameters
componentThe component number.
slice_rangeThe range of the slices.
row_rangeThe range of the rows.
col_rangeThe range of the columns.
Precondition
slice_range, row_range and col_range must be valid.
The ranges indices must be inside the ranges of the GenericMultiComponent3d ones.
Returns
reverse iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
const_reverse_component_iterator3d_range slip::GenericMultiComponent3d< slip::Vector3d< T > >::rback_bottom_right ( const std::size_t  component,
const Range< int > &  slice_range,
const Range< int > &  row_range,
const Range< int > &  col_range 
) const
inherited

Returns a read/write reverse_const_component_iterator3d_range. It points to one before the front upper left element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d.

Parameters
componentThe component number.
slice_rangeThe range of the slices.
row_rangeThe range of the rows.
col_rangeThe range of the columns.
Precondition
slice_range, row_range and col_range must be valid.
The ranges indices must be inside the ranges of the GenericMultiComponent3d ones.
Returns
reverse iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.

Returns a read/write reverse iterator that points to the last element in the GenericMultiComponent3d. Iteration is done in reverse element order.

Returns
reverse begin iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Example:

Returns a read-only (constant) reverse iterator that points to the last element in the GenericMultiComponent3d. Iteration is done in reverse element order.

Returns
const reverse begin iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Example:
reverse_component_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::rbegin ( const std::size_t  component)
inherited

Returns a read/write iterator that points to the first element in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters
componentThe component number.
Returns
begin reverse_component_iterator value
const_reverse_component_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::rbegin ( const std::size_t  component) const
inherited

Returns a read-only (constant) iterator that points to the first element in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters
componentThe component number.
Returns
const begin reverse_component_iterator value
template<typename T , typename GridT >
void slip::RegularVector3dField3d< T, GridT >::read_tecplot ( const std::string &  file_path_name)
inline

Reads a RegularVector3dField3d from a tecplot file path name.

Parameters
file_path_nameFile path name.
The data format is the following:

TITLE= title

VARIABLES= X Y Z U V W

ZONE T= zone, K= dim1(), I= dim2(), J= dim3()

x y z Vx Vy Vz

Definition at line 2553 of file RegularVector3dField3d.hpp.

template<typename T , typename GridT >
void slip::RegularVector3dField3d< T, GridT >::read_tecplot_bin ( const std::string &  file_path_name,
const int  zone_loaded = 1 
)
inline

Reads a RegularVector3dField3d from a binary tecplot file.

Parameters
file_path_nameFile path name.
zone_loadedZone number to read (1 by default).

Definition at line 2563 of file RegularVector3dField3d.hpp.

Returns a read/write reverse iterator that points to one before the first element in the GenericMultiComponent3d. Iteration is done in reverse element order.

Returns
reverse end iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Example:

Returns a read-only (constant) reverse iterator that points to one before the first element in the GenericMultiComponent3d. Iteration is done in reverse element order.

Returns
const reverse end iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Example:
reverse_component_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::rend ( const std::size_t  component)
inherited

Returns a read/write iterator that points one past the last element in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters
componentThe component number.
Returns
end reverse_component_iterator value
const_reverse_component_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::rend ( const std::size_t  component) const
inherited

Returns a read-only (constant) iterator that points one past the last element in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters
componentThe component number.
Returns
const end reverse_component_iterator value
void slip::GenericMultiComponent3d< slip::Vector3d< T > >::resize ( const size_type  slices,
const size_type  rows,
const size_type  cols,
const slip::Vector3d< T > &  val = Block() 
)
inherited

Resizes a GenericMultiComponent3d.

Parameters
slicesfirst dimension of the GenericMultiComponent3d
rowssecond dimension of the GenericMultiComponent3d
colsthird dimension of the GenericMultiComponent3d
valnew value for all the elements
reverse_iterator3d slip::GenericMultiComponent3d< slip::Vector3d< T > >::rfront_upper_left ( )
inherited

Returns a read/write reverse iterator3d. It points to the back bottom right element of the GenericMultiComponent3d. Iteration is done within the GenericMultiComponent3d in the reverse order.

Returns
reverse_iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
Example
//Print M in reverse order
std::ostream_iterator<slip::color<double> >(std::cout," "));
const_reverse_iterator3d slip::GenericMultiComponent3d< slip::Vector3d< T > >::rfront_upper_left ( ) const
inherited

Returns a read only reverse iterator3d that points. It points to the back bottom right element of the GenericMultiComponent3d. Iteration is done within the GenericMultiComponent3d in the reverse order.

Returns
const_reverse_iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
Example
//Print M in reverse order
std::ostream_iterator<slip::color<double> >(std::cout," "));
reverse_iterator3d slip::GenericMultiComponent3d< slip::Vector3d< T > >::rfront_upper_left ( const Box3d< int > &  box)
inherited

Returns a read/write reverse iterator3d. It points to the back bottom right element of the Box3d associated to the GenericMultiComponent3d. Iteration is done in the reverse order.

Parameters
boxa Box3d defining the range of indices to iterate within the GenericMultiComponent3d.
Precondition
The box indices must be inside the range of the GenericMultiComponent3d ones.
Returns
reverse iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
Example
slip::Box3d<int> b(1,1,1,2,2,3);
//Print M within a box in reverse order
std::ostream_iterator<slip::color<double> >(std::cout," "));
const_reverse_iterator3d slip::GenericMultiComponent3d< slip::Vector3d< T > >::rfront_upper_left ( const Box3d< int > &  box) const
inherited

Returns a read only reverse iterator3d. It points to the back bottom right element of the Box3d box associated to the GenericMultiComponent3d. Iteration is done in the reverse order.

Parameters
boxA Box3d defining the range of indices to iterate within the GenericMultiComponent3d.
Precondition
The box indices must be inside the range of the GenericMultiComponent3d ones.
Returns
const reverse iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
Example
slip::Box3d<int> b(1,1,1,2,2,3);
//Print M within a box in reverse order
std::ostream_iterator<slip::color<double> >(std::cout," "));
reverse_iterator3d_range slip::GenericMultiComponent3d< slip::Vector3d< T > >::rfront_upper_left ( const Range< int > &  slice_range,
const Range< int > &  row_range,
const Range< int > &  col_range 
)
inherited

Returns a read/write reverse_iterator3d_range that points to the past the back bottom right element of the ranges row_range and col_range associated to the GenericMultiComponent3d. Iteration is done in the reverse order.

Parameters
slice_rangeThe range of the slices.
row_rangeThe range of the rows.
col_rangeThe range of the columns.
Precondition
slice_range, row_range and col_range must be valid.
The ranges indices must be inside the ranges of the GenericMultiComponent3d ones.
Returns
reverse_iterator3d_range value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
Example
slip::Range<int> sr(0,2,2);
slip::Range<int> rr(0,3,2);
slip::Range<int> cr(0,4,2);
//Print M within a range in reverse order
std::ostream_iterator<slip::color<double> >(std::cout," "));
const_reverse_iterator3d_range slip::GenericMultiComponent3d< slip::Vector3d< T > >::rfront_upper_left ( const Range< int > &  slice_range,
const Range< int > &  row_range,
const Range< int > &  col_range 
) const
inherited

Returns a read-only reverse_iterator3d_range that points to the past the back bottom right element of the ranges row_range and col_range associated to the GenericMultiComponent3d. Iteration is done in the reverse order.

Parameters
slice_rangeThe range of the slices.
row_rangeThe range of the rows.
col_rangeThe range of the columns.
Precondition
slice_range, row_range and col_range must be valid.
The ranges indices must be inside the ranges of the GenericMultiComponent3d ones.
Returns
const_reverse_iterator3d_range value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
Example
slip::Range<int> sr(0,2,2);
slip::Range<int> rr(0,3,2);
slip::Range<int> cr(0,4,2);
//Print M within a range in reverse order
std::ostream_iterator<slip::color<double> >(std::cout," "));
reverse_component_iterator3d slip::GenericMultiComponent3d< slip::Vector3d< T > >::rfront_upper_left ( const std::size_t  component)
inherited

Returns a read/write reverse component iterator3d. It points to the back bottom right element of the GenericMultiComponent3d. Iteration is done within the GenericMultiComponent3d in the reverse order.

Parameters
componentThe component number.
Returns
reverse_component_iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
const_reverse_component_iterator3d slip::GenericMultiComponent3d< slip::Vector3d< T > >::rfront_upper_left ( const std::size_t  component) const
inherited

Returns a read only reverse component iterator3d that points. It points to the back bottom right element of the GenericMultiComponent3d. Iteration is done within the GenericMultiComponent3d in the reverse order.

Parameters
componentThe component number.
Returns
const_reverse_component_iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
reverse_component_iterator3d slip::GenericMultiComponent3d< slip::Vector3d< T > >::rfront_upper_left ( const std::size_t  component,
const Box3d< int > &  box 
)
inherited

Returns a read/write reverse component iterator3d. It points to the back bottom right element of the Box3d associated to the GenericMultiComponent3d. Iteration is done in the reverse order.

Parameters
componentThe component number.
boxa Box3d defining the range of indices to iterate within the GenericMultiComponent3d.
Precondition
The box indices must be inside the range of the GenericMultiComponent3d ones.
Returns
reverse iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
const_reverse_component_iterator3d slip::GenericMultiComponent3d< slip::Vector3d< T > >::rfront_upper_left ( const std::size_t  component,
const Box3d< int > &  box 
) const
inherited

Returns a read only reverse component iterator3d. It points to the back bottom right element of the Box3d box associated to the GenericMultiComponent3d. Iteration is done in the reverse order.

Parameters
componentThe component number.
boxA Box3d defining the range of indices to iterate within the GenericMultiComponent3d.
Precondition
The box indices must be inside the range of the GenericMultiComponent3d ones.
Returns
const reverse iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
reverse_component_iterator3d_range slip::GenericMultiComponent3d< slip::Vector3d< T > >::rfront_upper_left ( const std::size_t  component,
const Range< int > &  slice_range,
const Range< int > &  row_range,
const Range< int > &  col_range 
)
inherited

Returns a read/write reverse_component_iterator3d_range. It points to the back bottom right element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d.

Parameters
componentThe component number.
slice_rangeThe range of the slices.
row_rangeThe range of the rows.
col_rangeThe range of the columns.
Precondition
slice_range, row_range and col_range must be valid.
The ranges indices must be inside the ranges of the GenericMultiComponent3d ones.
Returns
reverse iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
const_reverse_component_iterator3d_range slip::GenericMultiComponent3d< slip::Vector3d< T > >::rfront_upper_left ( const std::size_t  component,
const Range< int > &  slice_range,
const Range< int > &  row_range,
const Range< int > &  col_range 
) const
inherited

Returns a read/write reverse_const_component_iterator3d_range. It points to the back bottom right element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d.

Parameters
componentThe component number.
slice_rangeThe range of the slices.
row_rangeThe range of the rows.
col_rangeThe range of the columns.
Precondition
slice_range, row_range and col_range must be valid.
The ranges indices must be inside the ranges of the GenericMultiComponent3d ones.
Returns
reverse iterator3d value
Remarks
This iterator is compatible with BidirectionalIterator algorithms.
row_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::row_begin ( const size_type  slice,
const size_type  row 
)
inherited

Returns a read/write iterator that points to the first element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters
sliceThe index of the slice.
rowThe index of the row.
Returns
begin row_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
const_row_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::row_begin ( const size_type  slice,
const size_type  row 
) const
inherited

Returns a read_only iterator that points to the first element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters
sliceThe index of the slice.
rowThe index of the row.
Returns
begin const_row_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
row_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::row_begin ( const size_type  slice,
const size_type  row,
const slip::Range< int > &  range 
)
inherited

Returns a read/write iterator that points to the first element of the Range range of the row row in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters
sliceThe index of the slice.
rowThe index of the row to iterate.
rangeRange of the row to iterate.
Returns
begin row_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
row must be compatible with the range of the GenericMultiComponent3d.
The range must be inside the whole range of the GenericMultiComponent3d.
slip::Range<int> range(0,A1.dim3()-1,2);
//copy the the elements of the row 0 of the slice 0 of A1 iterated according to the
//range in the row 1 of the slice 1 of A2
std::copy(A1.row_begin(0,0,range),A1.row_end(0,0,range),A2.row_begin(1,1));
const_row_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::row_begin ( const size_type  slice,
const size_type  row,
const slip::Range< int > &  range 
) const
inherited

Returns a read-only iterator that points to the first element of the Range range of the row row in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters
sliceThe index of the slice.
rowThe index of the row to iterate.
rangeRange of the row to iterate.
Returns
begin const_row_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
row must be compatible with the range of the GenericMultiComponent3d.
The range must be inside the whole range of the GenericMultiComponent3d.
slip::Range<int> range(0,A1.dim3()-1,2);
//copy the the elements of the row 0 of the slice 0 of A1 iterated according to the
//range in the row 1 of the slice 1 of A2
std::copy(A1.row_begin(0,0,range),A1.row_end(0,0,range),A2.row_begin(1,1));
component_row_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::row_begin ( const std::size_t  component,
const size_type  slice,
const size_type  row 
)
inherited

Returns a read/write iterator that points to the first element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters
componentThe component number.
sliceThe index of the slice.
rowThe index of the row.
Returns
begin row_iterator value
const_component_row_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::row_begin ( const std::size_t  component,
const size_type  slice,
const size_type  row 
) const
inherited

Returns a read_only iterator that points to the first element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters
componentThe component number.
sliceThe index of the slice.
rowThe index of the row.
Returns
begin const_row_iterator value
component_row_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::row_begin ( const std::size_t  component,
const size_type  slice,
const size_type  row,
const slip::Range< int > &  range 
)
inherited

Returns a read/write iterator that points to the first element of the Range range of the row row in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters
componentThe component number.
sliceThe index of the slice.
rowThe index of the row to iterate.
rangeRange of the row to iterate.
Returns
begin row_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
row must be compatible with the range of the GenericMultiComponent3d.
The range must be inside the whole range of the GenericMultiComponent3d.
slip::Range<int> range(0,A1.dim2()-1,2);
//copy the the elements of the row 0 of A1 iterated according to the
//range in the row 1 of A2
std::copy(A1.row_begin(0,range),A1.row_end(0,range),A2.row_begin(1));
const_component_row_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::row_begin ( const std::size_t  component,
const size_type  slice,
const size_type  row,
const slip::Range< int > &  range 
) const
inherited

Returns a read-only iterator that points to the first element of the Range range of the row row in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters
componentThe component number.
sliceThe index of the slice.
rowThe index of the row to iterate.
rangeRange of the row to iterate.
Returns
begin const_row_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
row must be compatible with the range of the GenericMultiComponent3d.
The range must be inside the whole range of the GenericMultiComponent3d.
slip::Range<int> range(0,A1.dim2()-1,2);
//copy the the elements of the row 0 of A1 iterated according to the
//range in the row 1 of A2
std::copy(A1.row_begin(0,range),A1.row_end(0,range),A2.row_begin(1));
row_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::row_end ( const size_type  slice,
const size_type  row 
)
inherited

Returns a read/write iterator that points to the past-the-end element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters
sliceThe index of the slice.
rowThe index of the row.
Returns
end row_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
const_row_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::row_end ( const size_type  slice,
const size_type  row 
) const
inherited

Returns a read_only iterator that points to the past-the-end element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters
sliceThe index of the slice.
rowThe index of the row.
Returns
end const_row_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
row_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::row_end ( const size_type  slice,
const size_type  row,
const slip::Range< int > &  range 
)
inherited

Returns a read/write iterator that points one past the end element of the Range range of the row row in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters
sliceThe index of the slice.
rowThe index of the row to iterate.
rangeRange of the row to iterate.
Returns
end row_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
row must be compatible with the range of the GenericMultiComponent3d.
The range must be inside the whole range of the GenericMultiComponent3d.
slip::Range<int> range(0,A1.dim3()-1,2);
//copy the the elements of the row 0 of the slice 0 of A1 iterated according to the
//range in the row 1 of the slice 1 of A2
std::copy(A1.row_begin(0,0,range),A1.row_end(0,0,range),A2.row_begin(1,1));
const_row_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::row_end ( const size_type  slice,
const size_type  row,
const slip::Range< int > &  range 
) const
inherited

Returns a read_only iterator that points one past the last element of the Range range of the row row in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters
sliceThe index of the slice.
rowRow to iterate.
rangeRange of the row to iterate
Returns
begin const_row_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
row must be compatible with the range of the GenericMultiComponent3d.
The range must be inside the whole range of the GenericMultiComponent3d.
slip::Range<int> range(0,A1.dim3()-1,2);
//copy the the elements of the row 0 of the slice 0 of A1 iterated according to the
//range in the row 1 of the slice 1 of A2
std::copy(A1.row_begin(0,0,range),A1.row_end(0,0,range),A2.row_begin(1,1));
component_row_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::row_end ( const std::size_t  component,
const size_type  slice,
const size_type  row 
)
inherited

Returns a read/write iterator that points to the past-the-end element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters
componentThe component number.
sliceThe index of the slice.
rowThe index of the row.
Returns
end row_iterator value
const_component_row_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::row_end ( const std::size_t  component,
const size_type  slice,
const size_type  row 
) const
inherited

Returns a read_only iterator that points to the past-the-end element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters
componentThe component number.
sliceThe index of the slice.
rowThe index of the row.
componentThe component number.
Returns
end const_row_iterator value
component_row_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::row_end ( const std::size_t  component,
const size_type  slice,
const size_type  row,
const slip::Range< int > &  range 
)
inherited

Returns a read/write iterator that points one past the end element of the Range range of the row row in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters
componentThe component number.
sliceThe index of the slice.
rowThe index of the row to iterate.
rangeRange of the row to iterate.
Returns
end row_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
row must be compatible with the range of the GenericMultiComponent3d.
The range must be inside the whole range of the GenericMultiComponent3d.
slip::Range<int> range(0,A1.dim2()-1,2);
//copy the the elements of the row 0 of A1 iterated according to the
//range in the row 1 of A2
std::copy(A1.row_begin(0,range),A1.row_end(0,range),A2.row_begin(1));
const_component_row_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::row_end ( const std::size_t  component,
const size_type  slice,
const size_type  row,
const slip::Range< int > &  range 
) const
inherited

Returns a read_only iterator that points one past the last element of the Range range of the row row in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters
componentThe component number.
sliceThe index of the slice.
rowRow to iterate.
rangeRange of the row to iterate
Returns
begin const_row_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
row must be compatible with the range of the GenericMultiComponent3d.
The range must be inside the whole range of the GenericMultiComponent3d.
slip::Range<int> range(0,A1.dim2()-1,2);
//copy the the elements of the row 0 of A1 iterated according to the
//range in the row 1 of A2
std::copy(A1.row_begin(0,range),A1.row_end(0,range),A2.row_begin(1));
reverse_row_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::row_rbegin ( const size_type  slice,
const size_type  row 
)
inherited

Returns a read/write reverse iterator that points to the last element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in reverse element order.

Parameters
sliceThe index of the slice.
rowThe index of the row.
Returns
begin reverse_row_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
const_reverse_row_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::row_rbegin ( const size_type  slice,
const size_type  row 
) const
inherited

Returns a read_only reverse iterator that points to the last element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in reverse element order.

Parameters
sliceThe index of the slice.
rowThe index of the row.
Returns
begin const_reverse_row_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
reverse_row_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::row_rbegin ( const size_type  slice,
const size_type  row,
const slip::Range< int > &  range 
)
inherited

Returns a read-write iterator that points to the last element of the Range range of the row of a slice row and slice in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters
sliceThe index of the slice.
rowThe index of the row to iterate.
rangeRange of the row to iterate.
Returns
reverse_row_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
row must be compatible with the range of the GenericMultiComponent3d.
The range must be inside the whole range of the GenericMultiComponent3d.
const_reverse_row_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::row_rbegin ( const size_type  slice,
const size_type  row,
const slip::Range< int > &  range 
) const
inherited

Returns a read-only iterator that points to the last element of the Range range of the row of a slice row in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters
sliceThe index of the slice.
rowThe index of the row to iterate.
rangeRange of the row to iterate
Returns
begin const_reverse_row_range_iterator value
Precondition
row must be compatible with the range of the GenericMultiComponent3d.
The range must be inside the whole range of the GenericMultiComponent3d.
reverse_component_row_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::row_rbegin ( const std::size_t  component,
const size_type  slice,
const size_type  row 
)
inherited

Returns a read/write reverse iterator that points to the last element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in reverse element order.

Parameters
componentThe component number.
sliceThe index of the slice.
rowThe index of the row.
Returns
begin reverse_row_iterator value
const_reverse_component_row_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::row_rbegin ( const std::size_t  component,
const size_type  slice,
const size_type  row 
) const
inherited

Returns a read_only reverse iterator that points to the last element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in reverse element order.

Parameters
componentThe component number.
sliceThe index of the slice.
rowThe index of the row.
Returns
begin const_reverse_row_iterator value
reverse_component_row_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::row_rbegin ( const std::size_t  component,
const size_type  slice,
const size_type  row,
const slip::Range< int > &  range 
)
inherited

Returns a read-write iterator that points to the last element of the Range range of the row of a slice row and slice in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters
componentThe component number.
sliceThe index of the slice.
rowThe index of the row to iterate.
rangeRange of the row to iterate.
Returns
reverse_row_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
row must be compatible with the range of the GenericMultiComponent3d.
The range must be inside the whole range of the GenericMultiComponent3d.
const_reverse_component_row_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::row_rbegin ( const std::size_t  component,
const size_type  slice,
const size_type  row,
const slip::Range< int > &  range 
) const
inherited

Returns a read-only iterator that points to the last element of the Range range of the row of a slice row in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters
componentThe component number.
sliceThe index of the slice.
rowThe index of the row to iterate.
rangeRange of the row to iterate
Returns
begin const_reverse_row_range_iterator value
Precondition
row must be compatible with the range of the GenericMultiComponent3d.
The range must be inside the whole range of the GenericMultiComponent3d.
reverse_row_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::row_rend ( const size_type  slice,
const size_type  row 
)
inherited

Returns a read/write reverse iterator that points to the first element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in reverse element order.

Parameters
sliceThe index of the slice.
rowThe index of the row.
Returns
end reverse_row_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
const_reverse_row_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::row_rend ( const size_type  slice,
const size_type  row 
) const
inherited

Returns a read_only reverse iterator that points to the first element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in reverse element order.

Parameters
sliceThe index of the slice.
rowThe index of the row.
Returns
end const_reverse_row_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
reverse_row_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::row_rend ( const size_type  slice,
const size_type  row,
const slip::Range< int > &  range 
)
inherited

Returns a read-write iterator that points one before the first element of the Range range of the row of a slice row in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters
sliceThe index of the slice.
rowThe index of the row to iterate.
rangeRange of the row to iterate.
Returns
reverse_row_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
row must be compatible with the range of the GenericMultiComponent3d.
The range must be inside the whole range of the GenericMultiComponent3d.
const_reverse_row_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::row_rend ( const size_type  slice,
const size_type  row,
const slip::Range< int > &  range 
) const
inherited

Returns a read-only iterator that points one before the first element of the Range range of the row of a slice row in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters
sliceThe index of the slice.
rowThe index of the row to iterate.
rangeRange of the row to iterate
Returns
const_reverse_row_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
row must be compatible with the range of the GenericMultiComponent3d.
The range must be inside the whole range of the GenericMultiComponent3d.
reverse_component_row_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::row_rend ( const std::size_t  component,
const size_type  slice,
const size_type  row 
)
inherited

Returns a read/write reverse iterator that points to the first element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in reverse element order.

Parameters
componentThe component number.
sliceThe index of the slice.
rowThe index of the row.
Returns
end reverse_row_iterator value
const_reverse_component_row_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::row_rend ( const std::size_t  component,
const size_type  slice,
const size_type  row 
) const
inherited

Returns a read_only reverse iterator that points to the first element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in reverse element order.

Parameters
componentThe component number.
sliceThe index of the slice.
rowThe index of the row.
Returns
end const_reverse_row_iterator value
reverse_component_row_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::row_rend ( const std::size_t  component,
const size_type  slice,
const size_type  row,
const slip::Range< int > &  range 
)
inherited

Returns a read-write iterator that points one before the first element of the Range range of the row of a slice row in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters
componentThe component number.
sliceThe index of the slice.
rowThe index of the row to iterate.
rangeRange of the row to iterate.
Returns
reverse_row_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
row must be compatible with the range of the GenericMultiComponent3d.
The range must be inside the whole range of the GenericMultiComponent3d.
const_reverse_component_row_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::row_rend ( const std::size_t  component,
const size_type  slice,
const size_type  row,
const slip::Range< int > &  range 
) const
inherited

Returns a read-only iterator that points one before the first element of the Range range of the row of a slice row in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters
componentThe component number.
sliceThe index of the slice.
rowThe index of the row to iterate.
rangeRange of the row to iterate
Returns
const_reverse_row_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
row must be compatible with the range of the GenericMultiComponent3d.
The range must be inside the whole range of the GenericMultiComponent3d.
size_type slip::GenericMultiComponent3d< slip::Vector3d< T > >::rows ( ) const
inherited

Returns the number of rows (first dimension size) in the GenericMultiComponent3d.

template<typename T , typename GridT>
void slip::RegularVector3dField3d< T, GridT >::set_grid_step ( const slip::Point3d< GridT > &  grid_step)
inline

Write access to the grid step of the grid.

Parameters
grid_stepA slip::Point3d<GridT>.

Definition at line 2317 of file RegularVector3dField3d.hpp.

template<typename T , typename GridT>
void slip::RegularVector3dField3d< T, GridT >::set_init_point ( const slip::Point3d< GridT > &  init_point)
inline

Write access to the init point of the grid.

Parameters
init_pointA slip::Point3d<GridT>.

Definition at line 2303 of file RegularVector3dField3d.hpp.

size_type slip::GenericMultiComponent3d< slip::Vector3d< T > >::size ( ) const
inherited

Returns the number of elements in the GenericMultiComponent3d.

slice_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_begin ( const size_type  row,
const size_type  col 
)
inherited

Returns a read/write iterator that points to the first element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order (increasing slice number).

Parameters
rowrow coordinate of the line
colcol coordinate of the line
Returns
slice_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Example:
const_slice_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_begin ( const size_type  row,
const size_type  col 
) const
inherited

Returns a read-only (constant) iterator that points to the first element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order (increasing slice number).

Parameters
rowrow coordinate of the line
colcol coordinate of the line
Returns
const_slice_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Example:
slice_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_begin ( const size_type  row,
const size_type  col,
const slip::Range< int > &  range 
)
inherited

Returns a read/write iterator that points to the first element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters
rowrow coordinate of the line
colcol coordinate of the line
rangeRange of the line to iterate.
Returns
begin slice_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
the range must be compatible with the slice dimensions
The range must be inside the whole range of the GenericMultiComponent3d.
Example:
slip::Range<int> range(0,A1.dim1()-1,2);
//copy the the elements of the line (0,0) of A1 iterated according to the
//range in the line (1,1) of A2
std::copy(A1.slice_begin(0,0,range),A1.slice_end(0,0,range),A2.slice_begin(1,1));
const_slice_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_begin ( const size_type  row,
const size_type  col,
const slip::Range< int > &  range 
) const
inherited

Returns a read only (constant) iterator that points to the first element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters
rowrow coordinate of the line
colcol coordinate of the line
rangeRange of the line to iterate.
Returns
begin const_slice_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
the range must be compatible with the slice dimensions
The range must be inside the whole range of the GenericMultiComponent3d.
Example:
slip::Range<int> range(0,A1.dim1()-1,2);
//copy the the elements of the line (0,0) of A1 iterated according to the
//range in the line (1,1) of A2
std::copy(A1.slice_begin(0,0,range),A1.slice_end(0,0,range),A2.slice_begin(1,1));
component_slice_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_begin ( const std::size_t  component,
const size_type  row,
const size_type  col 
)
inherited

Returns a read/write iterator that points to the first element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order (increasing slice number).

Parameters
componentThe component number.
rowrow coordinate of the line
colcol coordinate of the line
Returns
slice_iterator value
const_component_slice_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_begin ( const std::size_t  component,
const size_type  row,
const size_type  col 
) const
inherited

Returns a read-only (constant) iterator that points to the first element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order (increasing slice number).

Parameters
componentThe component number.
rowrow coordinate of the line
colcol coordinate of the line
Returns
const_slice_iterator value
component_slice_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_begin ( const std::size_t  component,
const size_type  row,
const size_type  col,
const slip::Range< int > &  range 
)
inherited

Returns a read/write iterator that points to the first element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters
componentThe component number.
rowrow coordinate of the line
colcol coordinate of the line
rangeRange of the line to iterate.
Returns
begin slice_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
the range must be compatible with the slice dimensions
The range must be inside the whole range of the GenericMultiComponent3d.
slip::Range<int> range(0,A1.dim1()-1,2);
//copy the the elements of the line (0,0) of A1 iterated according to the
//range in the line (1,1) of A2
std::copy(A1.slice_begin(0,0,range),A1.slice_end(0,0,range),A2.slice_begin(1,1));
const_component_slice_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_begin ( const std::size_t  component,
const size_type  row,
const size_type  col,
const slip::Range< int > &  range 
) const
inherited

Returns a read only (constant) iterator that points to the first element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters
componentThe component number.
rowrow coordinate of the line
colcol coordinate of the line
rangeRange of the line to iterate.
Returns
begin const_slice_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
the range must be compatible with the slice dimensions
The range must be inside the whole range of the GenericMultiComponent3d.
slip::Array3d<double> const A1(M); //M is an already existing %GenericMultiComponent3d
slip::Range<int> range(0,A1.dim1()-1,2);
//display the elements of the line (0,0) of A1 iterated according to the range
std::copy(A1.slice_begin(0,0,range),A1.slice_end(0,0,range),std::ostream_iterator<double>(std::cout," "));
slice_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_end ( const size_type  row,
const size_type  col 
)
inherited

Returns a read/write iterator that points to the one past the end element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order (increasing slice number).

Parameters
rowrow coordinate of the line
colcol coordinate of the line
Returns
slice_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Example:
const_slice_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_end ( const size_type  row,
const size_type  col 
) const
inherited

Returns a read-only (constant) iterator that points to the one past the end element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order (increasing slice number).

Parameters
rowrow coordinate of the line
colcol coordinate of the line
Returns
const_slice_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Example:
slice_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_end ( const size_type  row,
const size_type  col,
const slip::Range< int > &  range 
)
inherited

Returns a read/write iterator that points one past the end element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters
rowrow coordinate of the line
colcol coordinate of the line
rangeRange of the line to iterate.
Returns
end slice_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
the range must be compatible with the slice dimensions
The range must be inside the whole range of the GenericMultiComponent3d.
Example:
slip::Range<int> range(0,A1.dim1()-1,2);
//copy the the elements of the line (0,0) of A1 iterated according to the
//range in the line (1,1) of A2
std::copy(A1.slice_begin(0,0,range),A1.slice_end(0,0,range),A2.slice_begin(1,1));
const_slice_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_end ( const size_type  row,
const size_type  col,
const slip::Range< int > &  range 
) const
inherited

Returns a read_only iterator that points one past the last element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters
rowrow coordinate of the line
colcol coordinate of the line
rangeRange of the line to iterate.
Returns
end const_slice_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
the range must be compatible with the slice dimensions
The range must be inside the whole range of the GenericMultiComponent3d.
Example:
slip::Range<int> range(0,A1.dim1()-1,2);
//copy the the elements of the line (0,0) of A1 iterated according to the
//range in the line (1,1) of A2
std::copy(A1.slice_begin(0,0,range),A1.slice_end(0,0,range),A2.slice_begin(1,1));
component_slice_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_end ( const std::size_t  component,
const size_type  row,
const size_type  col 
)
inherited

Returns a read/write iterator that points to the one past the end element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order (increasing slice number).

Parameters
componentThe component number.
rowrow coordinate of the line
colcol coordinate of the line
Returns
slice_iterator value
const_component_slice_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_end ( const std::size_t  component,
const size_type  row,
const size_type  col 
) const
inherited

Returns a read-only (constant) iterator that points to the one past the end element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order (increasing slice number).

Parameters
componentThe component number.
rowrow coordinate of the line
colcol coordinate of the line
Returns
const_slice_iterator value
component_slice_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_end ( const std::size_t  component,
const size_type  row,
const size_type  col,
const slip::Range< int > &  range 
)
inherited

Returns a read/write iterator that points one past the end element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters
componentThe component number.
rowrow coordinate of the line
colcol coordinate of the line
rangeRange of the line to iterate.
Returns
end slice_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
the range must be compatible with the slice dimensions
The range must be inside the whole range of the GenericMultiComponent3d.
slip::Range<int> range(0,A1.dim1()-1,2);
//copy the the elements of the line (0,0) of A1 iterated according to the
//range in the line (1,1) of A2
std::copy(A1.slice_range_begin(0,0,range),A1.slice_range_end(0,0,range),A2.slice_begin(1,1));
const_component_slice_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_end ( const std::size_t  component,
const size_type  row,
const size_type  col,
const slip::Range< int > &  range 
) const
inherited

Returns a read_only iterator that points one past the last element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters
componentThe component number.
rowrow coordinate of the line
colcol coordinate of the line
rangeRange of the line to iterate.
Returns
end const_slice_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
the range must be compatible with the slice dimensions
The range must be inside the whole range of the GenericMultiComponent3d.
slip::Array3d<double> const A1(M); //M is an already existing %GenericMultiComponent3d
slip::Range<int> range(0,A1.dim1()-1,2);
//display the elements of the line (0,0) of A1 iterated according to the range
std::copy(A1.slice_begin(0,0,range),A1.slice_end(0,0,range),std::ostream_iterator<double>(std::cout," "));
reverse_slice_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_rbegin ( const size_type  row,
const size_type  col 
)
inherited

Returns a read/write iterator that points to the last element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order (decreasing slice number).

Parameters
rowrow coordinate of the line
colcol coordinate of the line
Returns
reverse_slice_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Example:
const_reverse_slice_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_rbegin ( const size_type  row,
const size_type  col 
) const
inherited

Returns a read-only (constant) iterator that points to the last element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order (decreasing slice number).

Parameters
rowrow coordinate of the line
colcol coordinate of the line
Returns
const_reverse_slice_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Example:
reverse_slice_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_rbegin ( const size_type  row,
const size_type  col,
const slip::Range< int > &  range 
)
inherited

Returns a read/write iterator that points to the last element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters
rowrow coordinate of the line
colcol coordinate of the line
rangeRange of the line to iterate.
Returns
begin reverse_slice_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
the range must be compatible with the slice dimensions
The range must be inside the whole range of the GenericMultiComponent3d.
Example:
slip::Range<int> range(0,A1.dim1()-1,2);
//copy the the elements of the line (0,0) of A1 iterated according to the
//range in the line (1,1) of A2
std::copy(A1.slice_rbegin(0,0,range),A1.slice_rend(0,0,range),A2.slice_rbegin(1,1));
const_reverse_slice_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_rbegin ( const size_type  row,
const size_type  col,
const slip::Range< int > &  range 
) const
inherited

Returns a read only (constant) iterator that points to the last element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order according to the Range.

Parameters
rowrow coordinate of the line
colcol coordinate of the line
rangeRange of the line to iterate.
Returns
begin const_reverse_slice_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
the range must be compatible with the slice dimensions
The range must be inside the whole range of the GenericMultiComponent3d.
Example:
slip::Range<int> range(0,A1.dim1()-1,2);
//copy the the elements of the line (0,0) of A1 iterated according to the
//range in the line (1,1) of A2
std::copy(A1.slice_rbegin(0,0,range),A1.slice_rend(0,0,range),A2.slice_rbegin(1,1));
reverse_component_slice_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_rbegin ( const std::size_t  component,
const size_type  row,
const size_type  col 
)
inherited

Returns a read/write iterator that points to the last element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order (decreasing slice number).

Parameters
componentThe component number.
rowrow coordinate of the line
colcol coordinate of the line
Returns
reverse_slice_iterator value
const_reverse_component_slice_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_rbegin ( const std::size_t  component,
const size_type  row,
const size_type  col 
) const
inherited

Returns a read-only (constant) iterator that points to the last element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order (decreasing slice number).

Parameters
componentThe component number.
rowrow coordinate of the line
colcol coordinate of the line
Returns
const_reverse_slice_iterator value
reverse_component_slice_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_rbegin ( const std::size_t  component,
const size_type  row,
const size_type  col,
const slip::Range< int > &  range 
)
inherited

Returns a read/write iterator that points to the last element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters
componentThe component number.
rowrow coordinate of the line
colcol coordinate of the line
rangeRange of the line to iterate.
Returns
begin reverse_slice_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
the range must be compatible with the slice dimensions
The range must be inside the whole range of the GenericMultiComponent3d.
const_reverse_component_slice_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_rbegin ( const std::size_t  component,
const size_type  row,
const size_type  col,
const slip::Range< int > &  range 
) const
inherited

Returns a read only (constant) iterator that points to the last element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order according to the Range.

Parameters
componentThe component number.
rowrow coordinate of the line
colcol coordinate of the line
rangeRange of the line to iterate.
Returns
begin const_reverse_slice_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
the range must be compatible with the slice dimensions
The range must be inside the whole range of the GenericMultiComponent3d.
reverse_slice_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_rend ( const size_type  row,
const size_type  col 
)
inherited

Returns a read/write iterator that points to the one before the first element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order (decreasing slice number).

Parameters
rowrow coordinate of the line
colcol coordinate of the line
Returns
reverse_slice_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Example:
const_reverse_slice_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_rend ( const size_type  row,
const size_type  col 
) const
inherited

Returns a read (constant) iterator that points to the one before the first element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order (decreasing slice number).

Parameters
rowrow coordinate of the line
colcol coordinate of the line
Returns
const_reverse_slice_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Example:
reverse_slice_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_rend ( const size_type  row,
const size_type  col,
const slip::Range< int > &  range 
)
inherited

Returns a read/write iterator that points to the first element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order according to the Range.

Parameters
rowrow coordinate of the line
colcol coordinate of the line
rangeRange of the line to iterate.
Returns
end reverse_slice_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
the range must be compatible with the slice dimensions
The range must be inside the whole range of the GenericMultiComponent3d.
Example:
slip::Range<int> range(0,A1.dim1()-1,2);
//copy the the elements of the line (0,0) of A1 iterated according to the
//range in the line (1,1) of A2
std::copy(A1.slice_rbegin(0,0,range),A1.slice_rend(0,0,range),A2.slice_rbegin(1,1));
const_reverse_slice_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_rend ( const size_type  row,
const size_type  col,
const slip::Range< int > &  range 
) const
inherited

Returns a read_only iterator that points one past the lastto the first element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order according to the Range.

Parameters
rowrow coordinate of the line
colcol coordinate of the line
rangeRange of the line to iterate.
Returns
end const_reverse_slice_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
the range must be compatible with the slice dimensions
The range must be inside the whole range of the GenericMultiComponent3d.
Example:
slip::Range<int> range(0,A1.dim1()-1,2);
//copy the the elements of the line (0,0) of A1 iterated according to the
//range in the line (1,1) of A2
std::copy(A1.slice_rbegin(0,0,range),A1.slice_rend(0,0,range),A2.slice_rbegin(1,1));
reverse_component_slice_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_rend ( const std::size_t  component,
const size_type  row,
const size_type  col 
)
inherited

Returns a read/write iterator that points to the one before the first element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order (decreasing slice number).

Parameters
componentThe component number.
rowrow coordinate of the line
colcol coordinate of the line
Returns
reverse_slice_iterator value
const_reverse_component_slice_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_rend ( const std::size_t  component,
const size_type  row,
const size_type  col 
) const
inherited

Returns a read (constant) iterator that points to the one before the first element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order (decreasing slice number).

Parameters
componentThe component number.
rowrow coordinate of the line
colcol coordinate of the line
Returns
const_reverse_slice_iterator value
reverse_component_slice_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_rend ( const std::size_t  component,
const size_type  row,
const size_type  col,
const slip::Range< int > &  range 
)
inherited

Returns a read/write iterator that points to the first element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order according to the Range.

Parameters
componentThe component number.
rowrow coordinate of the line
colcol coordinate of the line
rangeRange of the line to iterate.
Returns
end reverse_slice_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
the range must be compatible with the slice dimensions
The range must be inside the whole range of the GenericMultiComponent3d.
const_reverse_component_slice_range_iterator slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_rend ( const std::size_t  component,
const size_type  row,
const size_type  col,
const slip::Range< int > &  range 
) const
inherited

Returns a read_only iterator that points one past the lastto the first element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order according to the Range.

Parameters
componentThe component number.
rowrow coordinate of the line
colcol coordinate of the line
rangeRange of the line to iterate.
Returns
end const_reverse_slice_range_iterator value
Remarks
This iterator is compatible with RandomAccessIterator algorithms.
Precondition
the range must be compatible with the slice dimensions
The range must be inside the whole range of the GenericMultiComponent3d.
size_type slip::GenericMultiComponent3d< slip::Vector3d< T > >::slice_size ( ) const
inherited

Returns the number of elements in a slice of the GenericMultiComponent3d.

size_type slip::GenericMultiComponent3d< slip::Vector3d< T > >::slices ( ) const
inherited

Returns the number of slices (first dimension size) in the GenericMultiComponent3d.

void slip::GenericMultiComponent3d< slip::Vector3d< T > >::swap ( self M)
inherited

Swaps data with another GenericMultiComponent3d.

Parameters
MA GenericMultiComponent3d of the same element type
template<typename T , typename GridT >
T & slip::RegularVector3dField3d< T, GridT >::u ( const size_type  k,
const size_type  i,
const size_type  j 
)
inline

Subscript access to first element of the data contained in the RegularVector3dField3d.

Parameters
kThe index of the slice for which the data should be accessed.
iThe index of the row for which the data should be accessed.
jThe index of the column for which the data should be accessed.
Returns
Read/Write reference to data.
Precondition
k < slices()
i < rows()
j < columns()

This operator allows for easy, 3d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.

Definition at line 2138 of file RegularVector3dField3d.hpp.

template<typename T , typename GridT >
const T & slip::RegularVector3dField3d< T, GridT >::u ( const size_type  k,
const size_type  i,
const size_type  j 
) const
inline

Subscript access to first element of the data contained in the RegularVector3dField3d.

Parameters
kThe index of the slice for which the data should be accessed.
iThe index of the row for which the data should be accessed.
jThe index of the column for which the data should be accessed.
Returns
Read const_reference to data.
Precondition
k < slices()
i < rows()
j < columns()

This operator allows for easy, 3d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.

Definition at line 2147 of file RegularVector3dField3d.hpp.

template<typename T , typename GridT >
T & slip::RegularVector3dField3d< T, GridT >::v ( const size_type  k,
const size_type  i,
const size_type  j 
)
inline

Subscript access to second element of the data contained in the RegularVector3dField3d.

Parameters
kThe index of the slice for which the data should be accessed.
iThe index of the row for which the data should be accessed.
jThe index of the column for which the data should be accessed.
Returns
Read/Write reference to data.
Precondition
k < slices()
i < rows()
j < columns()

This operator allows for easy, 3d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.

Definition at line 2175 of file RegularVector3dField3d.hpp.

template<typename T , typename GridT >
const T & slip::RegularVector3dField3d< T, GridT >::v ( const size_type  k,
const size_type  i,
const size_type  j 
) const
inline

Subscript access to second element of the data contained in the RegularVector3dField3d.

Parameters
kThe index of the slice for which the data should be accessed.
iThe index of the row for which the data should be accessed.
jThe index of the column for which the data should be accessed.
Returns
Read const_reference to data.
Precondition
k < slices()
i < rows()
j < columns()

This operator allows for easy, 3d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.

Definition at line 2185 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
template<typename Container3D >
void slip::RegularVector3dField3d< T, GridT >::vorticity ( const std::size_t  sch_order,
Container3D &  result 
) const
inline

Computes finite differences vorticity of a RegularVector3dField3d.

Author
Ludovic Chatellier <ludovic.chatellier_AT_lea.univ-poitiers.fr>
Date
2008/05/25
Version
0.0.1
Parameters
sch_orderOrder of derivation scheme.
resultA Container3D which contain the result of the vorticity=(dVz/dy-dVy/dz,dVx/dz-dVz/dx,dVy/dx-dVx/dy).
Precondition
sch_order must be >= 1
Example:
slip::Array3d<double> Matrice(3,6,7,0.0);
slip::iota(Matrice.begin(),Matrice.end(),1.0,1.0);
slip::RegularVector3dField3d<double> VFM(3,6,7,Matrice.begin(),Matrice.end(),Matrice.begin(),Matrice.begin());
slip::RegularVector3dField3d<double> vort(VFM.slices(),VFM.rows(),VFM.cols());
VFM.vorticity(1,vort);
std::cout<<vort<<std::endl;

Definition at line 1353 of file RegularVector3dField3d.hpp.

template<typename T , typename GridT >
T & slip::RegularVector3dField3d< T, GridT >::Vx1 ( const size_type  k,
const size_type  i,
const size_type  j 
)
inline

Subscript access to first element of the data contained in the RegularVector3dField3d.

Parameters
kThe index of the slice for which the data should be accessed.
iThe index of the row for which the data should be accessed.
jThe index of the column for which the data should be accessed.
Returns
Read/Write reference to data.
Precondition
k < slices()
i < rows()
j < columns()

This operator allows for easy, 3d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.

Definition at line 2120 of file RegularVector3dField3d.hpp.

template<typename T , typename GridT >
const T & slip::RegularVector3dField3d< T, GridT >::Vx1 ( const size_type  k,
const size_type  i,
const size_type  j 
) const
inline

Subscript access to first element of the data contained in the RegularVector3dField3d.

Parameters
kThe index of the slice for which the data should be accessed.
iThe index of the row for which the data should be accessed.
jThe index of the column for which the data should be accessed.
Returns
Read const_reference to data.
Precondition
k < slices()
i < rows()
j < columns()

This operator allows for easy, 3d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.

Definition at line 2129 of file RegularVector3dField3d.hpp.

template<typename T , typename GridT >
T & slip::RegularVector3dField3d< T, GridT >::Vx2 ( const size_type  k,
const size_type  i,
const size_type  j 
)
inline

Subscript access to second element of the data contained in the RegularVector3dField3d.

Parameters
kThe index of the slice for which the data should be accessed.
iThe index of the row for which the data should be accessed.
jThe index of the column for which the data should be accessed.
Returns
Read/Write reference to data.
Precondition
k < slices()
i < rows()
j < columns()

This operator allows for easy, 3d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.

Definition at line 2157 of file RegularVector3dField3d.hpp.

template<typename T , typename GridT >
const T & slip::RegularVector3dField3d< T, GridT >::Vx2 ( const size_type  k,
const size_type  i,
const size_type  j 
) const
inline

Subscript access to second element of the data contained in the RegularVector3dField3d.

Parameters
kThe index of the slice for which the data should be accessed.
iThe index of the row for which the data should be accessed.
jThe index of the column for which the data should be accessed.
Returns
Read const_reference to data.
Precondition
k < slices()
i < rows()
j < columns()

This operator allows for easy, 3d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.

Definition at line 2167 of file RegularVector3dField3d.hpp.

template<typename T , typename GridT >
T & slip::RegularVector3dField3d< T, GridT >::Vx3 ( const size_type  k,
const size_type  i,
const size_type  j 
)
inline

Subscript access to third element of the data contained in the RegularVector3dField3d.

Parameters
kThe index of the slice for which the data should be accessed.
iThe index of the row for which the data should be accessed.
jThe index of the column for which the data should be accessed.
Returns
Read/Write reference to data.
Precondition
k < slices()
i < rows()
j < columns()

This operator allows for easy, 3d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.

Definition at line 2195 of file RegularVector3dField3d.hpp.

template<typename T , typename GridT >
const T & slip::RegularVector3dField3d< T, GridT >::Vx3 ( const size_type  k,
const size_type  i,
const size_type  j 
) const
inline

Subscript access to third element of the data contained in the RegularVector3dField3d.

Parameters
kThe index of the slice for which the data should be accessed.
iThe index of the row for which the data should be accessed.
jThe index of the column for which the data should be accessed.
Returns
Read const_reference to data.
Precondition
k < slices()
i < rows()
j < columns()

This operator allows for easy, 3d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.

Definition at line 2204 of file RegularVector3dField3d.hpp.

template<typename T , typename GridT >
T & slip::RegularVector3dField3d< T, GridT >::w ( const size_type  k,
const size_type  i,
const size_type  j 
)
inline

Subscript access to third element of the data contained in the RegularVector3dField3d.

Parameters
kThe index of the slice for which the data should be accessed.
iThe index of the row for which the data should be accessed.
jThe index of the column for which the data should be accessed.
Returns
Read/Write reference to data.
Precondition
k < slices()
i < rows()
j < columns()

This operator allows for easy, 3d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.

Definition at line 2213 of file RegularVector3dField3d.hpp.

template<typename T , typename GridT >
const T & slip::RegularVector3dField3d< T, GridT >::w ( const size_type  k,
const size_type  i,
const size_type  j 
) const
inline

Subscript access to third element of the data contained in the RegularVector3dField3d.

Parameters
kThe index of the slice for which the data should be accessed.
iThe index of the row for which the data should be accessed.
jThe index of the column for which the data should be accessed.
Returns
Read const_reference to data.
Precondition
k < slices()
i < rows()
j < columns()

This operator allows for easy, 3d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.

Definition at line 2222 of file RegularVector3dField3d.hpp.

template<typename T , typename GridT >
void slip::RegularVector3dField3d< T, GridT >::write_tecplot ( const std::string &  file_path_name,
const std::string &  title,
const std::string &  zone 
) const
inline

Writes a RegularVector3dField3d to a tecplot file path name.

Parameters
file_path_name
title
zone
The data format is the following:

TITLE= title

VARIABLES= X Y Z U V W

ZONE T= zone, K= dim1(), I= dim2(), J= dim3()

x y z Vx Vy Vz

Definition at line 2519 of file RegularVector3dField3d.hpp.

template<typename T , typename GridT >
void slip::RegularVector3dField3d< T, GridT >::write_tecplot_bin ( const std::string &  file_path_name,
const std::string &  title,
const std::string &  zone 
) const
inline

Writes a RegularVector3dField3d to a tecplot binary file.

Parameters
file_path_name
title
zone

Definition at line 2533 of file RegularVector3dField3d.hpp.

template<typename T , typename GridT >
const GridT slip::RegularVector3dField3d< T, GridT >::x ( const size_type  k,
const size_type  i,
const size_type  j 
) const
inline

Subscript access to the real x1 value of the indexed (k,i,j) point of the RegularVector3dField3d.

Parameters
kThe index of the slice for which the data should be accessed.
iThe index of the row for which the data should be accessed.
jThe index of the columns for which the data should be accessed.
Returns
Read_only (constant) reference to data.
Precondition
i < rows()
j < columns()

This operator allows for easy, 3d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.

Definition at line 2269 of file RegularVector3dField3d.hpp.

template<typename T , typename GridT >
const GridT slip::RegularVector3dField3d< T, GridT >::x1 ( const size_type  k,
const size_type  i,
const size_type  j 
) const
inline

Subscript access to the real x1 value of the indexed (k,i,j) point of the RegularVector3dField3d.

Parameters
kThe index of the slice for which the data should be accessed.
iThe index of the row for which the data should be accessed.
jThe index of the columns for which the data should be accessed.
Returns
Read_only (constant) reference to data.
Precondition
i < rows()
j < columns()

This operator allows for easy, 3d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.

Definition at line 2242 of file RegularVector3dField3d.hpp.

template<typename T , typename GridT >
const GridT slip::RegularVector3dField3d< T, GridT >::x2 ( const size_type  k,
const size_type  i,
const size_type  j 
) const
inline

Subscript access to the real x2 value of the indexed (k,i,j) point of the RegularVector3dField3d.

Parameters
kThe index of the slice for which the data should be accessed.
iThe index of the row for which the data should be accessed.
jThe index of the columns for which the data should be accessed.
Returns
Read_only (constant) reference to data.
Precondition
i < slices()
i < rows()
j < columns()

This operator allows for easy, 3d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.

Definition at line 2251 of file RegularVector3dField3d.hpp.

template<typename T , typename GridT >
const GridT slip::RegularVector3dField3d< T, GridT >::x3 ( const size_type  k,
const size_type  i,
const size_type  j 
) const
inline

Subscript access to the real x3 value of the indexed (k,i,j) point of the RegularVector3dField3d.

Parameters
kThe index of the slice for which the data should be accessed.
iThe index of the row for which the data should be accessed.
jThe index of the columns for which the data should be accessed.
Returns
Read_only (constant) reference to data.
Precondition
i < slices()
i < rows()
j < columns()

This operator allows for easy, 3d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.

Definition at line 2260 of file RegularVector3dField3d.hpp.

template<typename T , typename GridT >
const GridT slip::RegularVector3dField3d< T, GridT >::y ( const size_type  k,
const size_type  i,
const size_type  j 
) const
inline

Subscript access to the real x2 value of the indexed (k,i,j) point of the RegularVector3dField3d.

Parameters
kThe index of the slice for which the data should be accessed.
iThe index of the row for which the data should be accessed.
jThe index of the columns for which the data should be accessed.
Returns
Read_only (constant) reference to data.
Precondition
i < slices()
i < rows()
j < columns()

This operator allows for easy, 3d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.

Definition at line 2278 of file RegularVector3dField3d.hpp.

template<typename T , typename GridT >
const GridT slip::RegularVector3dField3d< T, GridT >::z ( const size_type  k,
const size_type  i,
const size_type  j 
) const
inline

Subscript access to the real x3 value of the indexed (k,i,j) point of the RegularVector3dField3d.

Parameters
kThe index of the slice for which the data should be accessed.
iThe index of the row for which the data should be accessed.
jThe index of the columns for which the data should be accessed.
Returns
Read_only (constant) reference to data.
Precondition
i < slices()
i < rows()
j < columns()

This operator allows for easy, 3d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.

Definition at line 2287 of file RegularVector3dField3d.hpp.

Friends And Related Function Documentation

template<typename T, typename GridT>
friend class boost::serialization::access
friend

Definition at line 1824 of file RegularVector3dField3d.hpp.

template<typename T, typename GridT>
std::ostream& operator<< ( std::ostream &  out,
const self a 
)
friend

Write the RegularVector3dField3d to the ouput stream.

Parameters
outoutput stream
aRegularVector3dField3d to write to the output stream

Definition at line 2478 of file RegularVector3dField3d.hpp.

Member Data Documentation

const std::size_t slip::GenericMultiComponent3d< slip::Vector3d< T > >::COMPONENTS
staticinherited

Definition at line 313 of file GenericMultiComponent3d.hpp.

template<typename T, typename GridT>
const std::size_t slip::RegularVector3dField3d< T, GridT >::DIM = 3
static

Definition at line 209 of file RegularVector3dField3d.hpp.


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