domain::creators::CylindricalBinaryCompactObject::InitialGridPoints Struct Reference

Public Types
using	type

Static Public Attributes
static constexpr Options::String	help

Member Typedef Documentation

type

using domain::creators::CylindricalBinaryCompactObject::InitialGridPoints::type

Initial value:

 std::variant<
        size_t, std::array<size_t, 3>, std::vector<std::array<size_t, 3>>,
        std::unordered_map<std::string, std::array<size_t, 3>>,
        std::unordered_map<std::string, std::variant<std::array<size_t, 3>,
                                                     std::array<size_t, 2>>>>

Member Data Documentation

help

Options::String domain::creators::CylindricalBinaryCompactObject::InitialGridPoints::help

staticconstexpr

Initial value:

= {
        "Initial number of grid points. Specify one of: a single number, a "
        "list representing [r, theta, perp], or such a list for every block in "
        "the domain. Here 'r' is the radial direction normal to the inner and "
        "outer boundaries, 'theta' is the periodic direction, and 'perp' is "
        "the third direction. The exception to this is that for spherical "
        "shell blocks groups ('InnerSphereA', 'InnerSphereB', 'OuterSphere'),"
        "you must instead specify grid points as [r, L_max]. The exception to "
        "this is if a single number is specified for global initial grid "
        "points."}

---

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

• src/Domain/Creators/CylindricalBinaryCompactObject.hpp