precice::query Namespace Reference

contains geometrical queries. More...

Namespaces
namespace	impl

Classes
struct	MeshIndices
struct	MatchType
	Struct to hold the index of a primitive match. More...
struct	ProjectionMatch
	Struct representing a projection match. More...
class	Index
	Class to query the index trees of the mesh. More...

Typedefs
using	RTreeBox = boost::geometry::model::box<pm::Vertex::RawCoords>
	The RTree box type.
using	VertexTraits = impl::RTreeTraits<mesh::Vertex>
using	EdgeTraits = impl::RTreeTraits<mesh::Edge>
using	TriangleTraits = impl::RTreeTraits<mesh::Triangle>
using	TetrahedronTraits = impl::RTreeTraits<mesh::Tetrahedron>
using	MatchID = int
	Type used for the IDs of matching entities.
using	Distance = double
	Type used for the distance of a match to the queried point.
using	GenericMatch = MatchType<struct GenericMatchTag>
	Match tags for each primitive type.
using	VertexMatch = MatchType<struct VertexMatchTag>
using	EdgeMatch = MatchType<struct EdgeMatchTag>
using	TriangleMatch = MatchType<struct TriangleTag>
using	TetraMatch = MatchType<struct TetraTag>

Functions
RTreeBox	makeBox (const pm::Vertex::RawCoords &min, const pm::Vertex::RawCoords &max)
pm::Vertex::RawCoords	eigenToRaw (const Eigen::VectorXd &v)
Eigen::VectorXd	rawToEigen (const pm::Vertex::RawCoords &v)
RTreeBox	makeBox (const Eigen::VectorXd &min, const Eigen::VectorXd &max)
RTreeBox	makeBox (const precice::mesh::Tetrahedron &tetra)

Variables
constexpr MatchID	NO_MATCH {-1}
constexpr double	INVALID_DISTANCE {-1}

Detailed Description

contains geometrical queries.

Typedef Documentation

Distance

using precice::query::Distance = double

Type used for the distance of a match to the queried point.

Definition at line 24 of file Index.hpp.

EdgeMatch

using precice::query::EdgeMatch = MatchType<struct EdgeMatchTag>

Definition at line 39 of file Index.hpp.

EdgeTraits

using precice::query::EdgeTraits = impl::RTreeTraits<mesh::Edge>

Definition at line 21 of file Index.cpp.

GenericMatch

using precice::query::GenericMatch = MatchType<struct GenericMatchTag>

Match tags for each primitive type.

Definition at line 37 of file Index.hpp.

MatchID

using precice::query::MatchID = int

Type used for the IDs of matching entities.

Definition at line 19 of file Index.hpp.

RTreeBox

using precice::query::RTreeBox = boost::geometry::model::box<pm::Vertex::RawCoords>

The RTree box type.

Definition at line 184 of file RTreeAdapter.hpp.

TetrahedronTraits

using precice::query::TetrahedronTraits = impl::RTreeTraits<mesh::Tetrahedron>

Definition at line 23 of file Index.cpp.

TetraMatch

using precice::query::TetraMatch = MatchType<struct TetraTag>

Definition at line 41 of file Index.hpp.

TriangleMatch

using precice::query::TriangleMatch = MatchType<struct TriangleTag>

Definition at line 40 of file Index.hpp.

TriangleTraits

using precice::query::TriangleTraits = impl::RTreeTraits<mesh::Triangle>

Definition at line 22 of file Index.cpp.

VertexMatch

using precice::query::VertexMatch = MatchType<struct VertexMatchTag>

Definition at line 38 of file Index.hpp.

VertexTraits

using precice::query::VertexTraits = impl::RTreeTraits<mesh::Vertex>

Definition at line 20 of file Index.cpp.

Function Documentation

eigenToRaw()

pm::Vertex::RawCoords precice::query::eigenToRaw ( const Eigen::VectorXd & v )

inline

Definition at line 191 of file RTreeAdapter.hpp.

makeBox() [1/3]

RTreeBox precice::query::makeBox ( const Eigen::VectorXd & min, const Eigen::VectorXd & max )

inline

Definition at line 207 of file RTreeAdapter.hpp.

Here is the call graph for this function:

makeBox() [2/3]

RTreeBox precice::query::makeBox ( const pm::Vertex::RawCoords & min, const pm::Vertex::RawCoords & max )

inline

Definition at line 186 of file RTreeAdapter.hpp.

makeBox() [3/3]

RTreeBox precice::query::makeBox ( const precice::mesh::Tetrahedron & tetra )

inline

Definition at line 213 of file RTreeAdapter.hpp.

Here is the call graph for this function:

rawToEigen()

Eigen::VectorXd precice::query::rawToEigen ( const pm::Vertex::RawCoords & v )

inline

Definition at line 200 of file RTreeAdapter.hpp.

Variable Documentation

INVALID_DISTANCE

double precice::query::INVALID_DISTANCE {-1}

constexpr

Definition at line 25 of file Index.hpp.

NO_MATCH

MatchID precice::query::NO_MATCH {-1}

constexpr

Definition at line 21 of file Index.hpp.