Kratos::BinsObjectStatic< TConfigure > Class Template Reference

Short class definition. More...

#include <bins_static_objects.h>

Collaboration diagram for Kratos::BinsObjectStatic< TConfigure >:

Public Member Functions
Life Cycle
	BinsObjectStatic ()
	Default constructor. More...
	BinsObjectStatic (IteratorType const &ObjectsBegin, IteratorType const &ObjectsEnd)
	Constructor de bins a bounding box. More...
	BinsObjectStatic (IteratorType const &ObjectsBegin, IteratorType const &ObjectsEnd, const SizeType Nx, const SizeType Ny, const SizeType Nz)
virtual	~BinsObjectStatic ()
	Destructor. 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...
void	PrintSize (std::ostream &rout)
	Print Size of Container. More...
void	PrintBox (std::ostream &rout)
	Print Limits Points of the Container. More...
SizeArray &	GetDivisions ()
	Get the Divisions object. More...
CoordinateArray &	GetCellSize ()
	Get the Cell Size object. More...
PointType &	GetMinPoint ()
	Get the Min Point object. More...
PointType &	GetMaxPoint ()
	Get the Max Point object. More...
Protected Operators
void	CalculateBoundingBox ()
	Computa los boxes de cada uno de los elementos del model part. More...
void	CalculateCellSize (std::size_t ApproximatedSize)
	Calculates the cell size of the bins. More...
void	GenerateBins ()
void	CountObject (SearchStructure< IndexType, SizeType, CoordinateType, IteratorType, IteratorIteratorType, 1 > &Box, PointerType object)
void	CountObject (SearchStructure< IndexType, SizeType, CoordinateType, IteratorType, IteratorIteratorType, 2 > &Box, PointerType object)
void	CountObject (SearchStructure< IndexType, SizeType, CoordinateType, IteratorType, IteratorIteratorType, 3 > &Box, PointerType object)
SizeType	SearchObjects (PointerType &ThisObject, ResultIteratorType &Result, const SizeType &MaxNumberOfResults)
SizeType	SearchObjects (PointerType &ThisObject, ResultContainerType &Result)
void	SearchObjectRow (PointerType &ThisObject, LocalIteratorType RowBegin, LocalIteratorType RowEnd, ResultIteratorType &Result, SizeType &NumberOfResults, const SizeType &MaxNumberOfResults)
void	SearchInBoxLocal (PointerType &ThisObject, ResultIteratorType &Result, SizeType &NumberOfResults, const SizeType &MaxNumberOfResults, SearchStructure< IndexType, SizeType, CoordinateType, IteratorType, IteratorIteratorType, 1 > &Box)
void	SearchInBoxLocal (PointerType &ThisObject, ResultIteratorType &Result, SizeType &NumberOfResults, const SizeType &MaxNumberOfResults, SearchStructure< IndexType, SizeType, CoordinateType, IteratorType, IteratorIteratorType, 2 > &Box)
void	SearchInBoxLocal (PointerType &ThisObject, ResultIteratorType &Result, SizeType &NumberOfResults, const SizeType &MaxNumberOfResults, SearchStructure< IndexType, SizeType, CoordinateType, IteratorType, IteratorIteratorType, 3 > &Box)
void	SearchInBoxLocal_ (PointerType &ThisObject, ResultIteratorType &Result, SizeType &NumberOfResults, const SizeType &MaxNumberOfResults, SearchStructure< IndexType, SizeType, CoordinateType, IteratorType, IteratorIteratorType, 3 > &Box)
void	SearchObjectRow (PointerType &ThisObject, LocalIteratorType RowBegin, LocalIteratorType RowEnd, ResultContainerType &Results)
void	SearchInBoxLocal (PointerType &ThisObject, ResultContainerType &Results, SearchStructure< IndexType, SizeType, CoordinateType, IteratorType, IteratorIteratorType, 1 > &Box)
void	SearchInBoxLocal (PointerType &ThisObject, ResultContainerType &Results, SearchStructure< IndexType, SizeType, CoordinateType, IteratorType, IteratorIteratorType, 2 > &Box)
void	SearchInBoxLocal (PointerType &ThisObject, ResultContainerType &Results, SearchStructure< IndexType, SizeType, CoordinateType, IteratorType, IteratorIteratorType, 3 > &Box)
Tvector< IndexType, Dimension >	CalculateCell (const PointType &ThisPoint)
void	FillObject (SearchStructure< IndexType, SizeType, CoordinateType, IteratorType, IteratorIteratorType, 1 > &Box, const PointerType &object)
void	FillObject (SearchStructure< IndexType, SizeType, CoordinateType, IteratorType, IteratorIteratorType, 2 > &Box, const PointerType &object)
void	FillObject (SearchStructure< IndexType, SizeType, CoordinateType, IteratorType, IteratorIteratorType, 3 > &Box, const PointerType &object)
IndexType	CalculatePosition (CoordinateType const &ThisCoord, SizeType &ThisDimension)

