Custom Point container to be used by the search. More...

#include <point_object.h>

Inheritance diagram for Kratos::PointObject< TObject >:

Collaboration diagram for Kratos::PointObject< TObject >:

Public Member Functions
Life Cycle
	PointObject ()
	Default constructors. More...

	PointObject (const array_1d< double, 3 > &Coords)
	Constructor that takes the coordinates of the point. More...

	PointObject (typename TObject::Pointer pObject)
	Constructor with object. More...

Operations
void	UpdatePoint ()
	This function updates the database, using as base for the coordinates the condition center. More...

Acess
TObject::Pointer	pGetObject () const
	Returns the geometry associated to the point. More...

void	pSetObject (typename TObject::Pointer pObject)
	Sets the object associated to the point. More...

void	Check () const
	This method checks everything is right. 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...

Point &	operator= (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

double &	X ()

double &	Y ()

double &	Z ()

CoordinatesArrayType const &	Coordinates () const

CoordinatesArrayType &	Coordinates ()

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_1d &	operator= (const array_1d &v)

BOOST_UBLAS_INLINE array_1d &	operator= (const boost::numeric::ublas::vector_expression< AE > &ae)

BOOST_UBLAS_INLINE array_1d &	operator+= (const boost::numeric::ublas::vector_expression< AE > &ae)

BOOST_UBLAS_INLINE array_1d &	operator-= (const boost::numeric::ublas::vector_expression< AE > &ae)

BOOST_UBLAS_INLINE array_1d &	operator/= (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_1d &	minus_assign (const boost::numeric::ublas::vector_expression< AE > &ae)

BOOST_UBLAS_INLINE const array_type &	data () const

BOOST_UBLAS_INLINE array_type &	data ()

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_1d &	assign_temporary (array_1d &v)

BOOST_UBLAS_INLINE array_1d &	operator*= (const AT &at)

BOOST_UBLAS_INLINE array_1d &	plus_assign (const boost::numeric::ublas::vector_expression< AE > &ae)

BOOST_UBLAS_INLINE array_1d &	assign (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 ()

Type Definitions
using	BaseType = Point
	Base class definition. More...

using	ObjectType = TObject
	Definition of the object type. More...

	KRATOS_CLASS_POINTER_DEFINITION (PointObject)
	Counted pointer of PointObject. More...

Additional Inherited Members
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_type >	const_closure_type

typedef boost::numeric::ublas::vector_reference< self_type >	closure_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

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

Detailed Description

template<class TObject>
class Kratos::PointObject< TObject >

Custom Point container to be used by the search.

It stores the pointer of a certain object

Author: Vicente Mataix Ferrandiz

Member Typedef Documentation

◆ BaseType

template<class TObject >

using Kratos::PointObject< TObject >::BaseType = Point

Base class definition.

◆ ObjectType

template<class TObject >

using Kratos::PointObject< TObject >::ObjectType = TObject

Definition of the object type.

Constructor & Destructor Documentation

◆ PointObject() [1/3]

template<class TObject >

Kratos::PointObject< TObject >::PointObject

Default constructors.

◆ PointObject() [2/3]

template<class TObject >

Kratos::PointObject< TObject >::PointObject ( const array_1d< double, 3 > & Coords )

Constructor that takes the coordinates of the point.

Parameters

Coords The coordinates of the point.

◆ PointObject() [3/3]

template<class TObject >

Kratos::PointObject< TObject >::PointObject ( typename TObject::Pointer pObject )

Constructor with object.

Parameters

pObject The pointer to the object

Member Function Documentation

◆ Check()

template<class TObject >

void Kratos::PointObject< TObject >::Check

This method checks everything is right.

◆ KRATOS_CLASS_POINTER_DEFINITION()

template<class TObject >

Kratos::PointObject< TObject >::KRATOS_CLASS_POINTER_DEFINITION ( PointObject< TObject > )

Counted pointer of PointObject.

◆ pGetObject()

template<class TObject >

TObject::Pointer Kratos::PointObject< TObject >::pGetObject

Returns the geometry associated to the point.

Returns: mrGeometry The reference to the geometry associated to the point

◆ pSetObject()

template<class TObject >

void Kratos::PointObject< TObject >::pSetObject ( typename TObject::Pointer pObject )

Sets the object associated to the point.

Parameters

pObject The pointer to the object

◆ UpdatePoint()

template<class TObject >

void Kratos::PointObject< TObject >::UpdatePoint

This function updates the database, using as base for the coordinates the condition center.

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

/home/runner/work/Documentation/Documentation/master/kratos/spatial_containers/point_object.h
/home/runner/work/Documentation/Documentation/master/kratos/spatial_containers/point_object.cpp

Public Member Functions

Type Definitions

Additional Inherited Members

Detailed Description

template<class TObject> class Kratos::PointObject< TObject >

Member Typedef Documentation

◆ BaseType

◆ ObjectType

Constructor & Destructor Documentation

◆ PointObject() [1/3]

◆ PointObject() [2/3]

◆ PointObject() [3/3]

Member Function Documentation

◆ Check()

◆ KRATOS_CLASS_POINTER_DEFINITION()

◆ pGetObject()

◆ pSetObject()

◆ UpdatePoint()

template<class TObject>
class Kratos::PointObject< TObject >