Loading [MathJax]/extensions/tex2jax.js
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.
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
List of all members
Kratos::TreeNode< TDimension, TPointType, TPointerType, TIteratorType, TDistanceIteratorType, TIteratorIteratorType > Class Template Reference

Short class definition. More...

#include <tree.h>

Collaboration diagram for Kratos::TreeNode< TDimension, TPointType, TPointerType, TIteratorType, TDistanceIteratorType, TIteratorIteratorType >:

Type Definitions

using SizeType = std::size_t
 Define SizeType as std::size_t. More...
 
using IndexType = std::size_t
 Define IndexType as std::size_t. More...
 
using CoordinateType = double
 Define CoordinateType as double. More...
 
using PointType = TPointType
 Define PointType as TPointType. More...
 
using PointerType = TPointerType
 Define PointerType as TPointerType. More...
 
using IteratorType = TIteratorType
 Define IteratorType as TIteratorType. More...
 
using DistanceIteratorType = TDistanceIteratorType
 Define DistanceIteratorType as TDistanceIteratorType. More...
 
using TreeNodeType = TreeNode< TDimension, TPointType, TPointerType, TIteratorType, TDistanceIteratorType >
 Define TreeNodeType as a TreeNode type with the given template arguments. More...
 
using IteratorIteratorType = typename std::vector< IteratorType >::iterator
 Define IteratorIteratorType as an iterator type for a vector of IteratorType. More...
 
using SearchStructureType = SearchStructure< IndexType, SizeType, CoordinateType, TIteratorType, IteratorIteratorType, TDimension >
 Define SearchStructureType as a SearchStructure type with the given template arguments. More...
 
 KRATOS_CLASS_POINTER_DEFINITION (TreeNode)
 Pointer definition of TreeNode. More...
 
virtual void PrintData (std::ostream &rOStream, std::string const &Perfix=std::string()) const
 
 TreeNode ()
 
virtual ~TreeNode ()
 
virtual void SearchNearestPoint (PointType const &ThisPoint, PointerType &rResult, CoordinateType &rResultDistance)
 
virtual void SearchNearestPoint (PointType const &ThisPoint, PointerType &rResult, CoordinateType &rResultDistance, SearchStructureType &Auxiliar)
 
virtual void SearchInRadius (PointType const &ThisPoint, CoordinateType const &Radius, CoordinateType const &Radius2, IteratorType &Results, DistanceIteratorType &ResultsDistances, SizeType &NumberOfResults, SizeType const &MaxNumberOfResults)
 
virtual void SearchInRadius (PointType const &ThisPoint, CoordinateType const &Radius, CoordinateType const &Radius2, IteratorType &Results, DistanceIteratorType &ResultsDistances, SizeType &NumberOfResults, SizeType const &MaxNumberOfResults, SearchStructureType &Auxiliar)
 
virtual void SearchInRadius (PointType const &ThisPoint, CoordinateType const &Radius, CoordinateType const &Radius2, IteratorType &Results, SizeType &NumberOfResults, SizeType const &MaxNumberOfResults)
 
virtual void SearchInRadius (PointType const &ThisPoint, CoordinateType const &Radius, CoordinateType const &Radius2, IteratorType &Results, SizeType &NumberOfResults, SizeType const &MaxNumberOfResults, SearchStructureType &Auxiliar)
 
virtual void SearchInBox (PointType const &SearchMinPoint, PointType const &SearchMaxPoint, IteratorType &Results, SizeType &NumberOfResults, SizeType const &MaxNumberOfResults)
 
static IteratorType & NullIterator ()
 
static PointerType & NullPointer ()
 
static TreeNode & NullLeaf ()
 

Detailed Description

template<std::size_t TDimension, class TPointType, class TPointerType, class TIteratorType, class TDistanceIteratorType, class TIteratorIteratorType = typename std::vector<TIteratorType>::iterator>
class Kratos::TreeNode< TDimension, TPointType, TPointerType, TIteratorType, TDistanceIteratorType, TIteratorIteratorType >

Short class definition.

Detail class definition.

Member Typedef Documentation

◆ CoordinateType

template<std::size_t TDimension, class TPointType , class TPointerType , class TIteratorType , class TDistanceIteratorType , class TIteratorIteratorType = typename std::vector<TIteratorType>::iterator>
using Kratos::TreeNode< TDimension, TPointType, TPointerType, TIteratorType, TDistanceIteratorType, TIteratorIteratorType >::CoordinateType = double

