Celeritas 0.7+1fb77992f
Loading...
Searching...
No Matches
Public Member Functions | List of all members
celeritas::orangeinp::Torus Class Referencefinal

A torus centered around the origin, defined by two radii. More...

#include <IntersectRegion.hh>

Inheritance diagram for celeritas::orangeinp::Torus:
Inheritance graph
[legend]

Public Member Functions

 Torus (real_type major_radius, real_type minor_radius)
 
void build (IntersectSurfaceBuilder &) const final
 Build surfaces.
 
void output (JsonPimpl *) const final
 Write output to the given JSON object.
 
bool encloses (Torus const &other) const
 Returns whether this centered torus encloses another such torus.
 
real_type major_radius () const
 Major radius (from the origin to the revolved circle)
 
real_type minor_radius () const
 Minor radius (of the revolved circle)
 

Additional Inherited Members

- Protected Member Functions inherited from celeritas::orangeinp::IntersectRegionInterface
 IntersectRegionInterface (IntersectRegionInterface const &)=default
 
IntersectRegionInterfaceoperator= (IntersectRegionInterface const &)=default
 
 IntersectRegionInterface (IntersectRegionInterface &&)=default
 
IntersectRegionInterfaceoperator= (IntersectRegionInterface &&)=default
 

Detailed Description

A torus centered around the origin, defined by two radii.

The major radius extends from the origin to the center of the revolved circle, and the minor radius is that of the revolved circle.

Uses a special case of the Toroid surface, with equal ellipse radii.

Member Function Documentation

◆ build()

void celeritas::orangeinp::Torus::build ( IntersectSurfaceBuilder insert_surface) const
finalvirtual

◆ output()

void celeritas::orangeinp::Torus::output ( JsonPimpl j) const
finalvirtual

Write output to the given JSON object.

Implements celeritas::orangeinp::IntersectRegionInterface.


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