stator::geometry::HalfSpace< Scalar, D > Class Template Reference

A planar half-space (a plane and the volume on one side of the plane). More...

#include <plane.hpp>

Public Member Functions
	HalfSpace (const Vector< Scalar, D > &center, const Vector< Scalar, D > &normal)
const Vector< Scalar, D > &	center () const
const Vector< Scalar, D > &	normal () const

Protected Attributes
Vector< Scalar, D >	center_
Vector< Scalar, D >	normal_

Detailed Description

template<typename Scalar, size_t D>
class stator::geometry::HalfSpace< Scalar, D >

A half-space represents the volume on one side of a infinite planar surface. A plane is defined through a normal and a point on the plane (origin), and (by definition) the normal points away from the represented volume.

Template Parameters

Scalar	The scalar type used for computation of properties of the object.
D	The dimensionality of the HalfSpace.

Definition at line 41 of file plane.hpp.

Constructor & Destructor Documentation

HalfSpace()

template<typename Scalar , size_t D>

stator::geometry::HalfSpace< Scalar, D >::HalfSpace ( const Vector< Scalar, D > &  center, const Vector< Scalar, D > &  normal  )

inline

Definition at line 43 of file plane.hpp.

Member Function Documentation

center()

template<typename Scalar , size_t D>

const Vector<Scalar, D>& stator::geometry::HalfSpace< Scalar, D >::center ( ) const

inline

Definition at line 47 of file plane.hpp.

normal()

template<typename Scalar , size_t D>

const Vector<Scalar, D>& stator::geometry::HalfSpace< Scalar, D >::normal ( ) const

inline

Definition at line 48 of file plane.hpp.

Member Data Documentation

center_

template<typename Scalar , size_t D>

Vector<Scalar, D> stator::geometry::HalfSpace< Scalar, D >::center_

protected

Definition at line 51 of file plane.hpp.

normal_

template<typename Scalar , size_t D>

Vector<Scalar, D> stator::geometry::HalfSpace< Scalar, D >::normal_

protected

Definition at line 52 of file plane.hpp.

---

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

• /home/mjki2mb2/stator/stator/geometry/plane.hpp