SpECTRE  v2025.08.19
evolution::dg::InboxBoundaryData< Dim > Struct Template Reference

Class wrapping a map and mirroring the AtomicInboxBoundaryData interface so that code accessing the inbox doesn't need to care which implementation is in use. More...

#include <InboxBoundaryData.hpp>

Public Types

using mapped_type = DirectionalIdMap< Dim, evolution::dg::BoundaryData< Dim > >
 

Public Member Functions

bool empty () const
 
void collect_messages ()
 In AtomicInboxBoundaryData, this moves elements from the threadsafe structure to the messages field. This class stores messages in the messages field directly, so this method just zeros the missing message count.
 
bool set_missing_messages (size_t count)
 Set a lower bound on the number of messages required for the algorithm to make progress since the most recent call to collect_messages. After that number of new messages have been received, BoundaryCorrectionAndGhostCellsInbox will restart the algorithm. More...
 
void pup (PUP::er &p)
 

Public Attributes

std::map< TimeStepId, mapped_typemessages
 
int missing_messages = 0
 Number of messages needed to restart the algorithm. This should be decremented whenever a new message is added to the inbox.
 

Detailed Description

template<size_t Dim>
struct evolution::dg::InboxBoundaryData< Dim >

Class wrapping a map and mirroring the AtomicInboxBoundaryData interface so that code accessing the inbox doesn't need to care which implementation is in use.

Member Function Documentation

◆ set_missing_messages()

template<size_t Dim>
bool evolution::dg::InboxBoundaryData< Dim >::set_missing_messages ( size_t  count)

Set a lower bound on the number of messages required for the algorithm to make progress since the most recent call to collect_messages. After that number of new messages have been received, BoundaryCorrectionAndGhostCellsInbox will restart the algorithm.

Returns: whether enough messages have been received.


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