PhyStar  v0.0.0 thu24
blockelm::CartMeshComp Struct Reference

#include <CartMeshComp.h>

Public Member Functions

 CartMeshComp ()
 Construct a new Cart Mesh Comp object. More...
 
 CartMeshComp (const int n, std::vector< Real > edge, std::vector< int > gh={0})
 Construct a new Cart Mesh Comp object. More...
 
 ~CartMeshComp ()
 Destroy the Cart Mesh Comp object. More...
 
CartMeshCompCreate (const int n, std::vector< Real > edge, std::vector< int > gh={0})
 create cart mesh comp More...
 
CartMeshCompSetEdge (Real el, Real eu)
 
int GetSize ()
 Get the Size of mesh of this component, including ghost mesh. More...
 
int GetSizeExcludeGh ()
 Get the Size of mesh, Excluding Ghost mesh. More...
 
std::vector< RealGetEdge ()
 
RealPtrData ()
 pointer to raw data of mesh More...
 
CartMeshCompUniformAtGridCenter ()
 create a uniform mesh with grid in center More...
 
CartMeshCompUniformAtGridFace ()
 create a uniform mesh with grid in face More...
 
Realoperator() (const int i)
 i-th elements More...
 
Array1r operator() (Range range)
 elements in a range More...
 

Public Attributes

Array1r data
 
int len
 
int gh_low
 
int gh_up
 
Real edge_low
 
Real edge_up
 
Real dh
 

Constructor & Destructor Documentation

◆ CartMeshComp() [1/2]

blockelm::CartMeshComp::CartMeshComp ( )

Construct a new Cart Mesh Comp object.

References edge_low, edge_up, gh_low, gh_up, and len.

◆ CartMeshComp() [2/2]

blockelm::CartMeshComp::CartMeshComp ( const int  n,
std::vector< Real edge,
std::vector< int >  gh = {0} 
)
inline

Construct a new Cart Mesh Comp object.

Parameters
nlength excluding ghost mesh
edge
gh

◆ ~CartMeshComp()

blockelm::CartMeshComp::~CartMeshComp ( )

Destroy the Cart Mesh Comp object.

Member Function Documentation

◆ Create()

CartMeshComp & blockelm::CartMeshComp::Create ( const int  n,
std::vector< Real edge,
std::vector< int >  gh = {0} 
)

create cart mesh comp

Parameters
nlength excluding ghost mesh
edgeedges
ghghost mesh
Returns
CartMeshComp&

References data, edge_low, edge_up, gh_low, gh_up, and len.

◆ GetEdge()

std::vector<Real> blockelm::CartMeshComp::GetEdge ( )
inline

◆ GetSize()

int blockelm::CartMeshComp::GetSize ( )
inline

Get the Size of mesh of this component, including ghost mesh.

Returns
int

◆ GetSizeExcludeGh()

int blockelm::CartMeshComp::GetSizeExcludeGh ( )
inline

Get the Size of mesh, Excluding Ghost mesh.

Returns
int

◆ operator()() [1/2]

Real& blockelm::CartMeshComp::operator() ( const int  i)
inline

i-th elements

Parameters
i
Returns
Real&

◆ operator()() [2/2]

Array1r blockelm::CartMeshComp::operator() ( Range  range)
inline

elements in a range

Parameters
range
Returns
Array1r

◆ PtrData()

Real* blockelm::CartMeshComp::PtrData ( )
inline

pointer to raw data of mesh

Returns
Real*

◆ SetEdge()

CartMeshComp& blockelm::CartMeshComp::SetEdge ( Real  el,
Real  eu 
)
inline

◆ UniformAtGridCenter()

CartMeshComp& blockelm::CartMeshComp::UniformAtGridCenter ( )
inline

create a uniform mesh with grid in center

Returns
CartMeshComp&

◆ UniformAtGridFace()

CartMeshComp& blockelm::CartMeshComp::UniformAtGridFace ( )
inline

create a uniform mesh with grid in face

Returns
CartMeshComp&

Member Data Documentation

◆ data

Array1r blockelm::CartMeshComp::data

◆ dh

Real blockelm::CartMeshComp::dh

◆ edge_low

Real blockelm::CartMeshComp::edge_low

◆ edge_up

Real blockelm::CartMeshComp::edge_up

◆ gh_low

int blockelm::CartMeshComp::gh_low

◆ gh_up

int blockelm::CartMeshComp::gh_up

◆ len

int blockelm::CartMeshComp::len

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