SpECTRE  v2025.08.19
TimeSteppers::BoundaryHistory< LocalData, RemoteData, UntypedCouplingResult > Class Template Reference

History data used by a TimeStepper for boundary integration. More...

#include <BoundaryHistory.hpp>

Classes

class  ConstSideAccess
 
class  MutableSideAccess
 
class  SideAccessCommon
 

Public Member Functions

 BoundaryHistory (const BoundaryHistory &other)=default
 
 BoundaryHistory (BoundaryHistory &&)=default
 
BoundaryHistoryoperator= (const BoundaryHistory &other)=default
 
BoundaryHistoryoperator= (BoundaryHistory &&)=default
 
MutableSideAccess< true > local ()
 
ConstSideAccess< true > local () const
 
MutableSideAccess< false > remote ()
 
ConstSideAccess< false > remote () const
 
template<typename Coupling >
auto evaluator (Coupling &&coupling) const
 Obtain an object that can evaluate type-erased boundary couplings. More...
 
void clear_coupling_cache ()
 Clear the cached values. More...
 
void pup (PUP::er &p)
 
template<bool IncludeData>
std::ostreamprint (std::ostream &os, size_t padding_size=0) const
 

Detailed Description

template<typename LocalData, typename RemoteData, typename UntypedCouplingResult>
class TimeSteppers::BoundaryHistory< LocalData, RemoteData, UntypedCouplingResult >

History data used by a TimeStepper for boundary integration.

Template Parameters
LocalDatalocal data passed to the boundary coupling
RemoteDataremote data passed to the boundary coupling
UntypedCouplingResultmath_wrapper_type of cached boundary couplings

Member Function Documentation

◆ clear_coupling_cache()

template<typename LocalData , typename RemoteData , typename UntypedCouplingResult >
void TimeSteppers::BoundaryHistory< LocalData, RemoteData, UntypedCouplingResult >::clear_coupling_cache ( )

Clear the cached values.

This is required after existing history entries that have been used in coupling calculations are mutated.

◆ evaluator()

template<typename LocalData , typename RemoteData , typename UntypedCouplingResult >
template<typename Coupling >
auto TimeSteppers::BoundaryHistory< LocalData, RemoteData, UntypedCouplingResult >::evaluator ( Coupling &&  coupling) const
inline

Obtain an object that can evaluate type-erased boundary couplings.

The passed functor must take objects of types LocalData and RemoteData and return an object with math_wrapper_type UntypedCouplingResult. Results are cached, so different calls to this function should pass equivalent couplings.


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