domain::creators::BinaryNeutronStars::XAxisPoints Struct Reference

Grid \(x\)-coordinates of the ends of the cubed cylinders and the centers of the objects. More...

#include <BinaryNeutronStars.hpp>

Public Types
using	type = std::array<double, 4>

Static Public Attributes
static constexpr Options::String	help

Detailed Description

Grid \(x\)-coordinates of the ends of the cubed cylinders and the centers of the objects.

Given in ascending order as [ \(x_{\rm left}\), \(x_B\), \(x_A\), \(x_{\rm right}\)], where \(x_{\rm left}\) and \(x_{\rm right}\) are the left and right faces of the cubed cylinders and \(x_B\) and \(x_A\) are the centers of Objects B and A. Must satisfy \(x_{\rm left} < x_B < 0 < x_A < x_{\rm right}\).

Member Data Documentation

help

Options::String domain::creators::BinaryNeutronStars::XAxisPoints::help

staticconstexpr

Initial value:

= {
        "Grid x-coordinates [LeftEnd, CenterB, CenterA, RightEnd] in ascending "
        "order: the left face of the cubed cylinders, the centers of Objects B "
        "and A, and the right face of the cubed cylinders. Must satisfy "
        "LeftEnd < CenterB < 0 < CenterA < RightEnd."}

---

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

• src/Domain/Creators/BinaryNeutronStars.hpp