MPI utilities for searching geometrical objects. More...

#include <search_utilities.h>

Collaboration diagram for Kratos::SearchUtilities:

Static Public Member Functions
Operations
template<class TPointType >
static bool	PointIsInsideBoundingBox (const BoundingBox< TPointType > &rBoundingBox, const array_1d< double, 3 > &rCoords)
	Check if a point is inside a bounding box. More...

static bool	PointIsInsideBoundingBox (const BoundingBoxType &rBoundingBox, const array_1d< double, 3 > &rCoords)
	Check if a point is inside a bounding box. More...

template<class TPointType >
static bool	PointIsInsideBoundingBox (const BoundingBox< TPointType > &rBoundingBox, const array_1d< double, 3 > &rCoords, const double Tolerance)
	This method checks if a point is inside a bounding box considering a certain tolerance. More...

static void	ComputeBoundingBoxesWithTolerance (const std::vector< double > &rBoundingBoxes, const double Tolerance, std::vector< double > &rBoundingBoxesWithTolerance)
	Compute the bounding boxes of the given bounding boxes from a given tolerance. More...

static void	ComputeBoundingBoxesWithToleranceCheckingNullBB (const std::vector< double > &rBoundingBoxes, const double Tolerance, std::vector< double > &rBoundingBoxesWithTolerance)
	Compute the bounding boxes of the given bounding boxes from a given tolerance, additionally checking if the bounding boxes are initialized. More...

template<typename TPointIteratorType >
static void	SynchronousPointSynchronization (TPointIteratorType itPointBegin, TPointIteratorType itPointEnd, std::vector< double > &rAllPointsCoordinates, std::vector< IndexType > &rAllPointsIds, const DataCommunicator &rDataCommunicator)
	SynchronousPointSynchronization prepares synchronously the coordinates of the points for MPI search. More...

template<typename TPointIteratorType , typename TBoundingBoxType >
static std::vector< IndexType >	SynchronousPointSynchronizationWithBoundingBox (TPointIteratorType itPointBegin, TPointIteratorType itPointEnd, DistributedSearchInformation &rSearchInfo, const TBoundingBoxType &rBoundingBox, const double ThresholdBoundingBox, const DataCommunicator &rDataCommunicator, const bool IndexItIsJustCounter=false)
	SynchronousPointSynchronization prepares synchronously the coordinates of the points for MPI search. More...

template<typename TPointIteratorType >
static std::vector< int >	SynchronousPointSynchronizationWithRecvSizes (TPointIteratorType itPointBegin, TPointIteratorType itPointEnd, std::vector< double > &rAllPointsCoordinates, std::vector< IndexType > &rAllPointsIds, const DataCommunicator &rDataCommunicator)
	SynchronousPointSynchronizationWithRecvSizes prepares synchronously the coordinates of the points for MPI search including the recv sizes. More...

template<typename TPointIteratorType >
static std::vector< double >	SynchronousPointSynchronizationWithRadius (TPointIteratorType itPointBegin, TPointIteratorType itPointEnd, std::vector< double > &rAllPointsCoordinates, std::vector< IndexType > &rAllPointsIds, const std::vector< double > &rRadius, const DataCommunicator &rDataCommunicator)
	SynchronousPointSynchronizationWithRadius prepares synchronously the coordinates of the points for MPI search including radius. More...

template<class TContainer , class TResultType >
static std::vector< typename PointObject< typename TContainer::value_type >::Pointer >	PrepareSearch (const TContainer &rStructure, const TContainer &rInput, TResultType &rResults, VectorDistanceType &rResultsDistance)
	This method prepares the search. More...

template<class TContainer , class TResultType >
static void	PrepareOutputSearch (const TContainer &rInput, TResultType &rResults, VectorDistanceType &rResultsDistance)
	This method prepares the search output. More...

template<class TContainer >
static std::vector< typename PointObject< typename TContainer::value_type >::Pointer >	PreparePointsSearch (const TContainer &rStructure)
	This method prepares the points for search. More...

