KratosMultiphysics: Kratos::SpatialSearchResult< TObjectType > Class Template Reference

KratosMultiphysics

KRATOS Multiphysics (Kratos) is a framework for building parallel, multi-disciplinary simulation software, aiming at modularity, extensibility, and high performance. Kratos is written in C++, and counts with an extensive Python interface.

This class is the result of the spatial searches. More...

#include <spatial_search_result.h>

Collaboration diagram for Kratos::SpatialSearchResult< TObjectType >:

Public Member Functions
Life Cycle
	SpatialSearchResult ()
	Default constructor. More...

	SpatialSearchResult (TObjectType *pObject, const int Rank=0)
	Constructor with the resulted object. More...

	SpatialSearchResult (SpatialSearchResult const &)=default
	Copy constructor. More...

	SpatialSearchResult (SpatialSearchResult &&)=default
	Move constructor. More...

virtual	~SpatialSearchResult ()
	Destructor. More...

Operators
SpatialSearchResult &	operator= (SpatialSearchResult const &)=default
	Assignment operator. More...

Operations
void	Reset ()
	Reset the result. More...

Access
TPointerType	Get ()
	Returns the global pointer to the object. More...

TPointerType const	Get () const
	Returns a const global pointer to the object. More...

void	Set (TObjectType *pObject)
	Set the object to be pointed. More...

double	GetDistance () const
	Getting the result distance. More...

void	SetDistance (const double TheDistance)
	Setting the result distance. More...

bool	GetIsObjectFound () const
	Getting if the object is found. More...

void	SetIsObjectFound (const bool IsObjectFound)
	Getting if the object is found. More...

bool	GetIsDistanceCalculated () const
	Getting if the distance is calculated. More...

void	SetIsDistanceCalculated (const bool IsDistanceCalculated)
	Setting if the distance is calculated. More...

Inquiry
bool	IsObjectFound () const
	Returns true if the object is set. More...

bool	IsDistanceCalculated () const
	Returns true if the distance is set. More...

Input and output
virtual std::string	Info () const
	Turn back information as a string. More...

virtual void	PrintInfo (std::ostream &rOStream) const
	Print information about this object. More...

virtual void	PrintData (std::ostream &rOStream) const
	Print object's data. More...

Type Definitions
using	TPointerType = GlobalPointer< TObjectType >
	Global pointer definition of TObjectType. More...

	KRATOS_CLASS_POINTER_DEFINITION (SpatialSearchResult)
	Pointer definition of SpatialSearchResult. More...

Serialization
class	Serializer

Detailed Description

template<typename TObjectType>
class Kratos::SpatialSearchResult< TObjectType >

This class is the result of the spatial searches.

It provides:

A global pointer to the object found.
Distance to the object if IsDistanceCalculated() is true
IsObjectFound if for example search nearest fails or not

Member Typedef Documentation

◆ TPointerType

template<typename TObjectType >

using Kratos::SpatialSearchResult< TObjectType >::TPointerType = GlobalPointer<TObjectType>

Global pointer definition of TObjectType.

Constructor & Destructor Documentation

◆ SpatialSearchResult() [1/4]

template<typename TObjectType >

Kratos::SpatialSearchResult< TObjectType >::SpatialSearchResult ( )

inline

Default constructor.

◆ SpatialSearchResult() [2/4]

template<typename TObjectType >

Kratos::SpatialSearchResult< TObjectType >::SpatialSearchResult	(	TObjectType *	pObject,
		const int	Rank = `0`
	)

inline

Constructor with the resulted object.

◆ SpatialSearchResult() [3/4]

template<typename TObjectType >

Kratos::SpatialSearchResult< TObjectType >::SpatialSearchResult ( SpatialSearchResult< TObjectType > const & )

default

Copy constructor.

◆ SpatialSearchResult() [4/4]

template<typename TObjectType >

Kratos::SpatialSearchResult< TObjectType >::SpatialSearchResult ( SpatialSearchResult< TObjectType > && )

default

Move constructor.

◆ ~SpatialSearchResult()

template<typename TObjectType >

virtual Kratos::SpatialSearchResult< TObjectType >::~SpatialSearchResult ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ Get() [1/2]

template<typename TObjectType >

TPointerType Kratos::SpatialSearchResult< TObjectType >::Get ( )

inline

Returns the global pointer to the object.

◆ Get() [2/2]

template<typename TObjectType >

TPointerType const Kratos::SpatialSearchResult< TObjectType >::Get ( ) const

inline

Returns a const global pointer to the object.

◆ GetDistance()

template<typename TObjectType >

double Kratos::SpatialSearchResult< TObjectType >::GetDistance ( ) const

inline

Getting the result distance.

◆ GetIsDistanceCalculated()

template<typename TObjectType >

bool Kratos::SpatialSearchResult< TObjectType >::GetIsDistanceCalculated ( ) const

inline

Getting if the distance is calculated.

◆ GetIsObjectFound()

template<typename TObjectType >

bool Kratos::SpatialSearchResult< TObjectType >::GetIsObjectFound ( ) const

inline

Getting if the object is found.

◆ Info()

template<typename TObjectType >

virtual std::string Kratos::SpatialSearchResult< TObjectType >::Info ( ) const

inlinevirtual

Turn back information as a string.

◆ IsDistanceCalculated()

template<typename TObjectType >

bool Kratos::SpatialSearchResult< TObjectType >::IsDistanceCalculated ( ) const

inline

Returns true if the distance is set.

◆ IsObjectFound()

template<typename TObjectType >

bool Kratos::SpatialSearchResult< TObjectType >::IsObjectFound ( ) const

inline

Returns true if the object is set.

◆ KRATOS_CLASS_POINTER_DEFINITION()

template<typename TObjectType >

Kratos::SpatialSearchResult< TObjectType >::KRATOS_CLASS_POINTER_DEFINITION ( SpatialSearchResult< TObjectType > )

Pointer definition of SpatialSearchResult.

◆ operator=()

template<typename TObjectType >

SpatialSearchResult& Kratos::SpatialSearchResult< TObjectType >::operator= ( SpatialSearchResult< TObjectType > const & )

default

Assignment operator.

◆ PrintData()

template<typename TObjectType >

virtual void Kratos::SpatialSearchResult< TObjectType >::PrintData ( std::ostream & rOStream ) const

inlinevirtual

Print object's data.

◆ PrintInfo()

template<typename TObjectType >

virtual void Kratos::SpatialSearchResult< TObjectType >::PrintInfo ( std::ostream & rOStream ) const

inlinevirtual

Print information about this object.

◆ Reset()

template<typename TObjectType >

void Kratos::SpatialSearchResult< TObjectType >::Reset ( )

inline

Reset the result.

◆ Set()

template<typename TObjectType >

void Kratos::SpatialSearchResult< TObjectType >::Set ( TObjectType * pObject )

inline

Set the object to be pointed.

◆ SetDistance()

template<typename TObjectType >

void Kratos::SpatialSearchResult< TObjectType >::SetDistance ( const double TheDistance )

inline

Setting the result distance.

◆ SetIsDistanceCalculated()

template<typename TObjectType >

void Kratos::SpatialSearchResult< TObjectType >::SetIsDistanceCalculated ( const bool IsDistanceCalculated )

inline

Setting if the distance is calculated.

◆ SetIsObjectFound()

template<typename TObjectType >

void Kratos::SpatialSearchResult< TObjectType >::SetIsObjectFound ( const bool IsObjectFound )

inline

Getting if the object is found.

Friends And Related Function Documentation

◆ Serializer

template<typename TObjectType >

friend class Serializer

friend

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

/home/runner/work/Documentation/Documentation/master/kratos/spatial_containers/spatial_search_result.h