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.
List of all members
Kratos::Cell< TConfigure > Class Template Reference

#include <cell.h>

Collaboration diagram for Kratos::Cell< TConfigure >:

Public Member Functions

Life Cycle
 Cell ()
 Default constructor. More...
 
virtual ~Cell ()
 Destructor. More...
 
void Add (const PointerType &ThisObject)
 
void Remove (const PointerType &ThisObject)
 
void Remove (const std::size_t Index)
 
void Clear ()
 
void AllocateCell (const std::size_t size)
 
Cell & operator= (Cell const &rOther)
 Assignment operator. More...
 
 Cell (Cell const &rOther)
 Copy constructor. More...
 
void SearchObjects (PointerType &rThisObject, ResultIteratorType &Result, SizeType &NumberOfResults, const SizeType &MaxNumberOfResults)
 
void SearchObjects (PointerType &rThisObject, ResultContainerType &Result)
 
void SearchObjectsExclusive (PointerType &rThisObject, ResultIteratorType &Result, SizeType &NumberOfResults, const SizeType &MaxNumberOfResults)
 
void SearchObjectsExclusive (PointerType &rThisObject, ResultContainerType &Result)
 
void SearchObjectsInRadius (PointerType &rThisObject, double const &Radius, ResultIteratorType &Result, SizeType &NumberOfResults, const SizeType &MaxNumberOfResults)
 
void SearchObjectsInRadiusExclusive (PointerType &rThisObject, double const &Radius, ResultIteratorType &Result, SizeType &NumberOfResults, const SizeType &MaxNumberOfResults)
 
void SearchObjectsInRadius (PointerType &rThisObject, double const &Radius, ResultIteratorType &Result, DistanceIteratorType &Distances, SizeType &NumberOfResults, const SizeType &MaxNumberOfResults)
 
void SearchObjectsInRadiusExclusive (PointerType &rThisObject, double const &Radius, ResultIteratorType &Result, DistanceIteratorType &Distances, SizeType &NumberOfResults, const SizeType &MaxNumberOfResults)
 
LocalIteratorType Begin ()
 
LocalIteratorType End ()
 
SizeType Size ()
 
LocalIteratorType Begin () const
 
LocalIteratorType End () const
 
SizeType Size () const
 
PointerType GetObject (std::size_t Index)
 
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

typedef std::size_t SizeType
 configure types More...
 
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 TConfigure::DistanceIteratorType DistanceIteratorType
 
typedef std::vector< PointerType > LocalContainerType
 
typedef LocalContainerType::iterator LocalIteratorType
 
 KRATOS_CLASS_POINTER_DEFINITION (Cell)
 Pointer definition of Cell. More...
 

Member Typedef Documentation

◆ ContainerType

template<class TConfigure >
typedef TConfigure::ContainerType Kratos::Cell< TConfigure >::ContainerType

◆ DistanceIteratorType

template<class TConfigure >
typedef TConfigure::DistanceIteratorType Kratos::Cell< TConfigure >::DistanceIteratorType

◆ IteratorType

template<class TConfigure >
typedef TConfigure::IteratorType Kratos::Cell< TConfigure >::IteratorType

◆ LocalContainerType

template<class TConfigure >
typedef std::vector<PointerType> Kratos::Cell< TConfigure >::LocalContainerType

◆ LocalIteratorType

template<class TConfigure >
typedef LocalContainerType::iterator Kratos::Cell< TConfigure >::LocalIteratorType

◆ PointerType

template<class TConfigure >
typedef TConfigure::PointerType Kratos::Cell< TConfigure >::PointerType

◆ PointType

template<class TConfigure >
typedef TConfigure::PointType Kratos::Cell< TConfigure >::PointType

◆ ResultContainerType

template<class TConfigure >
typedef TConfigure::ResultContainerType Kratos::Cell< TConfigure >::ResultContainerType

◆ ResultIteratorType

template<class TConfigure >
typedef TConfigure::ResultIteratorType Kratos::Cell< TConfigure >::ResultIteratorType

◆ SizeType

template<class TConfigure >
typedef std::size_t Kratos::Cell< TConfigure >::SizeType

configure types

Constructor & Destructor Documentation

◆ Cell() [1/2]

template<class TConfigure >
Kratos::Cell< TConfigure >::Cell ( )
inline

Default constructor.

◆ ~Cell()

template<class TConfigure >
virtual Kratos::Cell< TConfigure >::~Cell ( )
inlinevirtual

Destructor.

◆ Cell() [2/2]

template<class TConfigure >
Kratos::Cell< TConfigure >::Cell ( Cell< TConfigure > const &  rOther)
inline

Copy constructor.

Member Function Documentation

◆ Add()

template<class TConfigure >
void Kratos::Cell< TConfigure >::Add ( const PointerType &  ThisObject)
inline

◆ AllocateCell()

template<class TConfigure >
void Kratos::Cell< TConfigure >::AllocateCell ( const std::size_t  size)
inline

◆ Begin() [1/2]