Type Definitions
enum	{ Dimension = TConfigure::Dimension }
typedef TConfigure	Configure
typedef TConfigure::PointType	PointType
typedef TConfigure::PointerType	PointerType
typedef TConfigure::ContainerType	ContainerType
typedef TConfigure::IteratorType	IteratorType
typedef TConfigure::ResultContainerType	ResultContainerType
typedef TConfigure::ResultIteratorType	ResultIteratorType
typedef TreeNode< Dimension, PointType, PointerType, IteratorType, typename TConfigure::DistanceIteratorType >	TreeNodeType
typedef TreeNodeType::CoordinateType	CoordinateType
typedef TreeNodeType::SizeType	SizeType
typedef TreeNodeType::IndexType	IndexType
typedef Tvector< CoordinateType, Dimension >	CoordinateArray
typedef Tvector< SizeType, Dimension >	SizeArray
typedef Tvector< IndexType, Dimension >	IndexArray
typedef TreeNodeType::IteratorIteratorType	IteratorIteratorType
typedef TreeNodeType::SearchStructureType	SearchStructureType
typedef std::vector< PointerType >	LocalContainerType
typedef LocalContainerType::iterator	LocalIteratorType
typedef TConfigure::ContainerContactType	ContainerContactType
	Contact Pair. More...
typedef TConfigure::IteratorContactType	IteratorContactType
typedef std::vector< IndexType >	IndexContainer
typedef IndexContainer::iterator	IndexIterator
typedef std::vector< IteratorType >	IteratorVector
typedef IteratorVector::iterator	IteratorIterator
typedef IteratorVector::const_iterator	IteratorConstIterator
	KRATOS_CLASS_POINTER_DEFINITION (BinsObjectStatic)
	Pointer definition of BinsObjectStatic. More...

Detailed Description

template<class TConfigure>
class Kratos::BinsObjectStatic< TConfigure >

Short class definition.

Detail class definition.

Member Typedef Documentation

Configure

template<class TConfigure >

typedef TConfigure Kratos::BinsObjectStatic< TConfigure >::Configure

ContainerContactType

template<class TConfigure >

typedef TConfigure::ContainerContactType Kratos::BinsObjectStatic< TConfigure >::ContainerContactType

Contact Pair.

ContainerType

template<class TConfigure >

typedef TConfigure::ContainerType Kratos::BinsObjectStatic< TConfigure >::ContainerType

CoordinateArray

template<class TConfigure >

typedef Tvector<CoordinateType,Dimension> Kratos::BinsObjectStatic< TConfigure >::CoordinateArray

CoordinateType

template<class TConfigure >

typedef TreeNodeType::CoordinateType Kratos::BinsObjectStatic< TConfigure >::CoordinateType

IndexArray

template<class TConfigure >

typedef Tvector<IndexType,Dimension> Kratos::BinsObjectStatic< TConfigure >::IndexArray

IndexContainer

template<class TConfigure >

typedef std::vector<IndexType> Kratos::BinsObjectStatic< TConfigure >::IndexContainer

IndexIterator

template<class TConfigure >

typedef IndexContainer::iterator Kratos::BinsObjectStatic< TConfigure >::IndexIterator

IndexType

template<class TConfigure >

typedef TreeNodeType::IndexType Kratos::BinsObjectStatic< TConfigure >::IndexType

IteratorConstIterator

template<class TConfigure >

typedef IteratorVector::const_iterator Kratos::BinsObjectStatic< TConfigure >::IteratorConstIterator