template<class TContainer , class TSpatialContainer , class TResultType >
static void	ParallelSearch (const TContainer &rInput, const RadiusArrayType &rRadius, TSpatialContainer &rSearch, TResultType &rResults, VectorDistanceType &rResultsDistance, const int AllocationSize=1000)
	This method performs the search in parallel. More...

Type Definitions
using	BoundingBoxType = std::array< double, 6 >
	The Bounding Box type. More...

using	IndexType = long unsigned int
	The index type definition. More...

using	SizeType = std::size_t
	The size type definition. More...

using	RadiusArrayType = std::vector< double >
	Input/output types. More...

using	DistanceType = std::vector< double >

using	VectorDistanceType = std::vector< DistanceType >

static constexpr double	ZeroTolerance = std::numeric_limits<double>::epsilon()
	Define zero tolerance as Epsilon. More...

Detailed Description

MPI utilities for searching geometrical objects.

Some methods original implementation coming from MappingUtilities

Author: Philipp Bucher (MappingUtilities methods); Vicente Mataix Ferrandiz

Member Typedef Documentation

◆ BoundingBoxType

using Kratos::SearchUtilities::BoundingBoxType = std::array<double, 6>

The Bounding Box type.

◆ DistanceType

using Kratos::SearchUtilities::DistanceType = std::vector<double>

◆ IndexType

using Kratos::SearchUtilities::IndexType = long unsigned int

The index type definition.

◆ RadiusArrayType

using Kratos::SearchUtilities::RadiusArrayType = std::vector<double>

Input/output types.

◆ SizeType

using Kratos::SearchUtilities::SizeType = std::size_t

The size type definition.

◆ VectorDistanceType

using Kratos::SearchUtilities::VectorDistanceType = std::vector<DistanceType>

Member Function Documentation

◆ ComputeBoundingBoxesWithTolerance()

void Kratos::SearchUtilities::ComputeBoundingBoxesWithTolerance	(	const std::vector< double > &	rBoundingBoxes,
		const double	Tolerance,
		std::vector< double > &	rBoundingBoxesWithTolerance
	)

static

Compute the bounding boxes of the given bounding boxes from a given tolerance.

Parameters

rBoundingBoxes	The bounding boxes
Tolerance	The tolerance
rBoundingBoxesWithTolerance	The resulting bounding boxes with the applied tolerance

◆ ComputeBoundingBoxesWithToleranceCheckingNullBB()

void Kratos::SearchUtilities::ComputeBoundingBoxesWithToleranceCheckingNullBB	(	const std::vector< double > &	rBoundingBoxes,
		const double	Tolerance,
		std::vector< double > &	rBoundingBoxesWithTolerance
	)

static

Compute the bounding boxes of the given bounding boxes from a given tolerance, additionally checking if the bounding boxes are initialized.

This method is used when the bounding boxes are not initialized

Parameters

rBoundingBoxes	The bounding boxes
Tolerance	The tolerance
rBoundingBoxesWithTolerance	The resulting bounding boxes with the applied tolerance

◆ ParallelSearch()

template<class TContainer , class TSpatialContainer , class TResultType >

static void Kratos::SearchUtilities::ParallelSearch	(	const TContainer &	rInput,
		const RadiusArrayType &	rRadius,
		TSpatialContainer &	rSearch,
		TResultType &	rResults,
		VectorDistanceType &	rResultsDistance,
		const int	AllocationSize = `1000`
	)

inlinestatic

This method performs the search in parallel.

Parameters

rInput	The input container
rRadius	The radius array
rSearch	The spatial search
rResults	The results
rResultsDistance	The results distance
AllocationSize	The allocation size

Template Parameters

TContainer	The container type
TSpatialContainer	The spatial container type
TResultType	The result type

◆ PointIsInsideBoundingBox() [1/3]

template<class TPointType >

static bool Kratos::SearchUtilities::PointIsInsideBoundingBox	(	const BoundingBox< TPointType > &	rBoundingBox,
		const array_1d< double, 3 > &	rCoords
	)

inlinestatic

Check if a point is inside a bounding box.

Bounding box class implementation

Parameters

rBoundingBox	The bounding box
rCoords	The point