template<class TConfigure >
LocalIteratorType Kratos::Cell< TConfigure >::Begin ( )
inline

◆ Begin() [2/2]

template<class TConfigure >
LocalIteratorType Kratos::Cell< TConfigure >::Begin ( ) const
inline

◆ Clear()

template<class TConfigure >
void Kratos::Cell< TConfigure >::Clear ( )
inline

◆ End() [1/2]

template<class TConfigure >
LocalIteratorType Kratos::Cell< TConfigure >::End ( )
inline

◆ End() [2/2]

template<class TConfigure >
LocalIteratorType Kratos::Cell< TConfigure >::End ( ) const
inline

◆ GetObject()

template<class TConfigure >
PointerType Kratos::Cell< TConfigure >::GetObject ( std::size_t  Index)
inline

◆ Info()

template<class TConfigure >
virtual std::string Kratos::Cell< TConfigure >::Info ( ) const
inlinevirtual

Turn back information as a string.

◆ KRATOS_CLASS_POINTER_DEFINITION()

template<class TConfigure >
Kratos::Cell< TConfigure >::KRATOS_CLASS_POINTER_DEFINITION ( Cell< TConfigure >  )

Pointer definition of Cell.

◆ operator=()

template<class TConfigure >
Cell& Kratos::Cell< TConfigure >::operator= ( Cell< TConfigure > const &  rOther)
inline

Assignment operator.

◆ PrintData()

template<class TConfigure >
virtual void Kratos::Cell< TConfigure >::PrintData ( std::ostream &  rOStream) const
inlinevirtual

Print object's data.

◆ PrintInfo()

template<class TConfigure >
virtual void Kratos::Cell< TConfigure >::PrintInfo ( std::ostream &  rOStream) const
inlinevirtual

Print information about this object.

◆ Remove() [1/2]

template<class TConfigure >
void Kratos::Cell< TConfigure >::Remove ( const PointerType &  ThisObject)
inline

◆ Remove() [2/2]

template<class TConfigure >
void Kratos::Cell< TConfigure >::Remove ( const std::size_t  Index)
inline

◆ SearchObjects() [1/2]

template<class TConfigure >
void Kratos::Cell< TConfigure >::SearchObjects ( PointerType &  rThisObject,
ResultContainerType &  Result 
)
inline

◆ SearchObjects() [2/2]

template<class TConfigure >
void Kratos::Cell< TConfigure >::SearchObjects ( PointerType &  rThisObject,
ResultIteratorType &  Result,
SizeType &  NumberOfResults,
const SizeType &  MaxNumberOfResults 
)
inline

◆ SearchObjectsExclusive() [1/2]

template<class TConfigure >
void Kratos::Cell< TConfigure >::SearchObjectsExclusive ( PointerType &  rThisObject,
ResultContainerType &  Result 
)
inline

◆ SearchObjectsExclusive() [2/2]

template<class TConfigure >
void Kratos::Cell< TConfigure >::SearchObjectsExclusive ( PointerType &  rThisObject,
ResultIteratorType &  Result,
SizeType &  NumberOfResults,
const SizeType &  MaxNumberOfResults 
)
inline

◆ SearchObjectsInRadius() [1/2]

template<class TConfigure >
void Kratos::Cell< TConfigure >::SearchObjectsInRadius ( PointerType &  rThisObject,
double const &  Radius,
ResultIteratorType &  Result,
DistanceIteratorType &  Distances,
SizeType &  NumberOfResults,
const SizeType &  MaxNumberOfResults 
)
inline

◆ SearchObjectsInRadius() [2/2]

template<class TConfigure >
void Kratos::Cell< TConfigure >::SearchObjectsInRadius ( PointerType &  rThisObject,
double const &  Radius,
ResultIteratorType &  Result,
SizeType &  NumberOfResults,
const SizeType &  MaxNumberOfResults 
)
inline

◆ SearchObjectsInRadiusExclusive() [1/2]

template<class TConfigure >
void Kratos::Cell< TConfigure >::SearchObjectsInRadiusExclusive ( PointerType &  rThisObject,
double const &  Radius,
ResultIteratorType &  Result,
DistanceIteratorType &  Distances,
SizeType &  NumberOfResults,
const SizeType &  MaxNumberOfResults 
)
inline

◆ SearchObjectsInRadiusExclusive() [2/2]

template<class TConfigure >
void Kratos::Cell< TConfigure >::SearchObjectsInRadiusExclusive ( PointerType &  rThisObject,
double const &  Radius,
ResultIteratorType &  Result,
SizeType &  NumberOfResults,
const SizeType &  MaxNumberOfResults 
)
inline

◆ Size() [1/2]

template<class TConfigure >
SizeType Kratos::Cell< TConfigure >::Size ( )
inline

◆ Size() [2/2]

template<class TConfigure >
SizeType Kratos::Cell< TConfigure >::Size ( ) const
inline
The documentation for this class was generated from the following file:
Generated on Sat Feb 3 2024 02:51:37 for KratosMultiphysics by doxygen 1.9.1