IteratorContactType

template<class TConfigure >

typedef TConfigure::IteratorContactType Kratos::BinsObjectStatic< TConfigure >::IteratorContactType

IteratorIterator

template<class TConfigure >

typedef IteratorVector::iterator Kratos::BinsObjectStatic< TConfigure >::IteratorIterator

IteratorIteratorType

template<class TConfigure >

typedef TreeNodeType::IteratorIteratorType Kratos::BinsObjectStatic< TConfigure >::IteratorIteratorType

IteratorType

template<class TConfigure >

typedef TConfigure::IteratorType Kratos::BinsObjectStatic< TConfigure >::IteratorType

IteratorVector

template<class TConfigure >

typedef std::vector<IteratorType> Kratos::BinsObjectStatic< TConfigure >::IteratorVector

LocalContainerType

template<class TConfigure >

typedef std::vector<PointerType> Kratos::BinsObjectStatic< TConfigure >::LocalContainerType

LocalIteratorType

template<class TConfigure >

typedef LocalContainerType::iterator Kratos::BinsObjectStatic< TConfigure >::LocalIteratorType

PointerType

template<class TConfigure >

typedef TConfigure::PointerType Kratos::BinsObjectStatic< TConfigure >::PointerType

PointType

template<class TConfigure >

typedef TConfigure::PointType Kratos::BinsObjectStatic< TConfigure >::PointType

ResultContainerType

template<class TConfigure >

typedef TConfigure::ResultContainerType Kratos::BinsObjectStatic< TConfigure >::ResultContainerType

ResultIteratorType

template<class TConfigure >

typedef TConfigure::ResultIteratorType Kratos::BinsObjectStatic< TConfigure >::ResultIteratorType

SearchStructureType

template<class TConfigure >

typedef TreeNodeType::SearchStructureType Kratos::BinsObjectStatic< TConfigure >::SearchStructureType

SizeArray

template<class TConfigure >

typedef Tvector<SizeType,Dimension> Kratos::BinsObjectStatic< TConfigure >::SizeArray

SizeType

template<class TConfigure >

typedef TreeNodeType::SizeType Kratos::BinsObjectStatic< TConfigure >::SizeType

TreeNodeType

template<class TConfigure >

typedef TreeNode<Dimension, PointType, PointerType, IteratorType, typename TConfigure::DistanceIteratorType> Kratos::BinsObjectStatic< TConfigure >::TreeNodeType

Member Enumeration Documentation

anonymous enum

template<class TConfigure >

anonymous enum

Enumerator
Dimension

Constructor & Destructor Documentation

BinsObjectStatic() [1/3]

template<class TConfigure >

Kratos::BinsObjectStatic< TConfigure >::BinsObjectStatic ( )

inline

Default constructor.

BinsObjectStatic() [2/3]

template<class TConfigure >

Kratos::BinsObjectStatic< TConfigure >::BinsObjectStatic ( IteratorType const &  ObjectsBegin, IteratorType const &  ObjectsEnd  )

inline

Constructor de bins a bounding box.

BinsObjectStatic() [3/3]

template<class TConfigure >

Kratos::BinsObjectStatic< TConfigure >::BinsObjectStatic ( IteratorType const &  ObjectsBegin, IteratorType const &  ObjectsEnd, const SizeType  Nx, const SizeType  Ny, const SizeType  Nz  )

inline

~BinsObjectStatic()

template<class TConfigure >

virtual Kratos::BinsObjectStatic< TConfigure >::~BinsObjectStatic ( )

inlinevirtual

Destructor.

Member Function Documentation

CalculateBoundingBox()

template<class TConfigure >

void Kratos::BinsObjectStatic< TConfigure >::CalculateBoundingBox ( )

inline

Computa los boxes de cada uno de los elementos del model part.

CalculateCell()

template<class TConfigure >

Tvector<IndexType,Dimension> Kratos::BinsObjectStatic< TConfigure >::CalculateCell ( const PointType &  ThisPoint )

inline

CalculateCellSize()

template<class TConfigure >

void Kratos::BinsObjectStatic< TConfigure >::CalculateCellSize ( std::size_t  ApproximatedSize )

inline

Calculates the cell size of the bins.