Define CoordinateType as double.

◆ DistanceIteratorType

template<std::size_t TDimension, class TPointType , class TPointerType , class TIteratorType , class TDistanceIteratorType , class TIteratorIteratorType = typename std::vector<TIteratorType>::iterator>
using Kratos::TreeNode< TDimension, TPointType, TPointerType, TIteratorType, TDistanceIteratorType, TIteratorIteratorType >::DistanceIteratorType = TDistanceIteratorType

Define DistanceIteratorType as TDistanceIteratorType.

◆ IndexType

template<std::size_t TDimension, class TPointType , class TPointerType , class TIteratorType , class TDistanceIteratorType , class TIteratorIteratorType = typename std::vector<TIteratorType>::iterator>
using Kratos::TreeNode< TDimension, TPointType, TPointerType, TIteratorType, TDistanceIteratorType, TIteratorIteratorType >::IndexType = std::size_t

Define IndexType as std::size_t.

◆ IteratorIteratorType

template<std::size_t TDimension, class TPointType , class TPointerType , class TIteratorType , class TDistanceIteratorType , class TIteratorIteratorType = typename std::vector<TIteratorType>::iterator>
using Kratos::TreeNode< TDimension, TPointType, TPointerType, TIteratorType, TDistanceIteratorType, TIteratorIteratorType >::IteratorIteratorType = typename std::vector<IteratorType>::iterator

Define IteratorIteratorType as an iterator type for a vector of IteratorType.

◆ IteratorType

template<std::size_t TDimension, class TPointType , class TPointerType , class TIteratorType , class TDistanceIteratorType , class TIteratorIteratorType = typename std::vector<TIteratorType>::iterator>
using Kratos::TreeNode< TDimension, TPointType, TPointerType, TIteratorType, TDistanceIteratorType, TIteratorIteratorType >::IteratorType = TIteratorType

Define IteratorType as TIteratorType.

◆ PointerType

template<std::size_t TDimension, class TPointType , class TPointerType , class TIteratorType , class TDistanceIteratorType , class TIteratorIteratorType = typename std::vector<TIteratorType>::iterator>
using Kratos::TreeNode< TDimension, TPointType, TPointerType, TIteratorType, TDistanceIteratorType, TIteratorIteratorType >::PointerType = TPointerType

Define PointerType as TPointerType.

◆ PointType

template<std::size_t TDimension, class TPointType , class TPointerType , class TIteratorType , class TDistanceIteratorType , class TIteratorIteratorType = typename std::vector<TIteratorType>::iterator>
using Kratos::TreeNode< TDimension, TPointType, TPointerType, TIteratorType, TDistanceIteratorType, TIteratorIteratorType >::PointType = TPointType

Define PointType as TPointType.

◆ SearchStructureType

template<std::size_t TDimension, class TPointType , class TPointerType , class TIteratorType , class TDistanceIteratorType , class TIteratorIteratorType = typename std::vector<TIteratorType>::iterator>
using Kratos::TreeNode< TDimension, TPointType, TPointerType, TIteratorType, TDistanceIteratorType, TIteratorIteratorType >::SearchStructureType = SearchStructure<IndexType, SizeType, CoordinateType, TIteratorType, IteratorIteratorType, TDimension>

Define SearchStructureType as a SearchStructure type with the given template arguments.

◆ SizeType

template<std::size_t TDimension, class TPointType , class TPointerType , class TIteratorType , class TDistanceIteratorType , class TIteratorIteratorType = typename std::vector<TIteratorType>::iterator>
using Kratos::TreeNode< TDimension, TPointType, TPointerType, TIteratorType, TDistanceIteratorType, TIteratorIteratorType >::SizeType = std::size_t

Define SizeType as std::size_t.

◆ TreeNodeType

template<std::size_t TDimension, class TPointType , class TPointerType , class TIteratorType , class TDistanceIteratorType , class TIteratorIteratorType = typename std::vector<TIteratorType>::iterator>
using Kratos::TreeNode< TDimension, TPointType, TPointerType, TIteratorType, TDistanceIteratorType, TIteratorIteratorType >::TreeNodeType = TreeNode<TDimension, TPointType, TPointerType, TIteratorType, TDistanceIteratorType>

