SpECTRE  v2024.06.05
domain::BoundaryConditions::Periodic< SystemBoundaryConditionBaseClass > Struct Template Referencefinal

Periodic boundary conditions. More...

#include <Periodic.hpp>

Public Types

using options = tmpl::list<>

Public Member Functions

 Periodic (Periodic &&)=default
Periodicoperator= (Periodic &&)=default
 Periodic (const Periodic &)=default
Periodicoperator= (const Periodic &)=default
 Periodic (CkMigrateMessage *msg)
 WRAPPED_PUPable_decl_base_template (domain::BoundaryConditions::BoundaryCondition, Periodic)
auto get_clone () const -> std::unique_ptr< domain::BoundaryConditions::BoundaryCondition > override
void pup (PUP::er &p) override
- Public Member Functions inherited from domain::BoundaryConditions::MarkAsPeriodic
 MarkAsPeriodic (MarkAsPeriodic &&)=default
MarkAsPeriodicoperator= (MarkAsPeriodic &&)=default
 MarkAsPeriodic (const MarkAsPeriodic &)=default
MarkAsPeriodicoperator= (const MarkAsPeriodic &)=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::Periodic< SystemBoundaryConditionBaseClass >

Periodic boundary conditions.

To use with a specific system add:

to the list of creatable classes.

Not all domain creators will allow you to specify periodic boundary conditions since they may not make sense.

Member Data Documentation

◆ help

template<typename SystemBoundaryConditionBaseClass >
constexpr Options::String domain::BoundaryConditions::Periodic< SystemBoundaryConditionBaseClass >::help
Initial value:
"Periodic boundary conditions.\n\nNote: Not all domain creators will "
"allow you to specify periodic boundary conditions since they may not "
"make sense."}

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