Namespaces
	detail

Classes
class	DynamicGrayBlockData
	Verbose BlockDataType for an InOutOctree. More...

class	InOutBlockData
	Compact BlockDataType for an InOutOctree. More...

class	InOutOctree

class	PointInCell
	A class to accelerate Point-In-Cell queries on a computational mesh. More...

class	PointInCellTraits
	A traits class for the mesh associated with a PointInCell query. More...

class	PSTLReader

class	SignedDistance

class	STLReader
	A simple reader for an STL file encoded in the ascii or binary format. More...

Enumerations
enum	SearchStatus { NEIGHBOR_NOT_FOUND = -1 }

enum	WatertightStatus : signed char { WatertightStatus::WATERTIGHT = 0, WatertightStatus::NOT_WATERTIGHT, WatertightStatus::CHECK_FAILED }

Functions
std::ostream &	operator<< (std::ostream &os, const InOutBlockData &iob)

std::ostream &	operator<< (std::ostream &os, const DynamicGrayBlockData &bData)

detail::Triangle3	getMeshTriangle (axom::IndexType i, detail::UMesh *surface_mesh)

Nearest Neighbor query
void	all_nearest_neighbors (const double x, const double y, const double z, const int region, int n, double limit, int neighbor, double sqdistance)
	Given a list of point locations and regions, for each point, find the closest point in a different region within a given search radius. More...

Mesh test and repair
void	findTriMeshIntersections (mint::UnstructuredMesh< mint::SINGLE_SHAPE > *surface_mesh, std::vector< std::pair< int, int >> &intersections, std::vector< int > &degenerateIndices, int spatialIndexResolution=0, double intersectionThreshold=1E-8)
	Find self-intersections and degenerate triangles in a surface mesh utilizing a Bounding Volume Hierarchy. More...

WatertightStatus	isSurfaceMeshWatertight (mint::UnstructuredMesh< mint::SINGLE_SHAPE > *surface_mesh)
	Check a surface mesh for holes using its face relation. More...

void	weldTriMeshVertices (mint::UnstructuredMesh< mint::SINGLE_SHAPE > **surface_mesh, double eps)
	Mesh repair function to weld vertices that are closer than eps. More...

InOut query -- initialization and finalization functions
int	inout_init (const std::string &file, MPI_Comm comm=MPI_COMM_SELF)
	Initializes the quest inout query from a mesh file. More...

int	inout_init (mint::Mesh *&mesh, MPI_Comm comm=MPI_COMM_SELF)
	Initialize the inout query using a pre-loaded mesh. More...

int	inout_finalize ()
	Finalizes the inout query. More...

bool	inout_initialized ()
	Predicate to test whether the inout query has been initialized. More...

InOut query -- properties and querying functions
Note These must be called after inout_init()
bool	inout_evaluate (double x, double y, double z=0.)
	Tests if the point (x, y, z) is inside the contained volume. More...

int	inout_evaluate (const double x, const double y, const double z, int npoints, int res)
	Tests an array of points for containment. More...

int	inout_mesh_min_bounds (double *coords)
	Returns the lower coordinates of the mesh's bounding box. More...

int	inout_mesh_max_bounds (double *coords)
	Returns the upper coordinates of the mesh's bounding box. More...

int	inout_mesh_center_of_mass (double *coords)
	Returns the center of mass of the mesh. More...

int	inout_get_dimension ()
	Gets the spatial dimension of the query. More...

InOut query -- setup options and parameters
Note These must be called before inout_init()
int	inout_set_verbose (bool verbosity)
	Enables/disables verbose logging output. More...

int	inout_set_vertex_weld_threshold (double thresh)
	Sets the cutoff distance for welding vertices during initialization. More...

Signed Distance Query Initialization Methods
int	signed_distance_init (const std::string &file, MPI_Comm comm=MPI_COMM_SELF)
	Initializes the Signed Distance Query with a surface given in an STL formatted file. More...

int	signed_distance_init (const mint::Mesh *m, MPI_Comm comm=MPI_COMM_SELF)
	Initializes the Signed Distance Query with the given surface mesh. More...

