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

Solid capsule about the y axis: a segment from (0,-halfLength,0) to (0,+halfLength,0) swept by radius. 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	radius = Real(0.5)
Real	halfLength = 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::Capsule< Real >

Solid capsule about the y axis: a segment from (0,-halfLength,0) to (0,+halfLength,0) swept by radius.

Exact Euclidean distance — the distance to a swept sphere is exactly the distance to its spine minus the radius, for any spine.

Definition at line 244 of file primitives.hpp.

Member Typedef Documentation

value_type

template<class Real >

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

Definition at line 245 of file primitives.hpp.

Member Function Documentation

eval()

template<class Real >

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

inline

Definition at line 250 of file primitives.hpp.

References peclet::core::geom::prim::Capsule< Real >::halfLength, peclet::core::detail::hdMax(), peclet::core::detail::hdMin(), peclet::core::detail::hdSqrt(), peclet::core::geom::prim::Capsule< Real >::radius, 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::Capsule< Real >::grad ( Vec3< Real >  p ) const

inline

Definition at line 255 of file primitives.hpp.

References peclet::core::geom::prim::Capsule< Real >::halfLength, peclet::core::detail::hdMax(), peclet::core::detail::hdMin(), peclet::core::detail::hdSqrt(), peclet::core::Vec3< Real >::x, peclet::core::Vec3< Real >::y, and peclet::core::Vec3< Real >::z.

Member Data Documentation

radius

template<class Real >

Real peclet::core::geom::prim::Capsule< Real >::radius = Real(0.5)

Definition at line 246 of file primitives.hpp.

Referenced by peclet::core::geom::prim::Capsule< Real >::eval().

halfLength

template<class Real >

Real peclet::core::geom::prim::Capsule< Real >::halfLength = Real(0.5)

Definition at line 246 of file primitives.hpp.

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

exact_distance

template<class Real >

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

staticconstexpr

Definition at line 247 of file primitives.hpp.

analytic_gradient

template<class Real >

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

staticconstexpr

Definition at line 248 of file primitives.hpp.

---

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

• primitives.hpp