Project
Loading...
Searching...
No Matches
Public Member Functions | List of all members
o2::tpc::Vector3D< DataT > Class Template Reference

this is a simple vector class which is used in the poisson solver class More...

#include <Vector3D.h>

Public Member Functions

 Vector3D (const unsigned int nr, const unsigned int nz, const unsigned int nphi)
 
 Vector3D ()=default
 default constructor
 
DataT & operator() (const unsigned int iR, const unsigned int iZ, const unsigned int iPhi)
 operator to set the values
 
const DataT & operator() (const unsigned int iR, const unsigned int iZ, const unsigned int iPhi) const
 operator to read the values
 
DataT & operator[] (const unsigned int index)
 operator to directly access the values
 
const DataT & operator[] (const unsigned int index) const
 
int getIndex (const unsigned int iR, const unsigned int iZ, const unsigned int iPhi) const
 
void resize (const unsigned int nr, const unsigned int nz, const unsigned int nphi)
 
const auto & data () const
 
auto & data ()
 
unsigned int getNr () const
 get number of data points in r direction
 
unsigned int getNz () const
 get number of data points in z direction
 
unsigned int getNphi () const
 get number of data points in phi direction
 
unsigned int size () const
 get number of data points
 
auto begin () const
 
auto begin ()
 
auto end () const
 
auto end ()
 

Detailed Description

template<typename DataT = double>
class o2::tpc::Vector3D< DataT >

this is a simple vector class which is used in the poisson solver class

Template Parameters
DataTthe data type of the mStorage which is used during the calculations

Definition at line 30 of file Vector3D.h.

Constructor & Destructor Documentation

◆ Vector3D() [1/2]

template<typename DataT = double>
o2::tpc::Vector3D< DataT >::Vector3D ( const unsigned int  nr,
const unsigned int  nz,
const unsigned int  nphi 
)
inline

Constructor for a tricubic interpolator

Parameters
nrnumber of data points in r directions
nznumber of data points in r directions
nphinumber of data points in r directions

Definition at line 37 of file Vector3D.h.

◆ Vector3D() [2/2]

template<typename DataT = double>
o2::tpc::Vector3D< DataT >::Vector3D ( )
default

default constructor

Member Function Documentation

◆ begin() [1/2]

template<typename DataT = double>
auto o2::tpc::Vector3D< DataT >::begin ( )
inline

Definition at line 95 of file Vector3D.h.

◆ begin() [2/2]

template<typename DataT = double>
auto o2::tpc::Vector3D< DataT >::begin ( ) const
inline

Definition at line 94 of file Vector3D.h.

◆ data() [1/2]

template<typename DataT = double>
auto & o2::tpc::Vector3D< DataT >::data ( )
inline

Definition at line 87 of file Vector3D.h.

◆ data() [2/2]

template<typename DataT = double>
const auto & o2::tpc::Vector3D< DataT >::data ( ) const
inline

Definition at line 86 of file Vector3D.h.

◆ end() [1/2]

template<typename DataT = double>
auto o2::tpc::Vector3D< DataT >::end ( )
inline

Definition at line 98 of file Vector3D.h.

◆ end() [2/2]

template<typename DataT = double>
auto o2::tpc::Vector3D< DataT >::end ( ) const
inline

Definition at line 97 of file Vector3D.h.

◆ getIndex()

template<typename DataT = double>
int o2::tpc::Vector3D< DataT >::getIndex ( const unsigned int  iR,
const unsigned int  iZ,
const unsigned int  iPhi 
) const
inline
Parameters
iRindex in r direction
iZindex in z direction
iPhiindex in phi direction
Returns
returns the index for given indices

Definition at line 69 of file Vector3D.h.

◆ getNphi()

template<typename DataT = double>
unsigned int o2::tpc::Vector3D< DataT >::getNphi ( ) const
inline

get number of data points in phi direction

Definition at line 91 of file Vector3D.h.

◆ getNr()

template<typename DataT = double>
unsigned int o2::tpc::Vector3D< DataT >::getNr ( ) const
inline

get number of data points in r direction

Definition at line 89 of file Vector3D.h.

◆ getNz()

template<typename DataT = double>
unsigned int o2::tpc::Vector3D< DataT >::getNz ( ) const
inline

get number of data points in z direction

Definition at line 90 of file Vector3D.h.

◆ operator()() [1/2]

template<typename DataT = double>
DataT & o2::tpc::Vector3D< DataT >::operator() ( const unsigned int  iR,
const unsigned int  iZ,
const unsigned int  iPhi 
)
inline

operator to set the values

Definition at line 43 of file Vector3D.h.

◆ operator()() [2/2]

template<typename DataT = double>
const DataT & o2::tpc::Vector3D< DataT >::operator() ( const unsigned int  iR,
const unsigned int  iZ,
const unsigned int  iPhi 
) const
inline

operator to read the values

Definition at line 49 of file Vector3D.h.

◆ operator[]() [1/2]

template<typename DataT = double>
DataT & o2::tpc::Vector3D< DataT >::operator[] ( const unsigned int  index)
inline

operator to directly access the values

Definition at line 55 of file Vector3D.h.

◆ operator[]() [2/2]

template<typename DataT = double>
const DataT & o2::tpc::Vector3D< DataT >::operator[] ( const unsigned int  index) const
inline

Definition at line 60 of file Vector3D.h.

◆ resize()

template<typename DataT = double>
void o2::tpc::Vector3D< DataT >::resize ( const unsigned int  nr,
const unsigned int  nz,
const unsigned int  nphi 
)
inline

resize the vector

Parameters
nrnumber of data points in r directions
nznumber of data points in r directions
nphinumber of data points in r directions

Definition at line 78 of file Vector3D.h.

◆ size()

template<typename DataT = double>
unsigned int o2::tpc::Vector3D< DataT >::size ( ) const
inline

get number of data points

Definition at line 92 of file Vector3D.h.

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