Calculates the cell size of the bins using an average aproximation of the objects in the bins.

Parameters

ApproximatedSize

Aproximate number of objects that will be stored in the bins

CalculatePosition()

template<class TConfigure >

IndexType Kratos::BinsObjectStatic< TConfigure >::CalculatePosition ( CoordinateType const &  ThisCoord, SizeType &  ThisDimension  )

inline

CountObject() [1/3]

template<class TConfigure >

void Kratos::BinsObjectStatic< TConfigure >::CountObject ( SearchStructure< IndexType, SizeType, CoordinateType, IteratorType, IteratorIteratorType, 1 > &  Box, PointerType  object  )

inline

CountObject() [2/3]

template<class TConfigure >

void Kratos::BinsObjectStatic< TConfigure >::CountObject ( SearchStructure< IndexType, SizeType, CoordinateType, IteratorType, IteratorIteratorType, 2 > &  Box, PointerType  object  )

inline

CountObject() [3/3]

template<class TConfigure >

void Kratos::BinsObjectStatic< TConfigure >::CountObject ( SearchStructure< IndexType, SizeType, CoordinateType, IteratorType, IteratorIteratorType, 3 > &  Box, PointerType  object  )

inline

FillObject() [1/3]

template<class TConfigure >

void Kratos::BinsObjectStatic< TConfigure >::FillObject ( SearchStructure< IndexType, SizeType, CoordinateType, IteratorType, IteratorIteratorType, 1 > &  Box, const PointerType &  object  )

inline

FillObject() [2/3]

template<class TConfigure >

void Kratos::BinsObjectStatic< TConfigure >::FillObject ( SearchStructure< IndexType, SizeType, CoordinateType, IteratorType, IteratorIteratorType, 2 > &  Box, const PointerType &  object  )

inline

FillObject() [3/3]

template<class TConfigure >

void Kratos::BinsObjectStatic< TConfigure >::FillObject ( SearchStructure< IndexType, SizeType, CoordinateType, IteratorType, IteratorIteratorType, 3 > &  Box, const PointerType &  object  )

inline

GenerateBins()

template<class TConfigure >

void Kratos::BinsObjectStatic< TConfigure >::GenerateBins ( )

inline

GetCellSize()

template<class TConfigure >

CoordinateArray& Kratos::BinsObjectStatic< TConfigure >::GetCellSize ( )

inline

Get the Cell Size object.

Returns

CoordinateArray& Array containing the size of the Cell in each dimension

GetDivisions()

template<class TConfigure >

SizeArray& Kratos::BinsObjectStatic< TConfigure >::GetDivisions ( )

inline

Get the Divisions object.

Returns

SizeArray& Array containing the number of Cells in each dimension

GetMaxPoint()

template<class TConfigure >

PointType& Kratos::BinsObjectStatic< TConfigure >::GetMaxPoint ( )

inline

Get the Max Point object.

Returns

PointType& Max point of the bins

GetMinPoint()

template<class TConfigure >

PointType& Kratos::BinsObjectStatic< TConfigure >::GetMinPoint ( )

inline

Get the Min Point object.

Returns

PointType& Min point of the bins

Info()

template<class TConfigure >

virtual std::string Kratos::BinsObjectStatic< TConfigure >::Info ( ) const

inlinevirtual

Turn back information as a string.

KRATOS_CLASS_POINTER_DEFINITION()

template<class TConfigure >

Kratos::BinsObjectStatic< TConfigure >::KRATOS_CLASS_POINTER_DEFINITION

(

BinsObjectStatic< TConfigure >

)

Pointer definition of BinsObjectStatic.

PrintBox()

template<class TConfigure >

void Kratos::BinsObjectStatic< TConfigure >::PrintBox ( std::ostream &  rout )

inline

Print Limits Points of the Container.

PrintData()

template<class TConfigure >

virtual void Kratos::BinsObjectStatic< TConfigure >::PrintData ( std::ostream &  rOStream ) const

inlinevirtual

Print object's data.

PrintInfo()

template<class TConfigure >

virtual void Kratos::BinsObjectStatic< TConfigure >::PrintInfo ( std::ostream &  rOStream ) const

inlinevirtual

Print information about this object.

PrintSize()

