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

Create a point mesh representation of the input mesh using zone centers as the coordinates in a new coordset. More...

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

Public Member Functions

 MakePointMesh (const TopologyView &topologyView, 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_topology, const conduit::Node &n_coordset, const conduit::Node &n_options, conduit::Node &n_output) const
 Create a new field from the input topology and place it in n_output. More...
 
void execute (axom::ArrayView< axom::IndexType > selectedZonesView, const conduit::Node &n_topology, const conduit::Node &n_coordset, const conduit::Node &n_options, conduit::Node &n_output) const
 Create a new point mesh using a subset of the input mesh zones. More...
 

Detailed Description

template<typename ExecSpace, typename TopologyView, typename CoordsetView>
struct axom::bump::MakePointMesh< ExecSpace, TopologyView, CoordsetView >

Create a point mesh representation of the input mesh using zone centers as the coordinates in a new coordset.

Constructor & Destructor Documentation

◆ MakePointMesh()

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

Constructor.

Parameters
topologyViewThe topology view that describes the input topology.
coordsetViewThe coordset view that describes the input coordset.

Member Function Documentation

◆ setAllocatorID()

template<typename ExecSpace , typename TopologyView , typename CoordsetView >
void axom::bump::MakePointMesh< 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::MakePointMesh< 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() [1/2]

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

Create a new field from the input topology and place it in n_output.

Parameters
n_topologyThe node that contains the input topology.
n_coordsetThe input coordset that we're blending.
[out]n_outputFieldThe output node that will contain the new zone centers field.
Note
The coordset view must agree with the coordset in n_coordset. We pass both a view and the coordset node since the view may not be able to contain some coordset metadata and remain trivially copyable.

References AXOM_LAMBDA, axom::bump::MakePointMesh< ExecSpace, TopologyView, CoordsetView >::getAllocatorID(), and axom::Array< T, DIM, SPACE, StoragePolicy >::view().

◆ execute() [2/2]

template<typename ExecSpace , typename TopologyView , typename CoordsetView >
void axom::bump::MakePointMesh< ExecSpace, TopologyView, CoordsetView >::execute ( axom::ArrayView< axom::IndexType selectedZonesView,
const conduit::Node &  n_topology,
const conduit::Node &  n_coordset,
const conduit::Node &  n_options,
conduit::Node &  n_output 
) const
inline

Create a new point mesh using a subset of the input mesh zones.

Parameters
selectedZonesViewA view that contains the selected zone ids.
n_topologyA node that contains the input topology.
n_coordsetA node that contains the input coordset.
n_optionsA node that contains options.
[out]n_outputA node that will contain the new point mesh.

References AXOM_ANNOTATE_BEGIN, AXOM_ANNOTATE_END, AXOM_ANNOTATE_SCOPE, AXOM_LAMBDA, axom::sidre::ConduitMemory::axomAllocIdToConduit(), axom::bump::Options::coordsetName(), axom::bump::MakeZoneCenters< ExecSpace, TopologyView, CoordsetView >::execute(), axom::bump::MakePointMesh< ExecSpace, TopologyView, CoordsetView >::getAllocatorID(), axom::bump::MakeZoneCenters< ExecSpace, TopologyView, CoordsetView >::setAllocatorID(), axom::ArrayView< T, DIM, SPACE >::size(), and axom::bump::Options::topologyName().


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