Returns: true if the point is inside the bounding box

Template Parameters

TPointType The type of point considered

◆ PointIsInsideBoundingBox() [2/3]

template<class TPointType >

static bool Kratos::SearchUtilities::PointIsInsideBoundingBox	(	const BoundingBox< TPointType > &	rBoundingBox,
		const array_1d< double, 3 > &	rCoords,
		const double	Tolerance
	)

inlinestatic

This method checks if a point is inside a bounding box considering a certain tolerance.

Parameters

rBoundingBox	The bounding box
rCoords	The coordinates of the point
Tolerance	The tolerance

Returns: True if the point is inside the bounding box

Template Parameters

TPointType The type of point considered

◆ PointIsInsideBoundingBox() [3/3]

static bool Kratos::SearchUtilities::PointIsInsideBoundingBox	(	const BoundingBoxType &	rBoundingBox,
		const array_1d< double, 3 > &	rCoords
	)

inlinestatic

Check if a point is inside a bounding box.

Bounding box array of 6 doubles implementation

Parameters

rBoundingBox	The bounding box
rCoords	The point

Returns: true if the point is inside the bounding box

◆ PrepareOutputSearch()

template<class TContainer , class TResultType >

static void Kratos::SearchUtilities::PrepareOutputSearch	(	const TContainer &	rInput,
		TResultType &	rResults,
		VectorDistanceType &	rResultsDistance
	)

inlinestatic

This method prepares the search output.

Parameters

rInput	The input to be searched
rResults	The results
rResultsDistance	The results distance

Template Parameters

TContainer	The container type
TResultType	The result type

◆ PreparePointsSearch()

template<class TContainer >

static std::vector<typename PointObject<typename TContainer::value_type>::Pointer> Kratos::SearchUtilities::PreparePointsSearch ( const TContainer & rStructure )

inlinestatic

This method prepares the points for search.

Parameters

rStructure The structure to be searched

Template Parameters

TContainer The container type

◆ PrepareSearch()

template<class TContainer , class TResultType >

static std::vector<typename PointObject<typename TContainer::value_type>::Pointer> Kratos::SearchUtilities::PrepareSearch	(	const TContainer &	rStructure,
		const TContainer &	rInput,
		TResultType &	rResults,
		VectorDistanceType &	rResultsDistance
	)

inlinestatic

This method prepares the search.

Parameters

rStructure	The structure to be searched
rInput	The input to be searched
rResults	The results
rResultsDistance	The results distance

Template Parameters

TContainer	The container type
TResultType	The result type

◆ SynchronousPointSynchronization()

template<typename TPointIteratorType >

static void Kratos::SearchUtilities::SynchronousPointSynchronization	(	TPointIteratorType	itPointBegin,
		TPointIteratorType	itPointEnd,
		std::vector< double > &	rAllPointsCoordinates,
		std::vector< IndexType > &	rAllPointsIds,
		const DataCommunicator &	rDataCommunicator
	)

inlinestatic

SynchronousPointSynchronization prepares synchronously the coordinates of the points for MPI search.

Parameters

itPointBegin	Iterator to the beginning of the points range
itPointEnd	Iterator to the end of the points range
rAllPointsCoordinates	vector where the computed coordinates will be stored
rAllPointsIds	The ids of all the points (just a counter for points, and ids for nodes)
rDataCommunicator	The data communicator

Template Parameters

TPointIteratorType The type of the point iterator

◆ SynchronousPointSynchronizationWithBoundingBox()

template<typename TPointIteratorType , typename TBoundingBoxType >

static std::vector<IndexType> Kratos::SearchUtilities::SynchronousPointSynchronizationWithBoundingBox	(	TPointIteratorType	itPointBegin,
		TPointIteratorType	itPointEnd,
		DistributedSearchInformation &	rSearchInfo,
		const TBoundingBoxType &	rBoundingBox,
		const double	ThresholdBoundingBox,
		const DataCommunicator &	rDataCommunicator,
		const bool	IndexItIsJustCounter = `false`
	)

inlinestatic

SynchronousPointSynchronization prepares synchronously the coordinates of the points for MPI search.

