olb::Line3D< T > Struct Template Reference

Definition of a analytical line embedded in 3D space. More...

#include <line3D.h>

Collaboration diagram for olb::Line3D< T >:

Public Member Functions
	Line3D ()=default
Line3D &	originAt (const Vector< T, 3 > &origin)
	Center the line at the given origin vector.
Line3D &	centeredIn (const Cuboid3D< T > &cuboid)
	Center the line relative to the given cuboid.
Line3D &	parallelTo (const Vector< T, 3 > &direction)
	Set the direction of the line parallel to a vector.
Line3D &	normalTo (const Vector< T, 3 > &normal)
	Calculate the direction vector of the line to be orthogonal to the given normal.
bool	isParallelToX () const
bool	isParallelToY () const
bool	isParallelToZ () const

Public Attributes
Vector< T, 3 >	origin
Vector< T, 3 >	u
Vector< T, 3 >	normal

Detailed Description

template<typename T>
struct olb::Line3D< T >

Definition of a analytical line embedded in 3D space.

Line3D defines a line using its origin and a direction vector.

Definition at line 37 of file line3D.h.

Constructor & Destructor Documentation

Line3D()

template<typename T >

olb::Line3D< T >::Line3D ( )

default

Member Function Documentation

centeredIn()

template<typename T >

Line3D< T > & olb::Line3D< T >::centeredIn

(

const Cuboid3D< T > &

cuboid

)

Center the line relative to the given cuboid.

Returns

Line3D reference for further construction

Definition at line 45 of file line3D.hh.

{
  const Vector<T,3>& cuboidOrigin = cuboid.getOrigin();
  const Vector<int,3>& extend     = cuboid.getExtent();
  const T deltaR = cuboid.getDeltaR();
 
  origin[0] = (cuboidOrigin[0] + 0.5 * deltaR * extend[0]);
  origin[1] = (cuboidOrigin[1] + 0.5 * deltaR * extend[1]);
  origin[2] = (cuboidOrigin[2] + 0.5 * deltaR * extend[2]);
  origin[0] -= 2*std::numeric_limits<T>::epsilon()*util::fabs(origin[0]);
  origin[1] -= 2*std::numeric_limits<T>::epsilon()*util::fabs(origin[1]);
  origin[2] -= 2*std::numeric_limits<T>::epsilon()*util::fabs(origin[2]);
 
  return *this;
}

References olb::util::fabs(), olb::Cuboid< T, D >::getDeltaR(), olb::Cuboid< T, D >::getExtent(), and olb::Cuboid< T, D >::getOrigin().

Here is the call graph for this function:

isParallelToX()

template<typename T >

bool olb::Line3D< T >::isParallelToX

(

)

const

Returns

true iff normal is orthogonal to X axis

Definition at line 103 of file line3D.hh.

{
  return util::nearZero(util::dotProduct3D(normal, {1,0,0}));
}

References olb::util::dotProduct3D(), and olb::util::nearZero().

Here is the call graph for this function:

isParallelToY()

template<typename T >

bool olb::Line3D< T >::isParallelToY

(

)

const

Returns

true iff normal is orthogonal to Y axis

Definition at line 109 of file line3D.hh.

{
  return util::nearZero(util::dotProduct3D(normal, {0,1,0}));
}

References olb::util::dotProduct3D(), and olb::util::nearZero().

Here is the call graph for this function:

isParallelToZ()

template<typename T >

bool olb::Line3D< T >::isParallelToZ

(

)

const

Definition at line 114 of file line3D.hh.

{
  return util::nearZero(util::dotProduct3D(normal, {0,0,1}));
}

References olb::util::dotProduct3D(), and olb::util::nearZero().

Here is the call graph for this function:

normalTo()

template<typename T >

Line3D< T > & olb::Line3D< T >::normalTo

(

const Vector< T, 3 > &

normal

)

Calculate the direction vector of the line to be orthogonal to the given normal.

Returns

Line3D reference for further construction

Definition at line 75 of file line3D.hh.

{
  normal = normalize(n);
  // Check if normal is aligned with any of the axes
  if (util::nearZero(normal[0]) && util::nearZero(normal[1])) {
    // Normal is along the z-axis
    u = {T(1), T(0), T(0)};
  } else if (util::nearZero(normal[0]) && util::nearZero(normal[2])){
    // Normal is along the y-axis
    u = {T(1), T(0), T(0)};
  } else if (util::nearZero(normal[1]) && util::nearZero(normal[2])) {
    // Normal is along the x-axis
    u = {T(0), T(1), T(0)};
  } else {
    // Use cross product with a vector not parallel to the normal to find u
    Vector<T,3> arbitraryVec = (util::nearZero(normal[0]) && util::nearZero(normal[1]))
                                ? Vector<T,3>{T(1), T(0), T(0)}
                                : Vector<T,3>{T(0), T(1), T(0)};
    u = crossProduct(normal, arbitraryVec);// Calculate orthogonal vector
  }
  u = normalize(u);
  OstreamManager clout ("Test");
  clout <<"Vector"<<u <<std::endl;
  OLB_POSTCONDITION(util::nearZero(util::dotProduct3D(u, normal)));
  return *this;
}

References olb::crossProduct(), olb::util::dotProduct3D(), olb::util::nearZero(), olb::normalize(), and OLB_POSTCONDITION.

Here is the call graph for this function:

originAt()

template<typename T >

Line3D< T > & olb::Line3D< T >::originAt

(

const Vector< T, 3 > &

origin

)

Center the line at the given origin vector.

Returns

Line3D reference for further construction

Definition at line 35 of file line3D.hh.

{
  origin[0] = o[0] - 2*std::numeric_limits<T>::epsilon()*util::fabs(o[0]);
  origin[1] = o[1] - 2*std::numeric_limits<T>::epsilon()*util::fabs(o[1]);
  origin[2] = o[2] - 2*std::numeric_limits<T>::epsilon()*util::fabs(o[2]);
 
  return *this;
}

References olb::util::fabs().

Here is the call graph for this function:

parallelTo()

template<typename T >

Line3D< T > & olb::Line3D< T >::parallelTo

(

const Vector< T, 3 > &

direction

)

Set the direction of the line parallel to a vector.

Returns

Line3D reference for further construction

Definition at line 62 of file line3D.hh.

{
  u = direction;
  // help vektor which is not parallel to u
  Vector<T,3> helper = (u[0] == 0 && u[1] == 0) ? Vector<T,3>({1, 0, 0}) : Vector<T,3>({0, 0, 1});
 
  normal = normalize(crossProduct(u, helper));
 
  OLB_POSTCONDITION(util::nearZero(util::dotProduct3D(u, normal)));
  return *this;
}

References olb::crossProduct(), olb::util::dotProduct3D(), olb::util::nearZero(), olb::normalize(), and OLB_POSTCONDITION.

Here is the call graph for this function:

Member Data Documentation

normal

template<typename T >

Vector<T,3> olb::Line3D< T >::normal

Definition at line 40 of file line3D.h.

origin

template<typename T >

Vector<T,3> olb::Line3D< T >::origin

Definition at line 38 of file line3D.h.

u

template<typename T >

Vector<T,3> olb::Line3D< T >::u

Definition at line 39 of file line3D.h.

---

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

• src/utilities/line3D.h
• src/utilities/line3D.hh