Plane Struct Reference

Structure to define a plane (by a point and a normal) and check position of a mesh entity with respect to it. More...

#include <BoundaryConditions.hpp>

Collaboration diagram for Plane:

Public Member Functions
	Plane (const VectorRd &point, const VectorRd &normal)
	Constructor.
bool	is_in (const VectorRd &x) const
	Check if a point is inside the plane.
bool	is_in (const Vertex &V) const
	Check if a vertex is inside the plane.
template<typename MeshEntity >
bool	is_in (const MeshEntity &E) const
	Check if a mesh entity is inside the plane.
bool	is_on_side (const VectorRd &x, const double &side) const
	Check if a point is on one side of the plane (side=+/-1 depending on the normal to the plane)
bool	is_on_side (const Vertex &V, const double &side) const
	Check if a vertex is on one side of the plane (side=+/-1 depending on the normal to the plane)
template<typename MeshEntity >
bool	is_on_side (const MeshEntity &E, const double &side) const
	Check if a mesh entity is on one side of the plane (side=+/-1 depending on the normal to the plane)

Public Attributes
VectorRd	point
	One point on the plane.
VectorRd	normal
	Normal to the plane.

Detailed Description

Structure to define a plane (by a point and a normal) and check position of a mesh entity with respect to it.

Constructor & Destructor Documentation

Plane()

Plane::Plane ( const VectorRd &  point, const VectorRd &  normal  )

inline

Constructor.

Member Function Documentation

is_in() [1/3]

template<typename MeshEntity >

bool Plane::is_in ( const MeshEntity &  E ) const

inline

Check if a mesh entity is inside the plane.

is_in() [2/3]

bool Plane::is_in

(

const VectorRd &

x

)

const

Check if a point is inside the plane.

is_in() [3/3]

bool Plane::is_in ( const Vertex &  V ) const

inline

Check if a vertex is inside the plane.

is_on_side() [1/3]

template<typename MeshEntity >

bool Plane::is_on_side ( const MeshEntity &  E, const double &  side  ) const

inline

Check if a mesh entity is on one side of the plane (side=+/-1 depending on the normal to the plane)

is_on_side() [2/3]

bool Plane::is_on_side	(	const VectorRd &	x,
		const double &	side
	)		const

Check if a point is on one side of the plane (side=+/-1 depending on the normal to the plane)

is_on_side() [3/3]

bool Plane::is_on_side ( const Vertex &  V, const double &  side  ) const

inline

Check if a vertex is on one side of the plane (side=+/-1 depending on the normal to the plane)

Member Data Documentation

normal

VectorRd Plane::normal

Normal to the plane.

point

VectorRd Plane::point

One point on the plane.

---

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

• Schemes/BoundaryConditions/BoundaryConditions.hpp
• Schemes/BoundaryConditions/BoundaryConditions.cpp