This class contains the tools related with the distance spatial container cell data. More...

#include <find_intersected_geometrical_objects_process.h>

Collaboration diagram for Kratos::Internals::DistanceSpatialContainersConfigure:

Classes
class	CellNodeData
	This class contains the cell node data. More...

Public Types
Enum's
enum	{ Dimension = 3 , DIMENSION = 3 , MAX_LEVEL = 12 , MIN_LEVEL = 2 }

Public Member Functions
Life Cycle
	DistanceSpatialContainersConfigure ()
	Default constructor. More...

virtual	~DistanceSpatialContainersConfigure ()
	Destructor. More...

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...

Static Public Member Functions
Operations
static data_type *	AllocateData ()
	This method allocates the cell data. More...

static void	CopyData (data_type pSource, data_type pDestination)
	This method copies the data from a cell. More...

static void	DeleteData (data_type *pData)
	This method deletes the data from a cell data. More...

static void	CalculateBoundingBox (const PointerType &pObject, PointType &rLowPoint, PointType &rHighPoint)
	This method computes the bounding box of an object. More...

static void	GetBoundingBox (const typename GeometricalObject::Pointer pObject, double rLowPoint, double rHighPoint)
	This method computes the bounding box of an object (using C arrays) More...

static bool	Intersection (const typename GeometricalObject::Pointer pObj1, const typename GeometricalObject::Pointer pObj2)
	This method computes if there is an intersection between two objects. More...

static bool	IntersectionBox (const typename GeometricalObject::Pointer pObject, const PointType &rLowPoint, const PointType &rHighPoint)
	This computes the intersection between an object and a box. More...

static bool	IsIntersected (const typename GeometricalObject::Pointer pObject, double Tolerance, const double rLowPoint, const double rHighPoint)
	This method checks if the objects intersects the low and hight points provided. More...

Type Definitions
typedef std::size_t	IndexType
	Definition of the index type. More...

typedef Point	PointType
	Definition of the point type. More...

typedef std::vector< double >::iterator	DistanceIteratorType
	Definition of the distance iterator type. More...

typedef PointerVectorSet< GeometricalObject, IndexedObject >	EntityContainerType
	Definition of the entity container type. More...

typedef EntityContainerType::ContainerType	ContainerType
	Definition of the container type. More...

typedef ContainerType::value_type	PointerType
	Defintion of the pointer type. More...

typedef CellNodeData	cell_node_data_type
	Definition of the cell node data. More...

typedef std::vector< CellNodeData * >	data_type
	Definition of the cell data type. More...

typedef PointerType	pointer_type
	The definition of the pointer type. More...

	KRATOS_CLASS_POINTER_DEFINITION (DistanceSpatialContainersConfigure)
	Pointer definition of DistanceSpatialContainersConfigure. More...

Detailed Description

This class contains the tools related with the distance spatial container cell data.

The CellNodeData is defined as an internal class

Author: Pooyan Dadvand

Member Typedef Documentation

◆ cell_node_data_type

typedef CellNodeData Kratos::Internals::DistanceSpatialContainersConfigure::cell_node_data_type

Definition of the cell node data.

◆ ContainerType

typedef EntityContainerType::ContainerType Kratos::Internals::DistanceSpatialContainersConfigure::ContainerType

Definition of the container type.

◆ data_type

typedef std::vector<CellNodeData*> Kratos::Internals::DistanceSpatialContainersConfigure::data_type

Definition of the cell data type.

◆ DistanceIteratorType

typedef std::vector<double>::iterator Kratos::Internals::DistanceSpatialContainersConfigure::DistanceIteratorType

Definition of the distance iterator type.

◆ EntityContainerType

typedef PointerVectorSet<GeometricalObject, IndexedObject> Kratos::Internals::DistanceSpatialContainersConfigure::EntityContainerType

Definition of the entity container type.

◆ IndexType

typedef std::size_t Kratos::Internals::DistanceSpatialContainersConfigure::IndexType

Definition of the index type.

◆ pointer_type

typedef PointerType Kratos::Internals::DistanceSpatialContainersConfigure::pointer_type

The definition of the pointer type.

◆ PointerType

typedef ContainerType::value_type Kratos::Internals::DistanceSpatialContainersConfigure::PointerType

Defintion of the pointer type.

◆ PointType

typedef Point Kratos::Internals::DistanceSpatialContainersConfigure::PointType

Definition of the point type.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
Dimension
DIMENSION
MAX_LEVEL
MIN_LEVEL

Constructor & Destructor Documentation

◆ DistanceSpatialContainersConfigure()

Kratos::Internals::DistanceSpatialContainersConfigure::DistanceSpatialContainersConfigure ( )

inline

Default constructor.

◆ ~DistanceSpatialContainersConfigure()

