SpECTRE  v2026.04.01
Loading...
Searching...
No Matches
domain::BoundaryConditions::Cartoon< SystemBoundaryConditionBaseClass > Struct Template Referencefinal

Cartoon boundary conditions, to be used as the default placeholder in systems without Subcell. More...

#include <Cartoon.hpp>

Public Types

using options = tmpl::list<>

Public Member Functions

 Cartoon (Cartoon &&)=default
Cartoonoperator= (Cartoon &&)=default
 Cartoon (const Cartoon &)=default
Cartoonoperator= (const Cartoon &)=default
 Cartoon (CkMigrateMessage *msg)
 WRAPPED_PUPable_decl_base_template (domain::BoundaryConditions::BoundaryCondition, Cartoon)
auto get_clone () const -> std::unique_ptr< domain::BoundaryConditions::BoundaryCondition > override
void pup (PUP::er &p) override
Public Member Functions inherited from domain::BoundaryConditions::MarkAsCartoon
 MarkAsCartoon (MarkAsCartoon &&)=default
MarkAsCartoonoperator= (MarkAsCartoon &&)=default
 MarkAsCartoon (const MarkAsCartoon &)=default
MarkAsCartoonoperator= (const MarkAsCartoon &)=default

Static Public Member Functions

static std::string name ()

Static Public Attributes

static constexpr Options::String help

Detailed Description

template<typename SystemBoundaryConditionBaseClass>
struct domain::BoundaryConditions::Cartoon< SystemBoundaryConditionBaseClass >

Cartoon boundary conditions, to be used as the default placeholder in systems without Subcell.

To use with a specific system, add:

Cartoon boundary conditions, to be used as the default placeholder in systems without Subcell.
Definition Cartoon.hpp:55

to the list of creatable classes.

Note: Cartoon boundary conditions should only be specified with systems set-up to use the cartoon method. It should not be used as an external boundary.

Member Data Documentation

◆ help

template<typename SystemBoundaryConditionBaseClass>
Options::String domain::BoundaryConditions::Cartoon< SystemBoundaryConditionBaseClass >::help
staticconstexpr
Initial value:
{
"Cartoon boundary condition, to be used in systems that do not implement "
"Subcell.\n\nNote: This should never be used as an external boundary, it "
"is only used on specific cartoon-system boundaries that are "
"automatically handled in the domain creators."}

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