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.
Public Types | Public Member Functions | List of all members
Kratos::PointWithId Class Reference

#include <closest_points.h>

Inheritance diagram for Kratos::PointWithId:
Collaboration diagram for Kratos::PointWithId:

Public Types

typedef std::size_t IndexType
 The definition of the index type. More...
 
- Public Types inherited from Kratos::IndexedObject
typedef std::size_t IndexType
 The definition of the index type. More...
 
typedef std::size_t result_type
 The definition of the result_type. More...
 
- Public Types inherited from Kratos::Point
typedef array_1d< double, mDimension > BaseType
 
typedef BaseType CoordinatesArrayType
 
typedef std::size_t SizeType
 
typedef std::size_t IndexType
 
- Public Types inherited from Kratos::array_1d< double, 3 >
typedef std::size_t size_type
 
typedef std::ptrdiff_t difference_type
 
typedef double value_type
 
typedef boost::numeric::ublas::type_traits< double >::const_reference const_reference
 
typedef double & reference
 
typedef std::array< double, N > array_type
 
typedef double * pointer
 
typedef array_1d< double, N > self_type
 
typedef const boost::numeric::ublas::vector_reference< const self_typeconst_closure_type
 
typedef boost::numeric::ublas::vector_reference< self_typeclosure_type
 
typedef self_type vector_temporary_type
 
typedef boost::numeric::ublas::dense_tag storage_category
 
typedef boost::numeric::ublas::reverse_iterator_base< const_iterator > const_reverse_iterator
 
typedef boost::numeric::ublas::reverse_iterator_base< iterator > reverse_iterator
 

Public Member Functions

 PointWithId (const IndexType NewId, const CoordinatesArrayType &rCoords, const double Distance)
 
 PointWithId (const PointWithId &rOther)
 
PointWithIdoperator= (const PointWithId &rOther)=delete
 
bool operator< (const PointWithId &rOther) const
 
double GetDistance () const
 
- Public Member Functions inherited from Kratos::IndexedObject
 IndexedObject (IndexType NewId=0)
 Default constructor. More...
 
virtual ~IndexedObject ()
 Destructor. More...
 
 IndexedObject (IndexedObject const &rOther)
 Copy constructor. More...
 
IndexedObjectoperator= (IndexedObject const &rOther)
 Assignment operator. More...
 
template<class TObjectType >
IndexType operator() (TObjectType const &rThisObject) const
 
IndexType Id () const
 
IndexType GetId () const
 
virtual void SetId (IndexType NewId)
 
IndexTypeDepricatedIdAccess ()
 TODO: remove this function when removing data_file_io object. More...
 
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...
 
 KRATOS_CLASS_POINTER_DEFINITION (IndexedObject)
 Pointer definition of IndexedObject. More...
 
- Public Member Functions inherited from Kratos::Point
 Point ()
 Default constructor. More...
 
 Point (double NewX, double NewY=0, double NewZ=0)
 3d constructor. More...
 
 Point (Point const &rOtherPoint)
 
 Point (CoordinatesArrayType const &rOtherCoordinates)
 
template<class TVectorType >
 Point (vector_expression< TVectorType > const &rOtherCoordinates)
 
 Point (std::vector< double > const &rOtherCoordinates)
 
virtual ~Point ()
 Destructor. More...
 
Pointoperator= (const Point &rOther)
 Assignment operator. More...
 
bool operator== (const Point &rOther) const
 
double SquaredDistance (const Point &rOtherPoint) const
 This method computes the distance between this point and another one (squared) More...
 
double Distance (const Point &rOtherPoint) const
 This method computes the distance between this point and another one. More...
 
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...
 
 KRATOS_CLASS_POINTER_DEFINITION (Point)
 Pointer definition of Point. More...
 
double X () const
 
double Y () const
 
double Z () const
 
doubleX ()
 
doubleY ()
 
doubleZ ()
 
CoordinatesArrayType const & Coordinates () const
 
CoordinatesArrayTypeCoordinates ()
 
- Public Member Functions inherited from Kratos::array_1d< double, 3 >
BOOST_UBLAS_INLINE array_1d ()
 Default constructor. More...
 
BOOST_UBLAS_INLINE array_1d (size_type array_size)
 
BOOST_UBLAS_INLINE array_1d (size_type array_size, value_type v)
 
BOOST_UBLAS_INLINE array_1d (const std::initializer_list< value_type > &rInitList)
 
BOOST_UBLAS_INLINE array_1d (size_type array_size, const array_type &rdata)
 
BOOST_UBLAS_INLINE array_1d (const array_1d &v)
 
BOOST_UBLAS_INLINE array_1d (const boost::numeric::ublas::vector_expression< AE > &ae)
 
BOOST_UBLAS_INLINE const_reference operator() (size_type i) const
 
BOOST_UBLAS_INLINE reference operator() (size_type i)
 
BOOST_UBLAS_INLINE const_reference operator[] (size_type i) const
 
BOOST_UBLAS_INLINE reference operator[] (size_type i)
 
BOOST_UBLAS_INLINE array_1doperator= (const array_1d &v)
 
BOOST_UBLAS_INLINE array_1doperator= (const boost::numeric::ublas::vector_expression< AE > &ae)
 
BOOST_UBLAS_INLINE array_1doperator+= (const boost::numeric::ublas::vector_expression< AE > &ae)
 
BOOST_UBLAS_INLINE array_1doperator-= (const boost::numeric::ublas::vector_expression< AE > &ae)
 
BOOST_UBLAS_INLINE array_1doperator/= (const AT &at)
 
BOOST_UBLAS_INLINE bool operator== (const array_1d &v) const
 Compares whether this array_1d is equal to the given array_1d. More...
 
 KRATOS_CLASS_POINTER_DEFINITION (array_1d)
 Pointer definition of array_1d. More...
 
BOOST_UBLAS_INLINE const_iterator find (size_type i) const
 
BOOST_UBLAS_INLINE iterator find (size_type i)
 
BOOST_UBLAS_INLINE size_type size () const
 
BOOST_UBLAS_INLINE array_1dminus_assign (const boost::numeric::ublas::vector_expression< AE > &ae)
 
BOOST_UBLAS_INLINE const array_typedata () const
 
BOOST_UBLAS_INLINE array_typedata ()
 
BOOST_UBLAS_INLINE const_iterator begin () const
 
BOOST_UBLAS_INLINE iterator begin ()
 
BOOST_UBLAS_INLINE const_iterator end () const
 
BOOST_UBLAS_INLINE iterator end ()
 
BOOST_UBLAS_INLINE const_reverse_iterator rbegin () const
 
BOOST_UBLAS_INLINE reverse_iterator rbegin ()
 
BOOST_UBLAS_INLINE const_reverse_iterator rend () const
 
BOOST_UBLAS_INLINE reverse_iterator rend ()
 
BOOST_UBLAS_INLINE void resize (size_type array_size, bool preserve=true)
 
BOOST_UBLAS_INLINE array_1dassign_temporary (array_1d &v)
 
BOOST_UBLAS_INLINE array_1doperator*= (const AT &at)
 
BOOST_UBLAS_INLINE array_1dplus_assign (const boost::numeric::ublas::vector_expression< AE > &ae)
 
BOOST_UBLAS_INLINE array_1dassign (const boost::numeric::ublas::vector_expression< AE > &ae)
 
BOOST_UBLAS_INLINE void swap (array_1d &v)
 
BOOST_UBLAS_INLINE reference insert_element (size_type i, const_reference t)
 
BOOST_UBLAS_INLINE void erase_element (size_type i)
 
BOOST_UBLAS_INLINE void clear ()
 

Serialization

class Serializer
 

Additional Inherited Members

- Static Public Member Functions inherited from Kratos::Point
static constexpr IndexType Dimension ()
 

Member Typedef Documentation

◆ IndexType

typedef std::size_t Kratos::IndexedObject::IndexType

The definition of the index type.

Constructor & Destructor Documentation

◆ PointWithId() [1/2]

Kratos::PointWithId::PointWithId ( const IndexType  NewId,
const CoordinatesArrayType rCoords,
const double  Distance 
)

◆ PointWithId() [2/2]

Kratos::PointWithId::PointWithId ( const PointWithId rOther)

Member Function Documentation

◆ GetDistance()

double Kratos::PointWithId::GetDistance ( ) const
inline

◆ operator<()

bool Kratos::PointWithId::operator< ( const PointWithId rOther) const

◆ operator=()

PointWithId& Kratos::PointWithId::operator= ( const PointWithId rOther)
delete

Friends And Related Function Documentation

◆ Serializer

friend class Serializer
friend

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