One step. More...

Public Member Functions
	__init__ (self, name, add_user_defined_actions=True)
	By default, the step generates at least one action set for the user.

str	get_observer_class_name (self)
	Class name of the observer this step is translated into.

	remove_all_actions (self)
	Each step holds a set of actions.

	add_action_set (self, action_set)
	Add a new action set to this mesh traversal step.

	set_project (self, project)
	Tie step to project.

	use_cell (self, submodel)

	use_face (self, submodel)

	use_vertex (self, submodel)

	highest_descend_invocation_order (self)
	Return max descend_invocation_order over all action sets associated with this step.

	lowest_descend_invocation_order (self)
	Return minimum descend_invocation_order over all action sets associated with this step.

	get_vertex_operations_signature (self)

	get_face_operations_signature (self)

	get_cell_operations_signature (self)

	get_touch_cell_signature (self)

	construct_output (self, output)
	Each solver step basically gives us two big files/classes: A class which handles the actual data movements, i.e.

	copy_action_sets_from_other_step (self, other_step)

Data Fields
	name

	cell_data

	face_data

	vertex_data

	cell_data_access

	face_data_access

	vertex_data_access

	action_sets

	action_set_generator

	observer_generator

	project

	namespace

	subdirectory

Private Member Functions
	__sort (self)
	Simple bubble sort the action sets, such that their descend_invocation_order is preserved.

Detailed Description

One step.

Most generic version of a solver step. A solverstep describes what Peano 4 should do when it runs over the grid. As users have to specify which pieces of data from the data model are used by the solver step, it can handle all the user data stack flow.

This class also is responsible to generate all function signatures of all the steps, observers and action sets. In the Peano terminology, a step corresponds to an observer. For any given step, we run through the mesh and pass the traversal automaton an observer which accepts events (aka state transition observations).

It is the observer's job to then distribute these observations, broken down into grid actions such as "touch vertex first time", among the action sets that are tied to this observer. In Python you can have one action set and associate it with several observers. In the C++ code, we will flatten such a relation, i.e. create the corresponding action set multiple times.

See also: peano4.api.solversteps.ActionSet.ActionSet

name: String This name is used to create the underlying action set later on

Definition at line 10 of file Step.py.

Constructor & Destructor Documentation

◆ init()

peano4.api.solversteps.Step.Step.__init__	(	self,
		name,
		add_user_defined_actions = `True`
	)

By default, the step generates at least one action set for the user.

However, you can disable this behaviour by passing False to add_user_defined_actions. Alternatively, use remove_all_action_sets() on the step.

Definition at line 38 of file Step.py.

Member Function Documentation

◆ __sort()

peano4.api.solversteps.Step.Step.__sort ( self )

private

Simple bubble sort the action sets, such that their descend_invocation_order is preserved.

See also: peano4.api.solversteps.ActionSet.ActionSet.descend_invocation_order

Definition at line 98 of file Step.py.

References peano4.api.solversteps.Step.Step.action_sets.

Referenced by peano4.api.solversteps.Step.Step.add_action_set(), peano4.api.solversteps.Step.Step.highest_descend_invocation_order(), and peano4.api.solversteps.Step.Step.lowest_descend_invocation_order().

Here is the caller graph for this function:

◆ add_action_set()

peano4.api.solversteps.Step.Step.add_action_set	(	self,
		action_set
	)

Add a new action set to this mesh traversal step.

Each step holds a set of action_sets. They describe what the step actually should do whenever it loads a vertex, runs into a cell, and so forth. By default, the step holds one user-defined action_set (UserActionSet) which means that a stub is generated where users can insert their functionality. It is important in which order you add your action_sets: The whole tree traversal is a top-down/depth-first tree traversal. So all the enter, create, ... operations of a action_set are invoked exactly in the order you add them to the step. All the delete, leave, ... operations are invokved in reversed order.

I used to have a flag append_at_end with the default True, but this one is now replaced, as each action set knows its priority.

Definition at line 117 of file Step.py.

References peano4.api.solversteps.Step.Step.__sort(), and peano4.api.solversteps.Step.Step.action_sets.

Here is the call graph for this function:

◆ construct_output()

peano4.api.solversteps.Step.Step.construct_output	(	self,
		output
	)

Each solver step basically gives us two big files/classes: A class which handles the actual data movements, i.e.

is an implementation of the tree visitor pattern over the Peano4 tree. The other type is an interface which provides plugin points into the created data transitions from a user's perspective.

Markers of type peano4.api.solversteps.SynchroniseActionSets.SynchroniseActionSets yield no C++ code. They only separate the task groups which we hand over to the observer (peano4.api.solversteps.SynchroniseActionSets.get_task_groups()).

Definition at line 245 of file Step.py.

References peano4.api.solversteps.Step.Step.action_set_generator, peano4.api.solversteps.Step.Step.action_sets, peano4.api.solversteps.Step.Step.construct_output(), and peano4.api.solversteps.Step.Step.observer_generator.

Referenced by peano4.api.solversteps.Step.Step.construct_output().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copy_action_sets_from_other_step()

peano4.api.solversteps.Step.Step.copy_action_sets_from_other_step	(	self,
		other_step
	)

Definition at line 277 of file Step.py.

References peano4.api.solversteps.Step.Step.action_sets.

◆ get_cell_operations_signature()

peano4.api.solversteps.Step.Step.get_cell_operations_signature ( self )

Definition at line 211 of file Step.py.

References peano4.api.datamodel.Model.Model.cell_data, peano4.api.solversteps.Step.Step.cell_data, tarch.plotter.api.input.PatchFileParser.UnknownAttributes.cell_data, peano4.api.datamodel.Model.Model.face_data, peano4.api.solversteps.Step.Step.face_data, peano4.api.datamodel.Model.Model.vertex_data, and peano4.api.solversteps.Step.Step.vertex_data.

◆ get_face_operations_signature()

peano4.api.solversteps.Step.Step.get_face_operations_signature ( self )

Definition at line 197 of file Step.py.

References peano4.api.datamodel.Model.Model.cell_data, peano4.api.solversteps.Step.Step.cell_data, tarch.plotter.api.input.PatchFileParser.UnknownAttributes.cell_data, peano4.api.datamodel.Model.Model.face_data, peano4.api.solversteps.Step.Step.face_data, peano4.api.datamodel.Model.Model.vertex_data, and peano4.api.solversteps.Step.Step.vertex_data.

◆ get_observer_class_name()

str peano4.api.solversteps.Step.Step.get_observer_class_name ( self )

Class name of the observer this step is translated into.

This is the step's name, cut down to 64 characters plus a consecutive number if it is longer (

See also: peano4.api.output.Helper.shortened_class_name()), as the class name also is the observer's file name. Everybody referring to the observer class, such as the generated runners, has to use this getter rather than the step's name.

Definition at line 72 of file Step.py.

References solvers.aderdg.kernels.Gemms.Gemms.name, solvers.elliptic.ConstrainedPoissonEquationForMarkerOnCells.ConstrainedPoissonEquationForMarkerOnCells.name(), solvers.fv.FV.FV.name(), convert::data::Variable.name, dastgen2.attributes.Attribute.Attribute.name(), dastgen2.DataModel.DataModel.name(), exagrype.api.CCZ4Solver.CCZ4Solver.name, exahype2.api.PDETerm.PDETerm.name, exahype2.api.Solver.Solver.Plotter.name, exahype2.api.Solver.Solver.name(), exaparty.api.particle.AlgorithmStep.AlgorithmStep.name, exaparty.api.particle.Particle.Particle.name, exaparty.api.particle.tests.DisappearingParticleTest.DisappearingParticleTest.name, exaparty.api.particle.tests.testLeapfrogFixedTimeStepSize.testLeapfrogFixedTimeStepSize.name, solvers.api.Solver.Solver.name(), api.solvers.Solver.Solver.name(), peano4.api.datamodel.DoF.DoF.name, peano4.api.solversteps.Step.Step.name, peano4.api.solversteps.UserActionSet.UserActionSet.name, peano4.api.taskgraph.compiler.fuse-steps-illustrations._IllustrationActionSet.name, peano4.api.taskgraph.compiler.fuse-steps-illustrations._IllustrationSubmodel.name, peano4.api.taskgraph.Task.Task.name, peano4.api.toolbox.particles.Particle.Particle.name, test_derive_load_store_compute_flag._FakeSubmodel.name, test_fuse_steps._FakeActionSet.name, test_fuse_steps._FakeSubmodel.name, test_propagate_use_statements._FakeSubmodel.name, and test_task_groups._FakeActionSet.name.

Here is the call graph for this function:

◆ get_touch_cell_signature()

peano4.api.solversteps.Step.Step.get_touch_cell_signature ( self )

Definition at line 227 of file Step.py.

References peano4.api.datamodel.Model.Model.cell_data, peano4.api.solversteps.Step.Step.cell_data, tarch.plotter.api.input.PatchFileParser.UnknownAttributes.cell_data, peano4.api.datamodel.Model.Model.face_data, peano4.api.solversteps.Step.Step.face_data, peano4.api.datamodel.Model.Model.vertex_data, and peano4.api.solversteps.Step.Step.vertex_data.

◆ get_vertex_operations_signature()

peano4.api.solversteps.Step.Step.get_vertex_operations_signature ( self )

Definition at line 185 of file Step.py.

References peano4.api.datamodel.Model.Model.cell_data, peano4.api.solversteps.Step.Step.cell_data, tarch.plotter.api.input.PatchFileParser.UnknownAttributes.cell_data, peano4.api.datamodel.Model.Model.face_data, peano4.api.solversteps.Step.Step.face_data, peano4.api.datamodel.Model.Model.vertex_data, and peano4.api.solversteps.Step.Step.vertex_data.

◆ highest_descend_invocation_order()

peano4.api.solversteps.Step.Step.highest_descend_invocation_order ( self )

Return max descend_invocation_order over all action sets associated with this step.

See also: peano4.api.solversteps.ActionSet.ActionSet.descend_invocation_order

Definition at line 159 of file Step.py.

References peano4.api.solversteps.Step.Step.__sort(), and peano4.api.solversteps.Step.Step.action_sets.

Here is the call graph for this function:

◆ lowest_descend_invocation_order()

peano4.api.solversteps.Step.Step.lowest_descend_invocation_order ( self )

Return minimum descend_invocation_order over all action sets associated with this step.

See also: peano4.api.solversteps.ActionSet.ActionSet.descend_invocation_order

Definition at line 172 of file Step.py.

References peano4.api.solversteps.Step.Step.__sort(), and peano4.api.solversteps.Step.Step.action_sets.

Here is the call graph for this function:

◆ remove_all_actions()

peano4.api.solversteps.Step.Step.remove_all_actions ( self )

Each step holds a set of actions.

They describe what the step actually should do whenever it loads a vertex, runs into a cell, and so forth. By default, the step holds one user-defined actions which means that a stub is generated where users can insert their functionality. You can remove this one (or any other one added so far) with this routine.

Definition at line 88 of file Step.py.

References peano4.api.solversteps.Step.Step.action_sets.