virtual Kratos::Internals::DistanceSpatialContainersConfigure::~DistanceSpatialContainersConfigure ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ AllocateData()

static data_type* Kratos::Internals::DistanceSpatialContainersConfigure::AllocateData ( )

inlinestatic

This method allocates the cell data.

◆ CalculateBoundingBox()

static void Kratos::Internals::DistanceSpatialContainersConfigure::CalculateBoundingBox	(	const PointerType &	pObject,
		PointType &	rLowPoint,
		PointType &	rHighPoint
	)

inlinestatic

This method computes the bounding box of an object.

Parameters

pObject	The pointer to the object
rLowPoint	The lowest point of the box
rHighPoint	The highest point of the box

◆ CopyData()

static void Kratos::Internals::DistanceSpatialContainersConfigure::CopyData	(	data_type *	pSource,
		data_type *	pDestination
	)

inlinestatic

This method copies the data from a cell.

Parameters

pSource	The data cell to be copied
pDestination	The data cell where to copy

◆ DeleteData()

static void Kratos::Internals::DistanceSpatialContainersConfigure::DeleteData ( data_type * pData )

inlinestatic

This method deletes the data from a cell data.

Parameters

pData The data cell to be deleted

◆ GetBoundingBox()

static void Kratos::Internals::DistanceSpatialContainersConfigure::GetBoundingBox	(	const typename GeometricalObject::Pointer	pObject,
		double *	rLowPoint,
		double *	rHighPoint
	)

inlinestatic

This method computes the bounding box of an object (using C arrays)

Parameters

pObject	The pointer to the object
rLowPoint	The lowest point of the box
rHighPoint	The highest point of the box

◆ Info()

virtual std::string Kratos::Internals::DistanceSpatialContainersConfigure::Info ( ) const

inlinevirtual

Turn back information as a string.

◆ Intersection()

static bool Kratos::Internals::DistanceSpatialContainersConfigure::Intersection	(	const typename GeometricalObject::Pointer	pObj1,
		const typename GeometricalObject::Pointer	pObj2
	)

inlinestatic

This method computes if there is an intersection between two objects.

Parameters

pObj1	The pointer to the first object
pObj2	The pointer to the second object

Returns: True if there is an intersection

◆ IntersectionBox()

static bool Kratos::Internals::DistanceSpatialContainersConfigure::IntersectionBox	(	const typename GeometricalObject::Pointer	pObject,
		const PointType &	rLowPoint,
		const PointType &	rHighPoint
	)

inlinestatic

This computes the intersection between an object and a box.

Parameters

pObject	The pointer to the object
rLowPoint	The lowest point of the box
rHighPoint	The highest point of the box

Returns: True if there is an intersection

◆ IsIntersected()

static bool Kratos::Internals::DistanceSpatialContainersConfigure::IsIntersected	(	const typename GeometricalObject::Pointer	pObject,
		double	Tolerance,
		const double *	rLowPoint,
		const double *	rHighPoint
	)

inlinestatic

This method checks if the objects intersects the low and hight points provided.

Parameters

pObject	The pointer to the object of interest
Tolerance	The tolerance considered
rLowPoint	The lowest point of the box
rHighPoint	The highest point of the box

◆ KRATOS_CLASS_POINTER_DEFINITION()

Kratos::Internals::DistanceSpatialContainersConfigure::KRATOS_CLASS_POINTER_DEFINITION ( DistanceSpatialContainersConfigure )

Pointer definition of DistanceSpatialContainersConfigure.

◆ PrintData()

virtual void Kratos::Internals::DistanceSpatialContainersConfigure::PrintData ( std::ostream & rOStream ) const

inlinevirtual

Print object's data.

◆ PrintInfo()

virtual void Kratos::Internals::DistanceSpatialContainersConfigure::PrintInfo ( std::ostream & rOStream ) const

inlinevirtual

Print information about this object.

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

/home/runner/work/Documentation/Documentation/master/kratos/processes/find_intersected_geometrical_objects_process.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Type Definitions

Detailed Description

Member Typedef Documentation

◆ cell_node_data_type

◆ ContainerType

◆ data_type

◆ DistanceIteratorType

◆ EntityContainerType

◆ IndexType

◆ pointer_type

◆ PointerType

◆ PointType

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ DistanceSpatialContainersConfigure()

◆ ~DistanceSpatialContainersConfigure()

Member Function Documentation

◆ AllocateData()

◆ CalculateBoundingBox()

◆ CopyData()

◆ DeleteData()

◆ GetBoundingBox()

◆ Info()

◆ Intersection()

◆ IntersectionBox()

◆ IsIntersected()

◆ KRATOS_CLASS_POINTER_DEFINITION()

◆ PrintData()

◆ PrintInfo()