Public Member Functions | Private Member Functions | Private Attributes | List of all members
walberla::geometry::Torus Class Reference

Detailed Description

Class representing a Torus.

Implements body concept, i.e. a fastOverlapCheck and a contains() function, which can be used to initialize fields. For details about the body concept see BodyOverlapFunctions.h

#include <Torus.h>

Public Member Functions

 Torus (const Vector3< real_t > &_midPnt, const Vector3< real_t > &_normal, real_t _radius, real_t _distance)
 
void setMidPoint (const Vector3< real_t > &_midPnt)
 
void setMidPoint (real_t newVal, uint_t coord)
 
void setNormal (const Vector3< real_t > &_normal)
 
void setNormal (real_t newVal, uint_t coord)
 
void setRadius (const real_t value)
 
void setDistance (const real_t value)
 
const Vector3< real_t > & normal () const
 
const Vector3< real_t > & defTan () const
 
const Vector3< real_t > & comTan () const
 
const Vector3< real_t > & midPnt () const
 
real_t radius () const
 
real_t distance () const
 
const AABB & boundingBox () const
 

Private Member Functions

void update ()
 Recalculates boundingBox_ and dir_. More...
 

Private Attributes

Vector3< real_t > midPnt_
 
Vector3< real_t > normal_
 
real_t radius_
 
real_t distnc_
 
Vector3< real_t > defTan_
 
Vector3< real_t > comTan_
 
AABB boundingBox_
 

Constructor & Destructor Documentation

◆ Torus()

walberla::geometry::Torus::Torus ( const Vector3< real_t > &  _midPnt,
const Vector3< real_t > &  _normal,
real_t  _radius,
real_t  _distance 
)
explicit

Member Function Documentation

◆ boundingBox()

const AABB& walberla::geometry::Torus::boundingBox ( ) const
inline

◆ comTan()

const Vector3<real_t>& walberla::geometry::Torus::comTan ( ) const
inline

◆ defTan()

const Vector3<real_t>& walberla::geometry::Torus::defTan ( ) const
inline

◆ distance()

real_t walberla::geometry::Torus::distance ( ) const
inline

◆ midPnt()

const Vector3<real_t>& walberla::geometry::Torus::midPnt ( ) const
inline

◆ normal()

const Vector3<real_t>& walberla::geometry::Torus::normal ( ) const
inline

◆ radius()

real_t walberla::geometry::Torus::radius ( ) const
inline

◆ setDistance()

void walberla::geometry::Torus::setDistance ( const real_t  value)
inline

◆ setMidPoint() [1/2]

void walberla::geometry::Torus::setMidPoint ( const Vector3< real_t > &  _midPnt)
inline

◆ setMidPoint() [2/2]

void walberla::geometry::Torus::setMidPoint ( real_t  newVal,
uint_t  coord 
)
inline

◆ setNormal() [1/2]

void walberla::geometry::Torus::setNormal ( const Vector3< real_t > &  _normal)
inline

◆ setNormal() [2/2]

void walberla::geometry::Torus::setNormal ( real_t  newVal,
uint_t  coord 
)
inline

◆ setRadius()

void walberla::geometry::Torus::setRadius ( const real_t  value)
inline

◆ update()

void walberla::geometry::Torus::update ( )
private

Recalculates boundingBox_ and dir_.

Member Data Documentation

◆ boundingBox_

AABB walberla::geometry::Torus::boundingBox_
private

◆ comTan_

Vector3<real_t> walberla::geometry::Torus::comTan_
private

◆ defTan_

Vector3<real_t> walberla::geometry::Torus::defTan_
private

◆ distnc_

real_t walberla::geometry::Torus::distnc_
private

◆ midPnt_

Vector3<real_t> walberla::geometry::Torus::midPnt_
private

◆ normal_

Vector3<real_t> walberla::geometry::Torus::normal_
private

◆ radius_

real_t walberla::geometry::Torus::radius_
private
The documentation for this class was generated from the following files: