peano4.api.solversteps.StepToObserver.StepToObserver Class Reference

Take an action set and construct an observer from it. More...

Inheritance diagram for peano4.api.solversteps.StepToObserver.StepToObserver:

Collaboration diagram for peano4.api.solversteps.StepToObserver.StepToObserver:

Public Member Functions
	__init__ (self, step)
	construct_output (self, output, included_action_sets, task_groups=None)
	Construct one mapping.

Data Fields
	step

Detailed Description

Take an action set and construct an observer from it.

An action set is, as the name suggests, a set of actions. Each action set will have to be mapped onto one C++ action set, which is a where the action behaviour is implemented: a selection of functions which react to events such as "I have hit a face for the first time".

An observer administers these action sets:

• It holds a series of action sets dispatches the events to them.
• It manages the data movements induced by the grid traversal automaton running through the mesh.

Consequently, each action set among the solver steps yields exactly one observer, but potentially many action sets in the C++ implementation.

Important links

• Action sets and events
  
• peano4.api.taskgraph

Definition at line 6 of file StepToObserver.py.

Constructor & Destructor Documentation

__init__()

peano4.api.solversteps.StepToObserver.StepToObserver.__init__	(		self,
			step
	)

Definition at line 36 of file StepToObserver.py.

Member Function Documentation

construct_output()

peano4.api.solversteps.StepToObserver.StepToObserver.construct_output	(		self,
			output,
			included_action_sets,
			task_groups = None
	)

Construct one mapping.

Parameters

task_groups

[[int]] or None Groups of indices into included_action_sets, i.e. action sets which run in parallel - peano4.api.output.Observer.Observer.

Definition at line 40 of file StepToObserver.py.

References peano4.api.solversteps.StepToActionSets.StepToActionSets.step, and peano4.api.solversteps.StepToObserver.StepToObserver.step.

Field Documentation

step

peano4.api.solversteps.StepToObserver.StepToObserver.step

Definition at line 37 of file StepToObserver.py.

Referenced by peano4.api.solversteps.StepToActionSets.StepToActionSets.construct_output(), and peano4.api.solversteps.StepToObserver.StepToObserver.construct_output().

---

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

• src/peano4/api/solversteps/StepToObserver.py