template<class TConfigure >

void Kratos::BinsObjectStatic< TConfigure >::PrintSize ( std::ostream &  rout )

inline

Print Size of Container.

SearchInBoxLocal() [1/6]

template<class TConfigure >

void Kratos::BinsObjectStatic< TConfigure >::SearchInBoxLocal ( PointerType &  ThisObject, ResultContainerType &  Results, SearchStructure< IndexType, SizeType, CoordinateType, IteratorType, IteratorIteratorType, 1 > &  Box  )

inline

SearchInBoxLocal() [2/6]

template<class TConfigure >

void Kratos::BinsObjectStatic< TConfigure >::SearchInBoxLocal ( PointerType &  ThisObject, ResultContainerType &  Results, SearchStructure< IndexType, SizeType, CoordinateType, IteratorType, IteratorIteratorType, 2 > &  Box  )

inline

SearchInBoxLocal() [3/6]

template<class TConfigure >

void Kratos::BinsObjectStatic< TConfigure >::SearchInBoxLocal ( PointerType &  ThisObject, ResultContainerType &  Results, SearchStructure< IndexType, SizeType, CoordinateType, IteratorType, IteratorIteratorType, 3 > &  Box  )

inline

SearchInBoxLocal() [4/6]

template<class TConfigure >

void Kratos::BinsObjectStatic< TConfigure >::SearchInBoxLocal ( PointerType &  ThisObject, ResultIteratorType &  Result, SizeType &  NumberOfResults, const SizeType &  MaxNumberOfResults, SearchStructure< IndexType, SizeType, CoordinateType, IteratorType, IteratorIteratorType, 1 > &  Box  )

inline

SearchInBoxLocal() [5/6]

template<class TConfigure >

void Kratos::BinsObjectStatic< TConfigure >::SearchInBoxLocal ( PointerType &  ThisObject, ResultIteratorType &  Result, SizeType &  NumberOfResults, const SizeType &  MaxNumberOfResults, SearchStructure< IndexType, SizeType, CoordinateType, IteratorType, IteratorIteratorType, 2 > &  Box  )

inline

SearchInBoxLocal() [6/6]

template<class TConfigure >

void Kratos::BinsObjectStatic< TConfigure >::SearchInBoxLocal ( PointerType &  ThisObject, ResultIteratorType &  Result, SizeType &  NumberOfResults, const SizeType &  MaxNumberOfResults, SearchStructure< IndexType, SizeType, CoordinateType, IteratorType, IteratorIteratorType, 3 > &  Box  )

inline

SearchInBoxLocal_()

template<class TConfigure >

void Kratos::BinsObjectStatic< TConfigure >::SearchInBoxLocal_ ( PointerType &  ThisObject, ResultIteratorType &  Result, SizeType &  NumberOfResults, const SizeType &  MaxNumberOfResults, SearchStructure< IndexType, SizeType, CoordinateType, IteratorType, IteratorIteratorType, 3 > &  Box  )

inline

SearchObjectRow() [1/2]

template<class TConfigure >

void Kratos::BinsObjectStatic< TConfigure >::SearchObjectRow ( PointerType &  ThisObject, LocalIteratorType  RowBegin, LocalIteratorType  RowEnd, ResultContainerType &  Results  )

inline

SearchObjectRow() [2/2]

template<class TConfigure >

void Kratos::BinsObjectStatic< TConfigure >::SearchObjectRow ( PointerType &  ThisObject, LocalIteratorType  RowBegin, LocalIteratorType  RowEnd, ResultIteratorType &  Result, SizeType &  NumberOfResults, const SizeType &  MaxNumberOfResults  )

inline

SearchObjects() [1/2]

template<class TConfigure >

SizeType Kratos::BinsObjectStatic< TConfigure >::SearchObjects ( PointerType &  ThisObject, ResultContainerType &  Result  )

inline

SearchObjects() [2/2]

template<class TConfigure >

SizeType Kratos::BinsObjectStatic< TConfigure >::SearchObjects ( PointerType &  ThisObject, ResultIteratorType &  Result, const SizeType &  MaxNumberOfResults  )

inline

---

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

• /home/runner/work/Documentation/Documentation/master/kratos/spatial_containers/bins_static_objects.h