Define TreeNodeType as a TreeNode type with the given template arguments.

Constructor & Destructor Documentation

◆ TreeNode()

template<std::size_t TDimension, class TPointType , class TPointerType , class TIteratorType , class TDistanceIteratorType , class TIteratorIteratorType = typename std::vector<TIteratorType>::iterator>
Kratos::TreeNode< TDimension, TPointType, TPointerType, TIteratorType, TDistanceIteratorType, TIteratorIteratorType >::TreeNode ( )
inline

◆ ~TreeNode()

template<std::size_t TDimension, class TPointType , class TPointerType , class TIteratorType , class TDistanceIteratorType , class TIteratorIteratorType = typename std::vector<TIteratorType>::iterator>
virtual Kratos::TreeNode< TDimension, TPointType, TPointerType, TIteratorType, TDistanceIteratorType, TIteratorIteratorType >::~TreeNode ( )
inlinevirtual

Member Function Documentation

◆ KRATOS_CLASS_POINTER_DEFINITION()

template<std::size_t TDimension, class TPointType , class TPointerType , class TIteratorType , class TDistanceIteratorType , class TIteratorIteratorType = typename std::vector<TIteratorType>::iterator>
Kratos::TreeNode< TDimension, TPointType, TPointerType, TIteratorType, TDistanceIteratorType, TIteratorIteratorType >::KRATOS_CLASS_POINTER_DEFINITION ( TreeNode< TDimension, TPointType, TPointerType, TIteratorType, TDistanceIteratorType, TIteratorIteratorType >  )

Pointer definition of TreeNode.

◆ NullIterator()

template<std::size_t TDimension, class TPointType , class TPointerType , class TIteratorType , class TDistanceIteratorType , class TIteratorIteratorType = typename std::vector<TIteratorType>::iterator>
static IteratorType& Kratos::TreeNode< TDimension, TPointType, TPointerType, TIteratorType, TDistanceIteratorType, TIteratorIteratorType >::NullIterator ( )
inlinestatic

◆ NullLeaf()

template<std::size_t TDimension, class TPointType , class TPointerType , class TIteratorType , class TDistanceIteratorType , class TIteratorIteratorType = typename std::vector<TIteratorType>::iterator>
static TreeNode& Kratos::TreeNode< TDimension, TPointType, TPointerType, TIteratorType, TDistanceIteratorType, TIteratorIteratorType >::NullLeaf ( )
inlinestatic

◆ NullPointer()

template<std::size_t TDimension, class TPointType , class TPointerType , class TIteratorType , class TDistanceIteratorType , class TIteratorIteratorType = typename std::vector<TIteratorType>::iterator>
static PointerType& Kratos::TreeNode< TDimension, TPointType, TPointerType, TIteratorType, TDistanceIteratorType, TIteratorIteratorType >::NullPointer ( )
inlinestatic

◆ PrintData()

template<std::size_t TDimension, class TPointType , class TPointerType , class TIteratorType , class TDistanceIteratorType , class TIteratorIteratorType = typename std::vector<TIteratorType>::iterator>
virtual void Kratos::TreeNode< TDimension, TPointType, TPointerType, TIteratorType, TDistanceIteratorType, TIteratorIteratorType >::PrintData ( std::ostream &  rOStream,
std::string const &  Perfix = std::string() 
) const
inlinevirtual

Reimplemented in Kratos::OCTreePartition< TLeafType >, Kratos::KDTreePartitionBase< TLeafType >, Kratos::Bucket< TDimension, TPointType, TContainerType, TPointerType, TIteratorType, TDistanceIteratorType, TDistanceFunction >, Kratos::Bins< TDimension, TPointType, TContainerType, TPointerType, TIteratorType, TDistanceIteratorType, TDistanceFunction >, and Kratos::BinsDynamic< TDimension, TPointType, TContainerType, TPointerType, TIteratorType, TDistanceIteratorType, TDistanceFunction >.

◆ SearchInBox()

template<std::size_t TDimension, class TPointType , class TPointerType , class TIteratorType , class TDistanceIteratorType , class TIteratorIteratorType = typename std::vector<TIteratorType>::iterator>
virtual void Kratos::TreeNode< TDimension, TPointType, TPointerType, TIteratorType, TDistanceIteratorType, TIteratorIteratorType >::SearchInBox ( PointType const &  SearchMinPoint,
PointType const &  SearchMaxPoint,
IteratorType &  Results,
SizeType &  NumberOfResults,
SizeType const &  MaxNumberOfResults 
)
inlinevirtual

