AXOM
Axom provides a robust, flexible software infrastructure for the development of multi-physics applications and computational tools.
axom::quest::shaping::InOutSampler< NDIMS > Class Template Reference

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/v0.6.1/src/axom/quest/SamplingShaper.hpp>

Inheritance diagram for axom::quest::shaping::InOutSampler< NDIMS >:

Public Types

using InOutOctreeType = quest::InOutOctree< DIM >
 
using GeometricBoundingBox = typename InOutOctreeType::GeometricBoundingBox
 
using SpacePt = typename InOutOctreeType::SpacePt
 
using SpaceVector = typename InOutOctreeType::SpaceVector
 
using GridPt = typename InOutOctreeType::GridPt
 
using BlockIndex = typename InOutOctreeType::BlockIndex
 

Public Member Functions

 InOutSampler (const std::string &shapeName, mint::Mesh *surfaceMesh)
 Constructor for a SamplingShaper. More...
 
 ~InOutSampler ()
 
mint::MeshgetSurfaceMesh () const
 
void computeBounds ()
 Computes the bounding box of the surface mesh. More...
 
void initSpatialIndex (double vertexWeldThreshold)
 
void sampleInOutField (mfem::DataCollection *dc, shaping::QFunctionCollection &inoutQFuncs, int sampleRes)
 
void computeVolumeFractionsBaseline (mfem::DataCollection *dc, int AXOM_UNUSED_PARAM(sampleRes), int outputOrder)
 

Static Public Attributes

static constexpr int DIM = NDIMS
 

Member Typedef Documentation

◆ InOutOctreeType

◆ GeometricBoundingBox

◆ SpacePt

template<int NDIMS>
using axom::quest::shaping::InOutSampler< NDIMS >::SpacePt = typename InOutOctreeType::SpacePt

◆ SpaceVector

template<int NDIMS>
using axom::quest::shaping::InOutSampler< NDIMS >::SpaceVector = typename InOutOctreeType::SpaceVector

◆ GridPt

template<int NDIMS>
using axom::quest::shaping::InOutSampler< NDIMS >::GridPt = typename InOutOctreeType::GridPt

◆ BlockIndex

template<int NDIMS>
using axom::quest::shaping::InOutSampler< NDIMS >::BlockIndex = typename InOutOctreeType::BlockIndex

Constructor & Destructor Documentation

◆ InOutSampler()

template<int NDIMS>
axom::quest::shaping::InOutSampler< NDIMS >::InOutSampler ( const std::string &  shapeName,
mint::Mesh surfaceMesh 
)
inline

Constructor for a SamplingShaper.

Parameters
shapeNameThe name of the shape; will be used for the field for the associated samples
surfaceMeshPointer to the surface mesh
Note
Does not take ownership of the surface mesh

◆ ~InOutSampler()

template<int NDIMS>
axom::quest::shaping::InOutSampler< NDIMS >::~InOutSampler ( )
inline

Member Function Documentation

◆ getSurfaceMesh()

template<int NDIMS>
mint::Mesh* axom::quest::shaping::InOutSampler< NDIMS >::getSurfaceMesh ( ) const
inline

◆ computeBounds()

template<int NDIMS>
void axom::quest::shaping::InOutSampler< NDIMS >::computeBounds ( )
inline

Computes the bounding box of the surface mesh.

Referenced by axom::quest::SamplingShaper::prepareShapeQuery().

◆ initSpatialIndex()

template<int NDIMS>
void axom::quest::shaping::InOutSampler< NDIMS >::initSpatialIndex ( double  vertexWeldThreshold)
inline

◆ sampleInOutField()

template<int NDIMS>
void axom::quest::shaping::InOutSampler< NDIMS >::sampleInOutField ( mfem::DataCollection *  dc,
shaping::QFunctionCollection inoutQFuncs,
int  sampleRes 
)
inline

◆ computeVolumeFractionsBaseline()

template<int NDIMS>
void axom::quest::shaping::InOutSampler< NDIMS >::computeVolumeFractionsBaseline ( mfem::DataCollection *  dc,
int   AXOM_UNUSED_PARAMsampleRes,
int  outputOrder 
)
inline

Compute volume fractions function for shape on a grid of resolution gridRes in region defined by bounding box queryBounds

Member Data Documentation

◆ DIM

template<int NDIMS>
constexpr int axom::quest::shaping::InOutSampler< NDIMS >::DIM = NDIMS
static

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