PhyStar  v0.0.0 thu24
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
blockelm::CartField< T, N_dim > Class Template Reference

#include <CartField.hpp>

Public Member Functions

 CartField ()
 
 CartField (std::vector< int > fls, CartMesh< N_dim > *pmsh)
 
 CartField (int fls, CartMesh< N_dim > *pmsh)
 
 ~CartField ()
 
CartField< T, N_dim > & Create (std::vector< int > fls, CartMesh< N_dim > *pmsh)
 create a CartField from an existing cartmesh, including the ghost mesh More...
 
CartField< T, N_dim > & CopyExcludeData (const CartField< T, N_dim > &field)
 
CartField< T, N_dim > & Copy (const CartField< T, N_dim > &field)
 
const CartMesh< N_dim > & GetMesh () const
 
const Array1r & GetMesh (int dir)
 
const int & GetGhostLow (int dir)
 
const int & GetGhostUp (int dir)
 
Real * PtrData ()
 
std::vector< int > GetShape ()
 Get the shape of the field, including the ghost part. More...
 
std::vector< int > GetFlag ()
 Get the Flag of the mesh, center or face. More...
 
constexpr int GetNdim () const
 
T & atGBIndex (int i)
 
T & atGBIndex (int i, int j)
 
T & atGBIndex (int i, int j, int k)
 
T & operator() (int i)
 
T & operator() (int i, int j)
 
T & operator() (int i, int j, int k)
 
Array< T, N_dim > operator() (Range range1)
 
Array< T, N_dim > operator() (Range range1, Range range2)
 
Array< T, N_dim > operator() (Range range1, Range range2, Range range3)
 

Public Attributes

Array< T, N_dim > data
 
CartMesh< N_dim > * ptr_mesh
 
Veci< N_dim > shape
 
Veci< N_dim > flag
 
Veci< N_dim > & st_ind = ptr_mesh->st_ind
 

Static Public Attributes

static const int ndim = N_dim
 

Constructor & Destructor Documentation

◆ CartField() [1/3]

template<typename T , int N_dim>
blockelm::CartField< T, N_dim >::CartField ( )
inline

References blockelm::CartField< T, N_dim >::ptr_mesh.

◆ CartField() [2/3]

template<typename T , int N_dim>
blockelm::CartField< T, N_dim >::CartField ( std::vector< int >  fls,
CartMesh< N_dim > *  pmsh 
)
inline

References blockelm::CartField< T, N_dim >::Create().

Here is the call graph for this function:

◆ CartField() [3/3]

template<typename T , int N_dim>
blockelm::CartField< T, N_dim >::CartField ( int  fls,
CartMesh< N_dim > *  pmsh 
)
inline

References blockelm::CartField< T, N_dim >::Create().

Here is the call graph for this function:

◆ ~CartField()

template<typename T , int N_dim>
blockelm::CartField< T, N_dim >::~CartField ( )
inline

Member Function Documentation

◆ atGBIndex() [1/3]

template<typename T , int N_dim>
T& blockelm::CartField< T, N_dim >::atGBIndex ( int  i)
inline

References blockelm::CartField< T, N_dim >::data, and blockelm::CartField< T, N_dim >::st_ind.

◆ atGBIndex() [2/3]

template<typename T , int N_dim>
T& blockelm::CartField< T, N_dim >::atGBIndex ( int  i,
int  j 
)
inline

References blockelm::CartField< T, N_dim >::data, and blockelm::CartField< T, N_dim >::st_ind.

◆ atGBIndex() [3/3]

template<typename T , int N_dim>
T& blockelm::CartField< T, N_dim >::atGBIndex ( int  i,
int  j,
int  k 
)
inline

References blockelm::CartField< T, N_dim >::data, and blockelm::CartField< T, N_dim >::st_ind.

◆ Copy()

template<typename T , int N_dim>
CartField<T, N_dim>& blockelm::CartField< T, N_dim >::Copy ( const CartField< T, N_dim > &  field)
inline

References blockelm::CartField< T, N_dim >::data, blockelm::CartField< T, N_dim >::flag, blockelm::CartField< T, N_dim >::ptr_mesh, and blockelm::CartField< T, N_dim >::shape.

◆ CopyExcludeData()

template<typename T , int N_dim>
CartField<T, N_dim>& blockelm::CartField< T, N_dim >::CopyExcludeData ( const CartField< T, N_dim > &  field)
inline

References blockelm::CartField< T, N_dim >::data, blockelm::CartField< T, N_dim >::flag, blockelm::CartField< T, N_dim >::ptr_mesh, and blockelm::CartField< T, N_dim >::shape.

Here is the caller graph for this function:

◆ Create()

