Kratos::BruteForcePointLocator Class Reference

Utility class to find an entity of a mesh based on a location. More...

#include <brute_force_point_locator.h>

Collaboration diagram for Kratos::BruteForcePointLocator:

Public Member Functions
Type Definitions
	KRATOS_CLASS_POINTER_DEFINITION (BruteForcePointLocator)
	Pointer definition of BruteForcePointLocator. More...
Life Cycle
	BruteForcePointLocator (ModelPart &rModelPart)
	Default constructor. More...
virtual	~BruteForcePointLocator ()=default
	Destructor. More...
Operations
int	FindNode (const Point &rThePoint, const Globals::Configuration configuration=Globals::Configuration::Initial, const double DistanceThreshold=1e-6) const
	This function finds a node based on a location. More...
int	FindElement (const Point &rThePoint, Vector &rShapeFunctionValues, const Globals::Configuration configuration=Globals::Configuration::Initial, const double LocalCoordTol=1e-6) const
	This function finds an element based on a location. More...
int	FindCondition (const Point &rThePoint, Vector &rShapeFunctionValues, const Globals::Configuration configuration=Globals::Configuration::Initial, const double LocalCoordTol=1e-6) const
	This function finds a condition based on a location. 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...

Detailed Description

Utility class to find an entity of a mesh based on a location.

Based on the location of a point, the corresponding entity (node, element or condition) in a mesh is found and it's id is returned

Author

Philipp Bucher

Constructor & Destructor Documentation

BruteForcePointLocator()

Kratos::BruteForcePointLocator::BruteForcePointLocator ( ModelPart &  rModelPart )

inlineexplicit

Default constructor.

~BruteForcePointLocator()

virtual Kratos::BruteForcePointLocator::~BruteForcePointLocator ( )

virtualdefault

Destructor.

Member Function Documentation

FindCondition()

int Kratos::BruteForcePointLocator::FindCondition	(	const Point &	rThePoint,
		Vector &	rShapeFunctionValues,
		const Globals::Configuration	configuration = Globals::Configuration::Initial,
		const double	LocalCoordTol = 1e-6
	)		const

This function finds a condition based on a location.

Parameters

rThePoint	the location to search
rShapeFunctionValues	vector containing the shape-function values for the given point
configuration	search the Initial or Current configuration
LocalCoordTol	tolerance local-coordinates for IsInside

Returns

Id of the found condition. -1 if no condition was found

FindElement()

int Kratos::BruteForcePointLocator::FindElement	(	const Point &	rThePoint,
		Vector &	rShapeFunctionValues,
		const Globals::Configuration	configuration = Globals::Configuration::Initial,
		const double	LocalCoordTol = 1e-6
	)		const

This function finds an element based on a location.

Parameters

rThePoint	the location to search
rShapeFunctionValues	vector containing the shape-function values for the given point
configuration	search the Initial or Current configuration
LocalCoordTol	tolerance local-coordinates for IsInside

Returns

Id of the found element. -1 if no element was found

FindNode()

int Kratos::BruteForcePointLocator::FindNode	(	const Point &	rThePoint,
		const Globals::Configuration	configuration = Globals::Configuration::Initial,
		const double	DistanceThreshold = 1e-6
	)		const

This function finds a node based on a location.

Parameters

rThePoint	the location to search
configuration	search the Initial or Current configuration
DistanceThreshold	threshold for the distance

Returns

Id of the found node. -1 if no node was found

Info()

virtual std::string Kratos::BruteForcePointLocator::Info ( ) const

inlinevirtual

Turn back information as a string.

KRATOS_CLASS_POINTER_DEFINITION()

Kratos::BruteForcePointLocator::KRATOS_CLASS_POINTER_DEFINITION

(

BruteForcePointLocator

)

Pointer definition of BruteForcePointLocator.

PrintData()

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

inlinevirtual

Print object's data.

PrintInfo()

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

inlinevirtual

Print information about this object.

---

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

• /home/runner/work/Documentation/Documentation/master/kratos/utilities/brute_force_point_locator.h
• /home/runner/work/Documentation/Documentation/master/kratos/utilities/brute_force_point_locator.cpp