peano4::SplitInstruction Struct Reference

Instruction to split. More...

#include <grid.h>

Public Types
enum class	Mode { AggressiveTopDown , BottomUp }

Public Member Functions
std::string	toString () const

Static Public Member Functions
static std::string	toString (Mode mode)

Data Fields
int	numberOfFineGridCells
Mode	mode

Detailed Description

Instruction to split.

An instruction to split always holds the number of splits that we should fork off, and it also contains an instruction how we want the tree to split the data off. We can either do the bottom up scheme, where we try to find exactly the right number of fine grid cells on the finest level and then assign refined cells to remote trees where it is a fit. The realisation of these splitting variants is discussed in peano4::grid::Spacetree::isCellBottomUpSplitCandidate(), ::grid::Spacetree::isCellTopDownSplitCandidate() and peano4::grid::Spacetree::splitOrJoinCell(). The underlying algorithmic considerations are documented in the domain decomposition overview.

I have no constructor for this struct, but you can easily create one via

SplitInstruction{24,SplitInstruction::Mode::AggressiveTopDown}

using the brace initialisation of C++.

Definition at line 34 of file grid.h.

Member Enumeration Documentation

Mode

enum class peano4::SplitInstruction::Mode

strong

Enumerator
AggressiveTopDown
BottomUp

Definition at line 35 of file grid.h.

Member Function Documentation

toString() [1/2]

std::string peano4::SplitInstruction::toString

(

)

const

Definition at line 24 of file grid.cpp.

References toString().

Referenced by operator<<().

Here is the call graph for this function:

Here is the caller graph for this function:

toString() [2/2]

std::string peano4::SplitInstruction::toString ( Mode mode )

static

Definition at line 14 of file grid.cpp.

References AggressiveTopDown, BottomUp, and mode.

Referenced by operator<<().

Here is the caller graph for this function:

Field Documentation

mode

Mode peano4::SplitInstruction::mode

Definition at line 38 of file grid.h.

Referenced by toString().

numberOfFineGridCells

int peano4::SplitInstruction::numberOfFineGridCells

Definition at line 37 of file grid.h.

Referenced by peano4::grid::Spacetree::split().

---

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

• src/peano4/grid/grid.h
• src/peano4/grid/grid.cpp