◆ SearchInRadius() [1/4]

template<std::size_t TDimension, class TPointType , class TPointerType , class TIteratorType , class TDistanceIteratorType , class TIteratorIteratorType = typename std::vector<TIteratorType>::iterator>
virtual void Kratos::TreeNode< TDimension, TPointType, TPointerType, TIteratorType, TDistanceIteratorType, TIteratorIteratorType >::SearchInRadius ( PointType const &  ThisPoint,
CoordinateType const &  Radius,
CoordinateType const &  Radius2,
IteratorType &  Results,
DistanceIteratorType &  ResultsDistances,
SizeType &  NumberOfResults,
SizeType const &  MaxNumberOfResults 
)
inlinevirtual

◆ SearchInRadius() [2/4]

template<std::size_t TDimension, class TPointType , class TPointerType , class TIteratorType , class TDistanceIteratorType , class TIteratorIteratorType = typename std::vector<TIteratorType>::iterator>
virtual void Kratos::TreeNode< TDimension, TPointType, TPointerType, TIteratorType, TDistanceIteratorType, TIteratorIteratorType >::SearchInRadius ( PointType const &  ThisPoint,
CoordinateType const &  Radius,
CoordinateType const &  Radius2,
IteratorType &  Results,
DistanceIteratorType &  ResultsDistances,
SizeType &  NumberOfResults,
SizeType const &  MaxNumberOfResults,
SearchStructureType &  Auxiliar 
)
inlinevirtual

◆ SearchInRadius() [3/4]

template<std::size_t TDimension, class TPointType , class TPointerType , class TIteratorType , class TDistanceIteratorType , class TIteratorIteratorType = typename std::vector<TIteratorType>::iterator>
virtual void Kratos::TreeNode< TDimension, TPointType, TPointerType, TIteratorType, TDistanceIteratorType, TIteratorIteratorType >::SearchInRadius ( PointType const &  ThisPoint,
CoordinateType const &  Radius,
CoordinateType const &  Radius2,
IteratorType &  Results,
SizeType &  NumberOfResults,
SizeType const &  MaxNumberOfResults 
)
inlinevirtual

◆ SearchInRadius() [4/4]

template<std::size_t TDimension, class TPointType , class TPointerType , class TIteratorType , class TDistanceIteratorType , class TIteratorIteratorType = typename std::vector<TIteratorType>::iterator>
virtual void Kratos::TreeNode< TDimension, TPointType, TPointerType, TIteratorType, TDistanceIteratorType, TIteratorIteratorType >::SearchInRadius ( PointType const &  ThisPoint,
CoordinateType const &  Radius,
CoordinateType const &  Radius2,
IteratorType &  Results,
SizeType &  NumberOfResults,
SizeType const &  MaxNumberOfResults,
SearchStructureType &  Auxiliar 
)
inlinevirtual

◆ SearchNearestPoint() [1/2]

template<std::size_t TDimension, class TPointType , class TPointerType , class TIteratorType , class TDistanceIteratorType , class TIteratorIteratorType = typename std::vector<TIteratorType>::iterator>
virtual void Kratos::TreeNode< TDimension, TPointType, TPointerType, TIteratorType, TDistanceIteratorType, TIteratorIteratorType >::SearchNearestPoint ( PointType const &  ThisPoint,
PointerType &  rResult,
CoordinateType &  rResultDistance 
)
inlinevirtual

◆ SearchNearestPoint() [2/2]

template<std::size_t TDimension, class TPointType , class TPointerType , class TIteratorType , class TDistanceIteratorType , class TIteratorIteratorType = typename std::vector<TIteratorType>::iterator>
virtual void Kratos::TreeNode< TDimension, TPointType, TPointerType, TIteratorType, TDistanceIteratorType, TIteratorIteratorType >::SearchNearestPoint ( PointType const &  ThisPoint,
PointerType &  rResult,
CoordinateType &  rResultDistance,
SearchStructureType &  Auxiliar 
)
inlinevirtual
The documentation for this class was generated from the following file:
Generated on Sat Feb 3 2024 02:51:38 for KratosMultiphysics by doxygen 1.9.1