template<typename T , int N_dim>
CartField<T, N_dim>& blockelm::CartField< T, N_dim >::Create ( std::vector< int >  fls,
CartMesh< N_dim > *  pmsh 
)
inline

create a CartField from an existing cartmesh, including the ghost mesh

Parameters
flsflags, center or face
pmshmesh
Returns
CartField<T,N_dim>&

References blockelm::CartField< T, N_dim >::data, blockelm::CartField< T, N_dim >::flag, blockelm::kcenter, blockelm::CartField< T, N_dim >::ptr_mesh, and blockelm::CartField< T, N_dim >::shape.

Here is the caller graph for this function:

◆ GetFlag()

template<typename T , int N_dim>
std::vector<int> blockelm::CartField< T, N_dim >::GetFlag ( )
inline

Get the Flag of the mesh, center or face.

Returns

References blockelm::CartField< T, N_dim >::flag.

Here is the caller graph for this function:

◆ GetGhostLow()

template<typename T , int N_dim>
const int& blockelm::CartField< T, N_dim >::GetGhostLow ( int  dir)
inline

References blockelm::CartField< T, N_dim >::ptr_mesh.

◆ GetGhostUp()

template<typename T , int N_dim>
const int& blockelm::CartField< T, N_dim >::GetGhostUp ( int  dir)
inline

References blockelm::CartField< T, N_dim >::ptr_mesh.

◆ GetMesh() [1/2]

template<typename T , int N_dim>
const CartMesh<N_dim>& blockelm::CartField< T, N_dim >::GetMesh ( ) const
inline

References blockelm::CartField< T, N_dim >::ptr_mesh.

Here is the caller graph for this function:

◆ GetMesh() [2/2]

template<typename T , int N_dim>
const Array1r& blockelm::CartField< T, N_dim >::GetMesh ( int  dir)
inline

References blockelm::CartField< T, N_dim >::flag, and blockelm::CartField< T, N_dim >::ptr_mesh.

◆ GetNdim()

template<typename T , int N_dim>
constexpr int blockelm::CartField< T, N_dim >::GetNdim ( ) const
inlineconstexpr

◆ GetShape()

template<typename T , int N_dim>
std::vector<int> blockelm::CartField< T, N_dim >::GetShape ( )
inline

Get the shape of the field, including the ghost part.

Returns

References blockelm::CartField< T, N_dim >::shape.

Here is the caller graph for this function:

◆ operator()() [1/6]

template<typename T , int N_dim>
T& blockelm::CartField< T, N_dim >::operator() ( int  i)
inline

References blockelm::CartField< T, N_dim >::data.

◆ operator()() [2/6]

template<typename T , int N_dim>
T& blockelm::CartField< T, N_dim >::operator() ( int  i,
int  j 
)
inline

References blockelm::CartField< T, N_dim >::data.

◆ operator()() [3/6]

template<typename T , int N_dim>
T& blockelm::CartField< T, N_dim >::operator() ( int  i,
int  j,
int  k 
)
inline

References blockelm::CartField< T, N_dim >::data.

◆ operator()() [4/6]

template<typename T , int N_dim>
Array<T, N_dim> blockelm::CartField< T, N_dim >::operator() ( Range  range1)
inline

References blockelm::CartField< T, N_dim >::data.

◆ operator()() [5/6]

template<typename T , int N_dim>
Array<T, N_dim> blockelm::CartField< T, N_dim >::operator() ( Range  range1,
Range  range2 
)
inline

References blockelm::CartField< T, N_dim >::data.

◆ operator()() [6/6]

template<typename T , int N_dim>
Array<T, N_dim> blockelm::CartField< T, N_dim >::operator() ( Range  range1,
Range  range2,
Range  range3 
)
inline

References blockelm::CartField< T, N_dim >::data.

◆ PtrData()

template<typename T , int N_dim>
Real* blockelm::CartField< T, N_dim >::PtrData ( )
inline

References blockelm::CartField< T, N_dim >::data.

Here is the caller graph for this function:

Member Data Documentation

◆ data

template<typename T , int N_dim>
Array<T, N_dim> blockelm::CartField< T, N_dim >::data

◆ flag

template<typename T , int N_dim>
Veci<N_dim> blockelm::CartField< T, N_dim >::flag

◆ ndim

template<typename T , int N_dim>
const int blockelm::CartField< T, N_dim >::ndim = N_dim
static

◆ ptr_mesh

template<typename T , int N_dim>
CartMesh<N_dim>* blockelm::CartField< T, N_dim >::ptr_mesh

◆ shape

template<typename T , int N_dim>
Veci<N_dim> blockelm::CartField< T, N_dim >::shape

◆ st_ind

template<typename T , int N_dim>
Veci<N_dim>& blockelm::CartField< T, N_dim >::st_ind = ptr_mesh->st_ind
The documentation for this class was generated from the following file: