peclet::core::geom::prim::HollowCylinder< Real > Struct Template Reference

Solid tube wall about the y axis: outer radius rOuter, full height height, wall thickness thickness (the solid is the shell, the bore is void). More...

#include <primitives.hpp>

Public Types
using	value_type = Real

Public Member Functions
PECLET_HD Real	eval (Vec3< Real > p) const
PECLET_HD Vec3< Real >	grad (Vec3< Real > p) const

Public Attributes
Real	rOuter = Real(1)
Real	height = Real(1)
Real	thickness = Real(0.5)

Static Public Attributes
static constexpr bool	exact_distance = true
static constexpr bool	analytic_gradient = true

Detailed Description

template<class Real>
struct peclet::core::geom::prim::HollowCylinder< Real >

Solid tube wall about the y axis: outer radius rOuter, full height height, wall thickness thickness (the solid is the shell, the bore is void).

Exact Euclidean distance — it is the 2-D box distance in the (r, y) cross-section.

Origin: dem sdfHollowCylinder (dem/src/dem_portable.hpp:83-93). NOTE the axis is y and the parameterisation is (rOuter, height, thickness) — NOT the (rOuter, rInner, height, axis) of HollowCylinderShell below. The two are different functions that shared a name across the suite; see the TRAP section of docs/ANALYTIC_SDF_GEOMETRY.md.

Definition at line 146 of file primitives.hpp.

Member Typedef Documentation

value_type

template<class Real >

using peclet::core::geom::prim::HollowCylinder< Real >::value_type = Real

Definition at line 147 of file primitives.hpp.

Member Function Documentation

eval()

template<class Real >

PECLET_HD Real peclet::core::geom::prim::HollowCylinder< Real >::eval ( Vec3< Real >  p ) const

inline

Definition at line 152 of file primitives.hpp.

References peclet::core::detail::hdAbs(), peclet::core::detail::hdMax(), peclet::core::detail::hdMin(), peclet::core::detail::hdSqrt(), peclet::core::geom::prim::HollowCylinder< Real >::height, peclet::core::geom::prim::HollowCylinder< Real >::rOuter, peclet::core::geom::prim::HollowCylinder< Real >::thickness, peclet::core::Vec3< Real >::x, peclet::core::Vec3< Real >::y, and peclet::core::Vec3< Real >::z.

grad()

template<class Real >

PECLET_HD Vec3< Real > peclet::core::geom::prim::HollowCylinder< Real >::grad ( Vec3< Real >  p ) const

inline

Definition at line 164 of file primitives.hpp.

References peclet::core::detail::hdAbs(), peclet::core::detail::hdMax(), peclet::core::detail::hdSqrt(), peclet::core::geom::prim::HollowCylinder< Real >::height, peclet::core::geom::prim::HollowCylinder< Real >::rOuter, peclet::core::geom::prim::HollowCylinder< Real >::thickness, peclet::core::Vec3< Real >::x, peclet::core::Vec3< Real >::y, and peclet::core::Vec3< Real >::z.

Member Data Documentation

rOuter

template<class Real >

Real peclet::core::geom::prim::HollowCylinder< Real >::rOuter = Real(1)

Definition at line 148 of file primitives.hpp.

Referenced by peclet::core::geom::prim::HollowCylinder< Real >::eval(), and peclet::core::geom::prim::HollowCylinder< Real >::grad().

height

template<class Real >

Real peclet::core::geom::prim::HollowCylinder< Real >::height = Real(1)

Definition at line 148 of file primitives.hpp.

Referenced by peclet::core::geom::prim::HollowCylinder< Real >::eval(), and peclet::core::geom::prim::HollowCylinder< Real >::grad().

thickness

template<class Real >

Real peclet::core::geom::prim::HollowCylinder< Real >::thickness = Real(0.5)

Definition at line 148 of file primitives.hpp.

Referenced by peclet::core::geom::prim::HollowCylinder< Real >::eval(), and peclet::core::geom::prim::HollowCylinder< Real >::grad().

exact_distance

template<class Real >

constexpr bool peclet::core::geom::prim::HollowCylinder< Real >::exact_distance = true

staticconstexpr

Definition at line 149 of file primitives.hpp.

analytic_gradient

template<class Real >

constexpr bool peclet::core::geom::prim::HollowCylinder< Real >::analytic_gradient = true

staticconstexpr

Definition at line 150 of file primitives.hpp.

---

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

• primitives.hpp