Kratos::DistributedSearchInformation Struct Reference

This struct provides information related with distributed search. More...

#include <search_utilities.h>

Collaboration diagram for Kratos::DistributedSearchInformation:

Public Types
using	IndexType = std::size_t
	Alias for the data type used to represent indices. More...
using	SizeType = std::size_t
	Alias for the data type used to represent sizes. More...

Public Member Functions
void	Reserve (const SizeType Size)
	Vector of vectors to store ranks. More...
void	Shrink ()
	Shrink the capacity of the point data vectors to fit the data. More...
void	Clear ()
	Clear all the data in the point data vectors. More...

Public Attributes
std::vector< double >	PointCoordinates
std::vector< IndexType >	Indexes
	Vector to store point coordinates. More...
std::vector< int >	SearchRanks
	Vector to store point indices. More...
std::vector< std::vector< int > >	Ranks
	Ranks where search is invoked. More...

Detailed Description

This struct provides information related with distributed search.

The class contains the following:

• PointCoordinates: The coordinates of the points to be created
• Indexes: The indexes of the points to be created
• Ranks: The ranks where the results will be defined

Member Typedef Documentation

IndexType

using Kratos::DistributedSearchInformation::IndexType = std::size_t

Alias for the data type used to represent indices.

SizeType

using Kratos::DistributedSearchInformation::SizeType = std::size_t

Alias for the data type used to represent sizes.

Member Function Documentation

Clear()

void Kratos::DistributedSearchInformation::Clear ( )

inline

Clear all the data in the point data vectors.

Reserve()

void Kratos::DistributedSearchInformation::Reserve ( const SizeType  Size )

inline

Vector of vectors to store ranks.

Reserve memory for the point data vectors.

Parameters

Size	The size to reserve.

Shrink()

void Kratos::DistributedSearchInformation::Shrink ( )

inline

Shrink the capacity of the point data vectors to fit the data.

Member Data Documentation

Indexes

std::vector<IndexType> Kratos::DistributedSearchInformation::Indexes

Vector to store point coordinates.

PointCoordinates

std::vector<double> Kratos::DistributedSearchInformation::PointCoordinates

Ranks

std::vector<std::vector<int> > Kratos::DistributedSearchInformation::Ranks

Ranks where search is invoked.

SearchRanks

std::vector<int> Kratos::DistributedSearchInformation::SearchRanks

Vector to store point indices.

---

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

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