walberla::uid::GlobalState Class Reference

Detailed Description

The global state of the simulation.

Can be configured using the member function "configure". Must only be configured once while the simulation is initialized. If not configured, the global simulation state defaults to "Set<SUID>::emptySet()".

The global simulation state can be retrieved via calling the function "globalState()".

#include <GlobalState.h>

+ Inheritance diagram for walberla::uid::GlobalState:

Public Member Functions

void configure (const Set< SUID > &state)
 Must only be called once! (fails in debug mode if called for a second time - always succeeds in release mode, however only the first call has an effect) More...
 
void reconfigure (const Set< SUID > &state)
 
const Set< SUID > & get () const
 

Public Attributes

 WALBERLA_BEFRIEND_SINGLETON
 

Private Member Functions

 GlobalState ()
 

Private Attributes

bool configured_
 
Set< SUIDstate_
 

Constructor & Destructor Documentation

◆ GlobalState()

walberla::uid::GlobalState::GlobalState ( )
inlineprivate

Member Function Documentation

◆ configure()

void walberla::uid::GlobalState::configure ( const Set< SUID > &  state)
inline

Must only be called once! (fails in debug mode if called for a second time - always succeeds in release mode, however only the first call has an effect)

◆ get()

const Set<SUID>& walberla::uid::GlobalState::get ( ) const
inline

◆ reconfigure()

void walberla::uid::GlobalState::reconfigure ( const Set< SUID > &  state)
inline

Member Data Documentation

◆ configured_

bool walberla::uid::GlobalState::configured_
private

◆ state_

Set<SUID> walberla::uid::GlobalState::state_
private

◆ WALBERLA_BEFRIEND_SINGLETON

walberla::uid::GlobalState::WALBERLA_BEFRIEND_SINGLETON

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