MoCSI API Reference
Loading...
Searching...
No Matches
Public Member Functions | List of all members
GridOneDim< T > Class Template Reference

Concrete implementation of a 1D grid on each facet of a 3D shape model (hereafter: pseudo 3D). More...

#include <GridOneDim.h>

Inheritance diagram for GridOneDim< T >:
Inheritance graph
Collaboration diagram for GridOneDim< T >:
Collaboration graph

Public Member Functions

void createGrid () override
 Creation function for a pseudo 3D grid, assuming a shape model is given. True 1D geometries can be constructed by passing a one facet "shape model". Creates a number of cells specified by the number of facets times the number of numerical layers-1 (corresponding to the number of nodes). The shift by 1 is due to the 1D grids having a number of nodes that is equal to the number of cells + 1.
 
T calculateCellLength ()
 
 GridOneDim (SimulationClassBase< T > *sim_ptr, std::shared_ptr< ShapeBase< T > > mesh_ptr)
 Constructor for a OneDimGrid object.
 
 ~GridOneDim ()=default
 
- Public Member Functions inherited from GridBase< T >
std::vector< std::unique_ptr< GenericElement< T > > > & getCells ()
 
void setMesh (std::shared_ptr< ShapeBase< T > > mesh)
 Sets the bounding surface mesh for the object, if a mesh is used.
 
int getGridSize () const
 
 GridBase ()
 Default Constructor.
 
 GridBase (SimulationClassBase< T > *sim_ptr, std::shared_ptr< ShapeBase< T > > mesh_ptr)
 Constructor for the empty grid class, as each concrete grid needs to be built differently.
 
 ~GridBase ()=default
 

Additional Inherited Members

- Protected Attributes inherited from GridBase< T >
bool can_contain_nullptrs {false}
 
int grid_size {-1}
 
std::shared_ptr< ShapeBase< T > > m_poly_mesh {}
 
SimulationClassBase< T > * sim {}
 
std::vector< std::unique_ptr< GenericElement< T > > > all_cells {}
 

Detailed Description

template<typename T>
class GridOneDim< T >

Concrete implementation of a 1D grid on each facet of a 3D shape model (hereafter: pseudo 3D).

Constructor & Destructor Documentation

◆ GridOneDim()

template<typename T >
GridOneDim< T >::GridOneDim ( SimulationClassBase< T > *  sim_ptr,
std::shared_ptr< ShapeBase< T > >  mesh_ptr 
)

Constructor for a OneDimGrid object.

Parameters
sim_ptrPointer to the sim class.

◆ ~GridOneDim()

template<typename T >
GridOneDim< T >::~GridOneDim ( )
default

Member Function Documentation

◆ calculateCellLength()

template<typename T >
T GridOneDim< T >::calculateCellLength ( )

◆ createGrid()

template<typename T >
void GridOneDim< T >::createGrid ( )
overridevirtual

Creation function for a pseudo 3D grid, assuming a shape model is given. True 1D geometries can be constructed by passing a one facet "shape model". Creates a number of cells specified by the number of facets times the number of numerical layers-1 (corresponding to the number of nodes). The shift by 1 is due to the 1D grids having a number of nodes that is equal to the number of cells + 1.

Implements GridBase< T >.


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