PFEM Particle class. More...

#include <convection_particle.h>

Inheritance diagram for Kratos::Convection_Particle:

Collaboration diagram for Kratos::Convection_Particle:

Public Types
Type Definitions
typedef Convection_Particle *	Pointer
	Pointer definition of Point. More...

typedef double	TDataType

typedef array_1d< double, 3 >	BaseType

typedef Point	Type

typedef BaseType	CoordinatesArrayType

typedef std::size_t	SizeType

typedef std::size_t	IndexType

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

Life Cycle
	Convection_Particle (TDataType const &NewX, TDataType const &NewY, TDataType const &NewZ)
	Default constructor. More...

	Convection_Particle ()

	~Convection_Particle ()

float &	GetScalar1 ()

bool &	GetEraseFlag ()

Additional Inherited Members
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 ()

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

Detailed Description

PFEM Particle class.

Member Typedef Documentation

◆ BaseType

typedef array_1d<double,3> Kratos::Convection_Particle::BaseType

◆ CoordinatesArrayType

typedef BaseType Kratos::Convection_Particle::CoordinatesArrayType

◆ IndexType

typedef std::size_t Kratos::Convection_Particle::IndexType

◆ Pointer

typedef Convection_Particle* Kratos::Convection_Particle::Pointer

Pointer definition of Point.

◆ SizeType

typedef std::size_t Kratos::Convection_Particle::SizeType

◆ TDataType

typedef double Kratos::Convection_Particle::TDataType

◆ Type

typedef Point Kratos::Convection_Particle::Type

Constructor & Destructor Documentation

◆ Convection_Particle() [1/2]

Kratos::Convection_Particle::Convection_Particle	(	TDataType const &	NewX,
		TDataType const &	NewY,
		TDataType const &	NewZ
	)

inline

Default constructor.

◆ Convection_Particle() [2/2]

Kratos::Convection_Particle::Convection_Particle ( )

inline

◆ ~Convection_Particle()

Kratos::Convection_Particle::~Convection_Particle ( )

inline

Member Function Documentation

◆ GetEraseFlag()

bool& Kratos::Convection_Particle::GetEraseFlag ( )

inline

◆ GetScalar1()

float& Kratos::Convection_Particle::GetScalar1 ( )

inline

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

/home/runner/work/Documentation/Documentation/master/applications/ConvectionDiffusionApplication/custom_utilities/convection_particle.h

Public Types

Life Cycle

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseType

◆ CoordinatesArrayType

◆ IndexType

◆ Pointer

◆ SizeType

◆ TDataType

◆ Type

Constructor & Destructor Documentation

◆ Convection_Particle() [1/2]

◆ Convection_Particle() [2/2]

◆ ~Convection_Particle()

Member Function Documentation

◆ GetEraseFlag()

◆ GetScalar1()