Celeritas 0.7+c5d231878
Loading...
Searching...
No Matches
List of all members
celeritas::PlaneAligned< T > Class Template Reference

Axis-aligned plane with positive-facing normal. More...

#include <PlaneAligned.hh>

Type aliases

using Intersections = Array< real_type, 1 >
 Intersection with the axis.
 
using StorageSpan = Span< real_type const, 1 >
 Intersection with the axis.
 
static constexpr SurfaceType surface_type ()
 Surface type identifier.
 
static constexpr bool simple_safety ()
 Safety is intersection along surface normal.
 
 PlaneAligned (real_type position)
 Construct from axis intercept.
 
template<class R >
 PlaneAligned (Span< R, StorageSpan::extent >)
 Construct from raw data.
 
constexpr real_type position () const
 Distance from the origin along the normal to the plane (deprecated)
 
constexpr real_type displacement () const
 Distance from the origin along the normal to the plane.
 
StorageSpan data () const
 Get a view to the data for type-deleted storage.
 
Real3 calc_normal () const
 Calculate outward normal.
 
real_type dot_normal (Real3 const &pos) const
 Get the dot product with the normal.
 
SignedSense calc_sense (Real3 const &pos) const
 Determine the sense of the position relative to this surface.
 
Intersections calc_intersections (Real3 const &pos, Real3 const &dir, SurfaceState on_surface) const
 Calculate all possible straight-line intersections with this surface.
 
Real3 calc_normal (Real3 const &pos) const
 Calculate outward normal at a position on the surface.
 

Detailed Description

template<Axis T>
class celeritas::PlaneAligned< T >

Axis-aligned plane with positive-facing normal.

Member Function Documentation

◆ dot_normal()

template<Axis T>
real_type celeritas::PlaneAligned< T >::dot_normal ( Real3 const x) const
inline

Get the dot product with the normal.

This is used for intersection, sense, and combined-plane methods.


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