SpECTRE  v2025.03.17
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
Classes | Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
intrp::OptionHolders::LineSegment< VolumeDim > Struct Template Reference

A line segment extending from Begin to End, containing NumberOfPoints uniformly-spaced points including the endpoints. More...

#include <LineSegment.hpp>

Classes

struct  Begin
 
struct  End
 
struct  NumberOfPoints
 

Public Types

using options = implementation defined
 

Public Member Functions

 LineSegment (std::array< double, VolumeDim > begin_in, std::array< double, VolumeDim > end_in, size_t number_of_points_in)
 
void pup (PUP::er &p)
 

Public Attributes

std::array< double, VolumeDim > begin {}
 
std::array< double, VolumeDim > end {}
 
size_t number_of_points {}
 

Static Public Attributes

static constexpr Options::String help
 

Detailed Description

template<size_t VolumeDim>
struct intrp::OptionHolders::LineSegment< VolumeDim >

A line segment extending from Begin to End, containing NumberOfPoints uniformly-spaced points including the endpoints.

Note
Input coordinates are interpreted in Frame::Inertial

Member Data Documentation

◆ help

template<size_t VolumeDim>
constexpr Options::String intrp::OptionHolders::LineSegment< VolumeDim >::help
staticconstexpr
Initial value:
= {
"A line segment extending from Begin to End, containing NumberOfPoints"
" uniformly-spaced points including the endpoints."}
The documentation for this struct was generated from the following file: