SpECTRE  v2021.12.06
domain::creators::BinaryCompactObject::Object Struct Reference

Options for one of the two objects in the binary domain. More...

#include <BinaryCompactObject.hpp>

Classes

struct  ExciseInterior
 
struct  InnerRadius
 
struct  Interior
 
struct  OuterRadius
 
struct  UseLogarithmicMap
 
struct  XCoord
 

Public Types

template<typename Metavariables >
using options = tmpl::list< InnerRadius, OuterRadius, XCoord, tmpl::conditional_t< domain::BoundaryConditions::has_boundary_conditions_base_v< typename Metavariables::system >, Interior, ExciseInterior >, UseLogarithmicMap >
 

Public Member Functions

 Object (double local_inner_radius, double local_outer_radius, double local_x_coord, std::optional< Excision > interior, bool local_use_logarithmic_map)
 
 Object (double local_inner_radius, double local_outer_radius, double local_x_coord, bool local_excise_interior, bool local_use_logarithmic_map)
 
bool is_excised () const
 Whether or not the object should be excised from the domain, leaving a spherical hole. When this is true, inner_boundary_condition is guaranteed to hold a value (though it might be a nullptr if we are not working with boundary conditions).
 

Public Attributes

double inner_radius
 
double outer_radius
 
double x_coord
 
std::optional< std::unique_ptr< domain::BoundaryConditions::BoundaryCondition > > inner_boundary_condition
 
bool use_logarithmic_map
 

Static Public Attributes

static constexpr Options::String help
 

Detailed Description

Options for one of the two objects in the binary domain.

Member Data Documentation

◆ help

constexpr Options::String domain::creators::BinaryCompactObject::Object::help
staticconstexpr
Initial value:
= {
"Options for an object in a binary domain."}

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