AXOM
Axom provides a robust, flexible software infrastructure for the development of multi-physics applications and computational tools.
axom::bump::ExtrudeMesh< ExecSpace, TopologyView, CoordsetView > Class Template Reference

Extrude 2D Blueprint topologies that consist of tri/quad zones. More...

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/bump/ExtrudeMesh.hpp>

Public Member Functions

 ExtrudeMesh (const TopologyView &topoView, const CoordsetView &coordsetView)
 Constructor. More...
 
void setAllocatorID (int allocator_id)
 Set the allocator id to use when allocating memory. More...
 
int getAllocatorID () const
 Get the allocator id to use when allocating memory. More...
 
void execute (const conduit::Node &n_mesh, const conduit::Node &n_options, conduit::Node &n_output) const
 Execute the extrusion algorithm. More...
 

Detailed Description

template<typename ExecSpace, typename TopologyView, typename CoordsetView>
class axom::bump::ExtrudeMesh< ExecSpace, TopologyView, CoordsetView >

Extrude 2D Blueprint topologies that consist of tri/quad zones.

Template Parameters
ExecSpaceThe execution space where the algorithm will execute.
TopologyViewThe topology view that wraps the Blueprint topology.
CoordsetViewThe coordset view that wraps the Blueprint coordset.
Note
Future work: fields, making PH zones from polygons.

Constructor & Destructor Documentation

◆ ExtrudeMesh()

template<typename ExecSpace , typename TopologyView , typename CoordsetView >
axom::bump::ExtrudeMesh< ExecSpace, TopologyView, CoordsetView >::ExtrudeMesh ( const TopologyView &  topoView,
const CoordsetView &  coordsetView 
)
inline

Constructor.

Parameters
topoViewThe topology view.
coordsetViewThe coordset view.

Member Function Documentation

◆ setAllocatorID()

template<typename ExecSpace , typename TopologyView , typename CoordsetView >
void axom::bump::ExtrudeMesh< ExecSpace, TopologyView, CoordsetView >::setAllocatorID ( int  allocator_id)
inline

Set the allocator id to use when allocating memory.

Parameters
allocator_idThe allocator id to use when allocating memory.

References axom::isValidAllocatorID(), and SLIC_ERROR_IF.

◆ getAllocatorID()

template<typename ExecSpace , typename TopologyView , typename CoordsetView >
int axom::bump::ExtrudeMesh< ExecSpace, TopologyView, CoordsetView >::getAllocatorID ( ) const
inline

Get the allocator id to use when allocating memory.

Returns
The allocator id to use when allocating memory.

◆ execute()

template<typename ExecSpace , typename TopologyView , typename CoordsetView >
void axom::bump::ExtrudeMesh< ExecSpace, TopologyView, CoordsetView >::execute ( const conduit::Node &  n_mesh,
const conduit::Node &  n_options,
conduit::Node &  n_output 
) const
inline

Execute the extrusion algorithm.

Parameters
n_meshA Conduit node containing the mesh (coordset, topologies, matset, etc.)
n_optionsA Conduit node containing options that control the algorithm.
n_outputThe Conduit node that will contain the extruded mesh.
* Supported options:
*
* nz: 10
* z0: 0.
* z1: 1.
* topologyName: mesh
* outputTopologyName: newmesh
* outputCoordsetName: newcoordset
* outputMatsetName: newmatset
* 

References AXOM_ANNOTATE_BEGIN, AXOM_ANNOTATE_END, AXOM_ANNOTATE_SCOPE, AXOM_LAMBDA, axom::sidre::ConduitMemory::axomAllocIdToConduit(), axom::utilities::bitIsSet(), axom::serial::reductions::ReduceSum< ExecSpace, T >::get(), axom::serial::reductions::ReduceBitOr< ExecSpace, T >::get(), axom::bump::ExtrudeMesh< ExecSpace, TopologyView, CoordsetView >::getAllocatorID(), axom::bump::views::Hex_ShapeID, axom::utilities::popcount(), axom::bump::views::Quad_ShapeID, SLIC_ASSERT, SLIC_ERROR, SLIC_ERROR_IF, and axom::bump::views::Wedge_ShapeID.


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