Kratos::Plane3D Class Reference

#include <plane_3d.h>

Collaboration diagram for Kratos::Plane3D:

Public Member Functions
Type Definitions
	KRATOS_CLASS_POINTER_DEFINITION (Plane3D)
	Pointer definition of Point2D. More...
Life Cycle
	Plane3D ()=delete
	Plane3D (array_1d< double, 3 > const &rNormal, double DistanceToOrigin)
	Plane3D (array_1d< double, 3 > const &rNormal, const Point &rReferencePoint)
	Plane3D (const Point &Point1, const Point &Point2, const Point &Point3)
	~Plane3D ()
	Destructor. Do nothing!!! More...
Operations
array_1d< double, 3 > const &	GetNormal ()
double	GetDistanceToOrigin ()
double	CalculateSignedDistance (Point const &rPoint)
std::string	Info () const
void	PrintInfo (std::ostream &rOStream) const
void	PrintData (std::ostream &rOStream) const

Constructor & Destructor Documentation

Plane3D() [1/4]

Kratos::Plane3D::Plane3D ( )

delete

Plane3D() [2/4]

Kratos::Plane3D::Plane3D ( array_1d< double, 3 > const &  rNormal, double  DistanceToOrigin  )

inline

Plane3D() [3/4]

Kratos::Plane3D::Plane3D ( array_1d< double, 3 > const &  rNormal, const Point &  rReferencePoint  )

inline

Plane3D() [4/4]

Kratos::Plane3D::Plane3D ( const Point &  Point1, const Point &  Point2, const Point &  Point3  )

inline

~Plane3D()

Kratos::Plane3D::~Plane3D ( )

inline

Destructor. Do nothing!!!

Member Function Documentation

CalculateSignedDistance()

double Kratos::Plane3D::CalculateSignedDistance ( Point const &  rPoint )

inline

Calculates the plane signed distance value

Returns

Plane signed distance value

GetDistanceToOrigin()

double Kratos::Plane3D::GetDistanceToOrigin ( )

inline

Return the plane distance value

Returns

Plane distance value

GetNormal()

array_1d<double,3> const& Kratos::Plane3D::GetNormal ( )

inline

Return the plane normal vector

Returns

Array containing the plane normal

Info()

std::string Kratos::Plane3D::Info ( ) const

inline

Turn back information as a string.

Returns

String contains information about this geometry.

See also

PrintData()

PrintInfo()

KRATOS_CLASS_POINTER_DEFINITION()

Kratos::Plane3D::KRATOS_CLASS_POINTER_DEFINITION

(

Plane3D

)

Pointer definition of Point2D.

PrintData()

void Kratos::Plane3D::PrintData ( std::ostream &  rOStream ) const

inline

Print geometry's data into given stream. Prints it's points by the order they stored in the geometry and then center point of geometry.

Parameters

rOStream

Stream to print into it.

See also

PrintInfo()

Info()

PrintInfo()

void Kratos::Plane3D::PrintInfo ( std::ostream &  rOStream ) const

inline

Print information about this object.

Parameters

rOStream

Stream to print into it.

See also

PrintData()

Info()

---

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

• /home/runner/work/Documentation/Documentation/master/kratos/geometries/plane_3d.h