Parameters

itPointBegin	Iterator to the beginning of the points range.
itPointEnd	Iterator to the end of the points range.
rSearchInfo	The class containing the result of the search.
rBoundingBox	The bounding box considered.
ThresholdBoundingBox	The threshold for computing is inside bounding box considered.
rDataCommunicator	The data communicator.
IndexItIsJustCounter	If the index considered it it just a counter.

Template Parameters

TPointIteratorType	The type of the point iterator.
TBoundingBoxType	The type of the bounding box.

Returns: The ids of all points.

◆ SynchronousPointSynchronizationWithRadius()

template<typename TPointIteratorType >

static std::vector<double> Kratos::SearchUtilities::SynchronousPointSynchronizationWithRadius	(	TPointIteratorType	itPointBegin,
		TPointIteratorType	itPointEnd,
		std::vector< double > &	rAllPointsCoordinates,
		std::vector< IndexType > &	rAllPointsIds,
		const std::vector< double > &	rRadius,
		const DataCommunicator &	rDataCommunicator
	)

inlinestatic

SynchronousPointSynchronizationWithRadius prepares synchronously the coordinates of the points for MPI search including radius.

With radius

Parameters

itPointBegin	Iterator to the beginning of the points range
itPointEnd	Iterator to the end of the points range
rAllPointsCoordinates	vector where the computed coordinates will be stored
rAllPointsIds	The ids of all the points (just a counter for points, and ids for nodes)
rRadius	The radius of the points
rDataCommunicator	The data communicator

Returns: The resulting whole radius vector

Template Parameters

TPointIteratorType The type of the point iterator

◆ SynchronousPointSynchronizationWithRecvSizes()

template<typename TPointIteratorType >

static std::vector<int> Kratos::SearchUtilities::SynchronousPointSynchronizationWithRecvSizes	(	TPointIteratorType	itPointBegin,
		TPointIteratorType	itPointEnd,
		std::vector< double > &	rAllPointsCoordinates,
		std::vector< IndexType > &	rAllPointsIds,
		const DataCommunicator &	rDataCommunicator
	)

inlinestatic

SynchronousPointSynchronizationWithRecvSizes prepares synchronously the coordinates of the points for MPI search including the recv sizes.

With recv sizes

Parameters

itPointBegin	Iterator to the beginning of the points range
itPointEnd	Iterator to the end of the points range
rAllPointsCoordinates	vector where the computed coordinates will be stored
rAllPointsIds	The ids of all the points (just a counter for points, and ids for nodes)
rDataCommunicator	The data communicator

Returns: The resulting whole radius vector

Template Parameters

TPointIteratorType The type of the point iterator

Member Data Documentation

◆ ZeroTolerance

constexpr double Kratos::SearchUtilities::ZeroTolerance = std::numeric_limits<double>::epsilon()

staticconstexpr

Define zero tolerance as Epsilon.

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

/home/runner/work/Documentation/Documentation/master/kratos/utilities/search_utilities.h
/home/runner/work/Documentation/Documentation/master/kratos/utilities/search_utilities.cpp

Static Public Member Functions

Type Definitions

Detailed Description

Member Typedef Documentation

◆ BoundingBoxType

◆ DistanceType

◆ IndexType

◆ RadiusArrayType

◆ SizeType

◆ VectorDistanceType

Member Function Documentation

◆ ComputeBoundingBoxesWithTolerance()

◆ ComputeBoundingBoxesWithToleranceCheckingNullBB()

◆ ParallelSearch()

◆ PointIsInsideBoundingBox() [1/3]

◆ PointIsInsideBoundingBox() [2/3]

◆ PointIsInsideBoundingBox() [3/3]

◆ PrepareOutputSearch()

◆ PreparePointsSearch()

◆ PrepareSearch()

◆ SynchronousPointSynchronization()

◆ SynchronousPointSynchronizationWithBoundingBox()

◆ SynchronousPointSynchronizationWithRadius()

◆ SynchronousPointSynchronizationWithRecvSizes()

Member Data Documentation

◆ ZeroTolerance