SpECTRE  v2026.04.01
Loading...
Searching...
No Matches
domain::creators::BinaryCompactObject< UseWorldtube >::Excision Struct Reference

Options for an excision region in the domain. More...

#include <BinaryCompactObject.hpp>

Classes

struct  BoundaryCondition

Public Types

template<typename Metavariables>
using options

Public Member Functions

 Excision (std::unique_ptr< domain::BoundaryConditions::BoundaryCondition > boundary_condition_in)

Public Attributes

std::unique_ptr< domain::BoundaryConditions::BoundaryConditionboundary_condition

Static Public Attributes

static constexpr Options::String help

Detailed Description

template<bool UseWorldtube = false>
struct domain::creators::BinaryCompactObject< UseWorldtube >::Excision

Options for an excision region in the domain.

Member Typedef Documentation

◆ options

template<bool UseWorldtube = false>
template<typename Metavariables>
using domain::creators::BinaryCompactObject< UseWorldtube >::Excision::options
Initial value:
tmpl::list<BoundaryCondition<
typename Metavariables::system>>>
typename detail::get_boundary_conditions_base< T >::type get_boundary_conditions_base
Returns T::boundary_condition_base or a placeholder class.
Definition GetBoundaryConditionsBase.hpp:32
Boundary condition to impose on outer side.
Definition AngularDisk.hpp:102

Member Data Documentation

◆ help

template<bool UseWorldtube = false>
Options::String domain::creators::BinaryCompactObject< UseWorldtube >::Excision::help
staticconstexpr
Initial value:
= {
"Excise the interior of the object, leaving a spherical hole in its "
"absence."}

The documentation for this struct was generated from the following file:
  • src/Domain/Creators/BinaryCompactObject.hpp