bool	signed_distance_initialized ()
	Checks if the Signed Distance Query has been initialized. More...

Signed Distance Query Options
void	signed_distance_set_dimension (int dim)
	Sets the dimension for the Signed Distance Query. More...

void	signed_distance_set_closed_surface (bool status)
	Indicates whether the input to the signed distance consists of a water-tight surface mesh, or not. More...

void	signed_distance_set_compute_signs (bool computeSign)
	Sets whether the distance query should compute or ignore the sign. More...

void	signed_distance_set_max_levels (int maxLevels)
	Sets the maximum levels of subdivision for the BVH decomposition. More...

void	signed_distance_set_max_occupancy (int threshold)
	Sets threshold on the max number of items per BVH bin. This option controls the BVH decomposition. More...

void	signed_distance_set_verbose (bool status)
	Enables/Disables verbose output for the Signed Distance Query. More...

void	signed_distance_use_shared_memory (bool status)
	Enable/Disable the use of MPI-3 on-node shared memory for storing the surface mesh. By default this option is disabled. More...

Signed Distance Query Evaluation Methods
double	signed_distance_evaluate (double x, double y, double z=0.0)
	Evaluates the signed distance function at the given point. More...

void	signed_distance_evaluate (const double x, const double y, const double z, int npoints, double phi)
	Evaluates the signed distance function at the given set of points. More...

void	signed_distance_get_mesh_bounds (double lo, double hi)
	Computes the bounds of the specified input mesh supplied to the Signed Distance Query. More...

Signed Distance Query Finalization Methods
void	signed_distance_finalize ()
	Finalizes the SignedDistance query. More...

Variables
constexpr int	QUEST_INOUT_SUCCESS = 0

constexpr int	QUEST_INOUT_FAILED = -1

Enumeration Type Documentation

◆ SearchStatus

enum axom::quest::SearchStatus

Enumerator
NEIGHBOR_NOT_FOUND

◆ WatertightStatus

enum axom::quest::WatertightStatus : signed char

strong

Enumeration indicating mesh watertightness

Enumerator
WATERTIGHT	Each edge in a surface mesh is incident in two cells.
NOT_WATERTIGHT	Each edge is incident in one or two cells.
CHECK_FAILED	Calculation failed (possibly a non-manifold mesh)

Function Documentation

◆ all_nearest_neighbors()

void axom::quest::all_nearest_neighbors	(	const double *	x,
		const double *	y,
		const double *	z,
		const int *	region,
		int	n,
		double	limit,
		int *	neighbor,
		double *	sqdistance
	)

Given a list of point locations and regions, for each point, find the closest point in a different region within a given search radius.

Parameters

[in]	x	X-coordinates of input points
[in]	y	Y-coordinates of input points
[in]	z	Z-coordinates of input points
[in]	region	Region of each point
[in]	n	Number of points
[in]	limit	Max distance for all-nearest-neighbors query
[out]	neighbor	Index of nearest neighbor not in the same class (or NEIGHBOR_NOT_FOUND)
[out]	sqdistance	Squared distance to nearest neighbor

Precondition: x, y, z, and region have n entries; neighbor is allocated with room for n entries

