SpECTRE  v2026.04.01
Loading...
Searching...
No Matches
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

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.
void pup (PUP::er &p)

Public Attributes

std::map< TimeStepId, mapped_type > messages
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 Typedef Documentation

◆ mapped_type

template<size_t Dim>
using evolution::dg::InboxBoundaryData< Dim >::mapped_type
Initial value:
boost::container::small_vector<
constexpr size_t maximum_number_of_neighbors(const size_t dim)
Returns the maximum number of neighbors an element can have in dim dimensions.
Definition MaxNumberOfNeighbors.hpp:15
The data communicated between neighber elements.
Definition BoundaryData.hpp:39

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:
  • src/Evolution/DiscontinuousGalerkin/InboxBoundaryData.hpp