This method inserts all points p at (x[i], y[i], z[i]) into a UniformGrid index. Then for each point p, it gets the UniformGrid bins that overlap the box (p - (limit, limit, limit), p + (limit, limit, limit). The method compares p to each point in this list of bins and returns the index of the closest point.

We expect the use of the UniformGrid will result in a substantial time savings over a brute-force all-to-all algorithm, but the query's run time is dependent on the point distribution.

◆ operator<<() [1/2]

std::ostream& axom::quest::operator<<	(	std::ostream &	os,
		const InOutBlockData &	iob
	)

inline

Free function to print an InOutBlockData to an output stream

Parameters

os	The output stream to write to
iob	The InOUtBlockData instance that we are writing

References axom::quest::InOutBlockData::Black, axom::quest::InOutBlockData::color(), axom::quest::InOutBlockData::dataIndex(), axom::quest::InOutBlockData::Gray, axom::quest::InOutBlockData::hasData(), axom::quest::InOutBlockData::isLeaf(), and axom::quest::InOutBlockData::White.

◆ operator<<() [2/2]

std::ostream& axom::quest::operator<<	(	std::ostream &	os,
		const DynamicGrayBlockData &	bData
	)

inline

Free function to print a DynamicGrayBlockData instance to an output stream

References axom::quest::DynamicGrayBlockData::hasTriangles(), axom::quest::DynamicGrayBlockData::hasVertex(), axom::quest::DynamicGrayBlockData::isLeaf(), axom::quest::DynamicGrayBlockData::numTriangles(), axom::quest::DynamicGrayBlockData::triangles(), and axom::quest::DynamicGrayBlockData::vertexIndex().

◆ getMeshTriangle()

detail::Triangle3 axom::quest::getMeshTriangle	(	axom::IndexType	i,
		detail::UMesh *	surface_mesh
	)

inline

References AXOM_LAMBDA, AXOM_NOT_USED, AXOM_PERF_MARK_FUNCTION, AXOM_PERF_MARK_SECTION, axom::spin::BVH< NDIMS, ExecSpace, FloatType >::build(), axom::primal::compute_bounding_box(), axom::copy(), axom::deallocate(), axom::primal::Triangle< T, NDIMS >::degenerate(), axom::spin::BVH< NDIMS, ExecSpace, FloatType >::findBoundingBoxes(), findTriMeshIntersections(), axom::mint::UnstructuredMesh< TOPO >::getCellNodeIDs(), axom::numerics::Matrix< T >::getColumn(), axom::mint::UnstructuredMesh< TOPO >::getCoordinateArray(), axom::getDefaultAllocatorID(), axom::primal::BoundingBox< T, NDIMS >::getMax(), axom::primal::BoundingBox< T, NDIMS >::getMin(), axom::mint::UnstructuredMesh< TOPO >::getNumberOfCellNodes(), axom::mint::UnstructuredMesh< TOPO >::getNumberOfCells(), axom::primal::intersect(), isSurfaceMeshWatertight(), axom::setDefaultAllocator(), SLIC_ASSERT, SLIC_INFO, weldTriMeshVertices(), axom::mint::X_COORDINATE, axom::mint::Y_COORDINATE, axom::mint::Z_COORDINATE, and axom::internal::ZERO.

◆ findTriMeshIntersections()

void axom::quest::findTriMeshIntersections	(	mint::UnstructuredMesh< mint::SINGLE_SHAPE > *	surface_mesh,
		std::vector< std::pair< int, int >> &	intersections,
		std::vector< int > &	degenerateIndices,
		int	spatialIndexResolution = `0`,
		double	intersectionThreshold = `1E-8`
	)

Find self-intersections and degenerate triangles in a surface mesh utilizing a Bounding Volume Hierarchy.

Parameters

[in]	surface_mesh	A triangle mesh in three dimensions
[out]	intersection	Pairs of indices of intersecting mesh triangles
[out]	degenerateIndices	indices of degenerate mesh triangles
[in]	intersectionThreshold	Tolerance threshold for triangle intersection tests (default: 1E-8) After running this function over a surface mesh, intersection will be filled with pairs of indices of intersecting triangles and degenerateIndices will be filled with the indices of the degenerate triangles in the mesh. Triangles that share vertex pairs (adjacent triangles in a watertight surface mesh) are not reported as intersecting. Degenerate triangles are not reported as intersecting other triangles.

Find self-intersections and degenerate triangles in a surface mesh utilizing a Uniform Grid.

Parameters

[in]	surface_mesh	A triangle mesh in three dimensions
[out]	intersection	Pairs of indices of intersecting mesh triangles
[out]	degenerateIndices	indices of degenerate mesh triangles
[in]	spatialIndexResolution	The grid resolution for the index structure (default: 0)
[in]	intersectionThreshold	Tolerance threshold for triangle intersection tests (default: 1E-8)

After running this function over a surface mesh, intersection will be filled with pairs of indices of intersecting triangles and degenerateIndices will be filled with the indices of the degenerate triangles in the mesh. Triangles that share vertex pairs (adjacent triangles in a watertight surface mesh) are not reported as intersecting. Degenerate triangles are not reported as intersecting other triangles.

This function uses a quest::UniformGrid spatial index. Input spatialIndexResolution specifies the bin size for the UniformGrid. The default value of 0 causes this routine to calculate a heuristic bin size based on the cube root of the number of cells in the mesh.

Referenced by getMeshTriangle().

◆ isSurfaceMeshWatertight()

WatertightStatus axom::quest::isSurfaceMeshWatertight ( mint::UnstructuredMesh< mint::SINGLE_SHAPE > * surface_mesh )

Check a surface mesh for holes using its face relation.

Parameters

[in] surface_mesh A surface mesh in three dimensions

Returns: status If the mesh is watertight, is not watertight, or if an error occurred (possibly due to non-manifold mesh).

Note: This method marks the cells on the boundary by creating a new cell-centered field variable, called "boundary", on the given input mesh.; This function computes the mesh's cell-face and face-vertex relations. For large meshes, this can take a long time. The relations are used to check for holes, and remain cached with the mesh after this function finishes.

Referenced by getMeshTriangle().

◆ weldTriMeshVertices()

void axom::quest::weldTriMeshVertices	(	mint::UnstructuredMesh< mint::SINGLE_SHAPE > **	surface_mesh,
		double	eps
	)

Mesh repair function to weld vertices that are closer than eps.

Parameters

[in,out]	surface_mesh	A pointer to a pointer to a triangle mesh
[in]	eps	Distance threshold for welding vertices (using the max norm)

Precondition: eps must be greater than zero; surface_mesh is a pointer to a pointer to a non-null triangle mesh.

Postcondition: The triangles of surface_mesh are reindexed using the welded vertices and degenerate triangles are removed. The mesh can still contain vertices that are not referenced by any triangles.

This utility function repairs an input triangle mesh (embedded in three dimensional space) by 'welding' vertices that are closer than eps. The vertices are quantized to an integer lattice with spacing eps and vertices that fall into the same cell on this lattice are identified. All identified vertices are given the coordinates of the first such vertex and all incident triangles use the same index for this vertex.

The input mesh can be a "soup of triangles", where the vertices of adjacent triangles have distinct indices. After running this function, vertices that are closer than eps are welded, and their incident triangles use the new vertex indices. Thus, the output is an "indexed triangle mesh".

This function also removes degenerate triangles from the mesh. These are triangles without three distinct vertices after the welding.

Note: This function is destructive. It modifies the input triangle mesh in place.; The distance metric in this function uses the "max" norm (l_inf).

Referenced by getMeshTriangle().

◆ inout_init() [1/2]

int axom::quest::inout_init	(	const std::string &	file,
		MPI_Comm	comm = `MPI_COMM_SELF`
	)

Initializes the quest inout query from a mesh file.

Parameters

[in]	file	Path to an STL file containing the surface mesh
[in]	comm	The MPI communicator (when running in parallel)

Returns: Return code is QUEST_INOUT_SUCCESS if successful and QUEST_INOUT_FAILED otherwise.

Precondition: inout_initialized() == false

Postcondition: inout_initialized() == true, when rc is QUEST_INOUT_SUCCESS

◆ inout_init() [2/2]

int axom::quest::inout_init	(	mint::Mesh *&	mesh,
		MPI_Comm	comm = `MPI_COMM_SELF`
	)

Initialize the inout query using a pre-loaded mesh.

Parameters

[in,out]	mesh	Pointer to the input mesh. This pointer will be updated during this invocation
[in]	comm	The MPI communicator (when running in parallel)

Returns: Return code is QUEST_INOUT_SUCCESS if successful and QUEST_INOUT_FAILED otherwise.

Precondition: inout_initialized() == false

Postcondition: inout_initialized() == true, when rc is QUEST_INOUT_SUCCESS

Warning: The underlying data structure modifies the input mesh (e.g. by welding vertices) and updates the mesh pointer. It is the user's responsibility to update any other pointers to this same mesh.

◆ inout_finalize()

int axom::quest::inout_finalize ( )

Finalizes the inout query.

Postcondition: inout_initialized() == false

◆ inout_initialized()

bool axom::quest::inout_initialized ( )

Predicate to test whether the inout query has been initialized.

Returns: True if the inout query has been initialized, false otherwise.

◆ inout_evaluate() [1/2]

bool axom::quest::inout_evaluate	(	double	x,
		double	y,
		double	z = `0.`
	)

Tests if the point (x, y, z) is inside the contained volume.

Parameters

[in]	x	The x-coordinate of the query point
[in]	y	The y-coordinate of the query point
[in]	z	The z-coordinate of the query point

Returns: True if the point is within the contained volume or on the surface mesh, false otherwise.

Precondition: inout_initialized() == true

◆ inout_evaluate() [2/2]

int axom::quest::inout_evaluate	(	const double *	x,
		const double *	y,
		const double *	z,
		int	npoints,
		int *	res
	)

Tests an array of points for containment.

Upon successful completion, entries in array res will have the value 1 for points that are inside and value 0 otherwise.

Parameters

[in]	x	Array of x-coordinates for the query points
[in]	y	Array of y-coordinates for the query points
[in]	z	Array of z-coordinates for the query points
[in]	npoints	The number of points to test
[out]	res	An array of results. Each entry has value 1 if the corresponding point is inside or on the mesh and 0 otherwise.

Returns: Return code is QUEST_INOUT_SUCCESS when all preconditions are satisfied and QUEST_INOUT_FAILED otherwise.

Precondition: inout_initialized() == true; When npoints is greater than zero, arrays x, y, z and res are not nullptr and contain sufficient data/space for npoints points.

◆ inout_mesh_min_bounds()

int axom::quest::inout_mesh_min_bounds ( double * coords )

Returns the lower coordinates of the mesh's bounding box.

Parameters

[in] coords A buffer for the returned coordinates

Precondition: coords != nullptr and has sufficient storage for the coordinates; inout_initialized() == true

Returns: Return code is QUEST_INOUT_SUCCESS if successful and QUEST_INOUT_FAILED otherwise.

◆ inout_mesh_max_bounds()

int axom::quest::inout_mesh_max_bounds ( double * coords )

Returns the upper coordinates of the mesh's bounding box.

Parameters

[in] coords A buffer for the returned coordinates

Precondition: coords != nullptr and has sufficient storage for the coordinates; inout_initialized() == true

Returns: Return code is QUEST_INOUT_SUCCESS if successful and QUEST_INOUT_FAILED otherwise.

◆ inout_mesh_center_of_mass()

int axom::quest::inout_mesh_center_of_mass ( double * coords )

Returns the center of mass of the mesh.

The function computes a discrete center of mass defined by the average of the mesh coordinates rather than a continuous center of mass defined by the mesh faces.

Parameters

[in] coords A buffer for the returned coordinates

Precondition: coords != nullptr and has sufficient storage for the coordinates; inout_initialized() == true

Returns: Return code is QUEST_INOUT_SUCCESS if successful and QUEST_INOUT_FAILED otherwise.

◆ inout_get_dimension()

int axom::quest::inout_get_dimension ( )

Gets the spatial dimension of the query.

Returns: Returns the spatial dimension for query points when the query has been successfully initialized and QUEST_INOUT_FAILED otherwise.

Note: This determines the number of coordinates for query points in inout_evaluate() and the number of returned coordinates in functions like inout_mesh_min_bounds()

Precondition: inout_initialized() == true

◆ inout_set_verbose()

int axom::quest::inout_set_verbose ( bool verbosity )

Enables/disables verbose logging output.

By default, the logging verbosity is set to false.

Parameters

verbosity True for more verbose, false for less verbose

Returns: Return code is QUEST_INOUT_SUCCESS if successful and QUEST_INOUT_FAILED otherwise.

Precondition: inout_initialized() == false

◆ inout_set_vertex_weld_threshold()

int axom::quest::inout_set_vertex_weld_threshold ( double thresh )

Sets the cutoff distance for welding vertices during initialization.

By default, the welding threshold is 1E-9.

The inout query requires the input surface to be watertight so this parameter should be set with care. A welding threshold that is too high could unnecessarily merge vertices and create topological defects, while a value that is too low risks leaving gaps in meshes with tolerances between vertices. The default value tends to work well in practice.

Parameters

thresh Cutoff distance for welding vertices

Returns: Return code is QUEST_INOUT_SUCCESS if successful and QUEST_INOUT_FAILED otherwise.

Precondition: inout_initialized() == false; thresh >= 0

◆ signed_distance_init() [1/2]

int axom::quest::signed_distance_init	(	const std::string &	file,
		MPI_Comm	comm = `MPI_COMM_SELF`
	)

Initializes the Signed Distance Query with a surface given in an STL formatted file.

Parameters

[in]	file	the name of the file consisting of the surface mesh.
[in]	comm	the MPI communicator (applicable when MPI is available)

Returns: status zero on success, or a non-zero value if an error occurs

Note: The Signed Distance Query currently only supports reading in meshes defined in STL file format.

Precondition: file.empty() == false; comm != MPI_COMM_NULL (when MPI is available); signed_distance_initialized() == false

Postcondition: signed_distance_initialized() == true

◆ signed_distance_init() [2/2]

int axom::quest::signed_distance_init	(	const mint::Mesh *	m,
		MPI_Comm	comm = `MPI_COMM_SELF`
	)

Initializes the Signed Distance Query with the given surface mesh.

Parameters

[in]	m	pointer to the surface mesh object
[in]	comm	the MPI communicator (applicable whem MPI is available)

Returns: status zero on success, or a non-zero value if an error occurs.

Note: The Signed Distance Query currently only supports 3-D triangular surface meshes.

Precondition: m != nullptr; comm != MPI_COMM_NULL (when MPI is available); signed_distance_initialized() == false

Postcondition: signed_distance_initialized() == true

See also: mint::Mesh

◆ signed_distance_initialized()

bool axom::quest::signed_distance_initialized ( )

Checks if the Signed Distance Query has been initialized.

Returns: status true if initialized, else, false.

◆ signed_distance_set_dimension()

void axom::quest::signed_distance_set_dimension ( int dim )

Sets the dimension for the Signed Distance Query.

Parameters

[in] dim the dimension, e.g., 2 or 3

Warning: The Signed Distance function is currently supported in 3D

Note: Options must be set before initializing the Signed Distance Query.

◆ signed_distance_set_closed_surface()

void axom::quest::signed_distance_set_closed_surface ( bool status )

Indicates whether the input to the signed distance consists of a water-tight surface mesh, or not.

Parameters

[in] status flag indicating whether the input is water-tight

Note: By default the input type is assumed to be a water-tight surface mesh.; Options must be set before initializing the Signed Distance Query.; When the input is not a closed surface mesh, the assumption is that the surface mesh divides the computational mesh domain into two regions. Hence, the surface mesh has to span the entire domain of interest, e.g., the computational mesh at which the signed distance field is evaluated, along some plane.

Warning: The sign of the distance from a given query point is determined by a pseudo-normal which is computed at the closest point on the surface mesh. For a non-watertight mesh, the sign of the distance is not defined everywhere. Specifically, the sign is ambiguous for all points for which a normal projection onto the surface does not exist.

◆ signed_distance_set_compute_signs()

void axom::quest::signed_distance_set_compute_signs ( bool computeSign )

Sets whether the distance query should compute or ignore the sign.

Parameters

[in] computeSign predicate indicating if sign should be computed

Note: Options must be set before initializing the Signed Distance Query.

◆ signed_distance_set_max_levels()

void axom::quest::signed_distance_set_max_levels ( int maxLevels )

Sets the maximum levels of subdivision for the BVH decomposition.

Parameters

[in] maxLevels the maximum levels of subdivision.

Note: Options must be set before initializing the Signed Distance Query.

◆ signed_distance_set_max_occupancy()

void axom::quest::signed_distance_set_max_occupancy ( int threshold )

Sets threshold on the max number of items per BVH bin. This option controls the BVH decomposition.

Parameters

[in] threshold max number of items per bin.

Note: Options must be set before initializing the Signed Distance Query.

Precondition: theshold >= 1

◆ signed_distance_set_verbose()

void axom::quest::signed_distance_set_verbose ( bool status )

Enables/Disables verbose output for the Signed Distance Query.

Parameters

[in] status flag indicating whether to enable/disable verbose output

Note: Options must be set before initializing the Signed Distance Query.; Currently, this is only applicable when the Signed Distance Query initializes the SLIC logging environment.

◆ signed_distance_use_shared_memory()

void axom::quest::signed_distance_use_shared_memory ( bool status )

Enable/Disable the use of MPI-3 on-node shared memory for storing the surface mesh. By default this option is disabled.

Parameters

[in] status flag indicating whether to enable/disable shared memory.

Note: This option utilities MPI-3 features

◆ signed_distance_evaluate() [1/2]

double axom::quest::signed_distance_evaluate	(	double	x,
		double	y,
		double	z = `0.0`
	)

Evaluates the signed distance function at the given point.

Parameters

[in]	x	the x-coordinate of the point in query
[in]	y	the y-coordinate of the point in query
[in]	z	the z-coordinate of the point in query

Returns: d the signed distance evaluated at the specified point.

◆ signed_distance_evaluate() [2/2]

void axom::quest::signed_distance_evaluate	(	const double *	x,
		const double *	y,
		const double *	z,
		int	npoints,
		double *	phi
	)

Evaluates the signed distance function at the given set of points.

Parameters

[in]	x	array consisting of the x-coordinates for each query point
[in]	y	array consisting of the y-coordinates for each query point
[in]	z	array consisting of the z-coordinates for each query point
[in]	npoints	the number of query point
[out]	phi	output array storing the signed distance of each point

Precondition: x != nullptr; y != nullptr; z != nullptr; phi != nullptr

◆ signed_distance_get_mesh_bounds()

void axom::quest::signed_distance_get_mesh_bounds	(	double *	lo,
		double *	hi
	)

Computes the bounds of the specified input mesh supplied to the Signed Distance Query.

Parameters

[out]	lo	buffer to store the lower bound mesh coordinates.
[out]	hi	buffer to store the upper bound mesh coordinates.

Precondition: lo != nullptr; hi != nullptr; hi & lo must point to a buffer that is at least ndims long.; signed_distance_initialized() == true

◆ signed_distance_finalize()

void axom::quest::signed_distance_finalize ( )

Finalizes the SignedDistance query.

Postcondition: signed_distance_initialized() == false.

Variable Documentation

◆ QUEST_INOUT_SUCCESS

constexpr int axom::quest::QUEST_INOUT_SUCCESS = 0

◆ QUEST_INOUT_FAILED

constexpr int axom::quest::QUEST_INOUT_FAILED = -1

Namespaces

Classes

Enumerations

Functions

Variables

Enumeration Type Documentation

◆ SearchStatus

◆ WatertightStatus

Function Documentation

◆ all_nearest_neighbors()

◆ operator<<() [1/2]

◆ operator<<() [2/2]

◆ getMeshTriangle()

◆ findTriMeshIntersections()

◆ isSurfaceMeshWatertight()

◆ weldTriMeshVertices()

◆ inout_init() [1/2]

◆ inout_init() [2/2]

◆ inout_finalize()

◆ inout_initialized()

◆ inout_evaluate() [1/2]

◆ inout_evaluate() [2/2]

◆ inout_mesh_min_bounds()

◆ inout_mesh_max_bounds()

◆ inout_mesh_center_of_mass()

◆ inout_get_dimension()

◆ inout_set_verbose()

◆ inout_set_vertex_weld_threshold()

◆ signed_distance_init() [1/2]

◆ signed_distance_init() [2/2]

◆ signed_distance_initialized()

◆ signed_distance_set_dimension()

◆ signed_distance_set_closed_surface()

◆ signed_distance_set_compute_signs()

◆ signed_distance_set_max_levels()

◆ signed_distance_set_max_occupancy()

◆ signed_distance_set_verbose()

◆ signed_distance_use_shared_memory()

◆ signed_distance_evaluate() [1/2]

◆ signed_distance_evaluate() [2/2]

◆ signed_distance_get_mesh_bounds()

◆ signed_distance_finalize()

Variable Documentation

◆ QUEST_INOUT_SUCCESS

◆ QUEST_INOUT_FAILED