Hand the refine and erase requests of the last time step over to Peano, and restart the time stepping if the mesh has changed. More...

Inheritance diagram for exahype2.api.blockstructured.ConsumeRefinementRequests.ConsumeRefinementRequests:

[legend]

Collaboration diagram for exahype2.api.blockstructured.ConsumeRefinementRequests.ConsumeRefinementRequests:

[legend]

Public Member Functions
	__init__ (self, solver)

	get_constructor_body (self)
	Define a tailored constructor body.

	get_destructor_body (self)

	get_body_of_createGridControlEventsForNextTraversal (self)
	Return the grid control events that this action set wants to trigger.

	get_body_of_prepareTraversal (self)

	get_body_of_unprepareTraversal (self)

	get_body_of_operation (self, operation_name)
	Return actual C++ code snippets to be inserted into C++ code.

	get_attributes (self)
	Return attributes as copied and pasted into the generated class.

	get_static_initialisations (self, full_qualified_classname)

	get_action_set_name (self)
	Return unique action set name.

	user_should_modify_template (self)
	Is the user allowed to modify the output.

	get_includes (self)
	Return include statements that you need.

Public Member Functions inherited from peano4.api.solversteps.ActionSet.ActionSet
	get_implementation_of_createGridControlEventsForNextTraversal (self)
	Return the C++ implementation of createGridControlEventsForNextTraversal()

	get_implementation_of_prepareTraversal (self)
	Return the C++ implementation of prepareTraversal()

	get_implementation_of_unprepareTraversal (self)
	Return the C++ implementation of unprepareTraversal()

	get_guard_of_operation (self, operation_name)
	Return the guard of an operation.

	get_implementation_of_operation (self, operation_name)
	Return the C++ implementation of an operation.

bool	may_run_in_background_task (self)
	May a task graph compiler move touchCellFirstTime() into a task.

Protected Attributes
	_solver

Additional Inherited Members
Data Fields inherited from peano4.api.solversteps.ActionSet.ActionSet
	descend_invocation_order

	parallel

Static Public Attributes inherited from peano4.api.solversteps.ActionSet.ActionSet
int	descend_invocation_order = 0

bool	parallel = False

str	OPERATION_BEGIN_TRAVERSAL = "beginTraversal"

str	OPERATION_END_TRAVERSAL = "endTraversal"

str	OPERATION_CREATE_PERSISTENT_VERTEX = "createPersistentVertex"

str	OPERATION_DESTROY_PERSISTENT_VERTEX = "destroyPersistentVertex"

str	OPERATION_CREATE_HANGING_VERTEX = "createHangingVertex"

str	OPERATION_DESTROY_HANGING_VERTEX = "destroyHangingVertex"

str	OPERATION_CREATE_PERSISTENT_FACE = "createPersistentFace"

str	OPERATION_DESTROY_PERSISTENT_FACE = "destroyPersistentFace"

str	OPERATION_CREATE_HANGING_FACE = "createHangingFace"

str	OPERATION_DESTROY_HANGING_FACE = "destroyHangingFace"

str	OPERATION_CREATE_CELL = "createCell"

str	OPERATION_DESTROY_CELL = "destroyCell"

str	OPERATION_TOUCH_VERTEX_FIRST_TIME = "touchVertexFirstTime"

str	OPERATION_TOUCH_VERTEX_LAST_TIME = "touchVertexLastTime"

str	OPERATION_TOUCH_FACE_FIRST_TIME = "touchFaceFirstTime"

str	OPERATION_TOUCH_FACE_LAST_TIME = "touchFaceLastTime"

str	OPERATION_TOUCH_CELL_FIRST_TIME = "touchCellFirstTime"

str	OPERATION_TOUCH_CELL_LAST_TIME = "touchCellLastTime"

Detailed Description

Hand the refine and erase requests of the last time step over to Peano, and restart the time stepping if the mesh has changed.

The last task of each time step collects refine and erase requests within exahype2::RefinementControlService (exahype2.api.blockstructured.DynamicMeshRefinement). The mesh adaptation phase hosts this action set in its repeating task. The action set does not issue any further request. It

hands the service's committed events over to Peano (createGridControlEventsForNextTraversal()), so Peano realises them,
calls the service's finishStep() once per rank after each mesh sweep, so the events expire after their lifetime. The repeating task runs until the service holds no events anymore, i.e. no request survives into the next time step, and
keeps track of whether a mesh sweep has created or destroyed any cell. If so, it resets the solver's time step size to zero (exahype2::Solver::resetTimeStepSize()) at the end of the sweep. The time step size of the old mesh might violate the CFL condition on the new mesh. With a time step size of zero, the subsequent time step does not advance in time but derives a new admissible time step size from the new mesh.

Whether the mesh has changed is reduced over all ranks, so all ranks reset the time step size consistently.

Definition at line 6 of file ConsumeRefinementRequests.py.

Constructor & Destructor Documentation

◆ init()

exahype2.api.blockstructured.ConsumeRefinementRequests.ConsumeRefinementRequests.__init__	(	self,
		solver
	)

Parameters

solver exahype2.api.Solver The solver whose time step size is reset if the mesh changes.

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Definition at line 37 of file ConsumeRefinementRequests.py.

References exahype2.api.blockstructured.ConsumeRefinementRequests.ConsumeRefinementRequests.__init__().

Referenced by exahype2.api.blockstructured.ConsumeRefinementRequests.ConsumeRefinementRequests.__init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ get_action_set_name()

exahype2.api.blockstructured.ConsumeRefinementRequests.ConsumeRefinementRequests.get_action_set_name ( self )

Return unique action set name.

Returns a description (word) for the mapping which is also used as class name for the generated type. As a consequence, the result should be one word (if possible) and uppercase. Also, every subclass should overwrite this routine.

The generator will take the result and construct eventually classes similar to MyStep2Dummy.h and MyStep2Dummy.cpp or similar for the example below, where we return Dummy.

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Definition at line 95 of file ConsumeRefinementRequests.py.

◆ get_attributes()

exahype2.api.blockstructured.ConsumeRefinementRequests.ConsumeRefinementRequests.get_attributes ( self )

Return attributes as copied and pasted into the generated class.

Please note that action sets are not persistent, i.e. there is one object creation per grid sweep per tree.

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Definition at line 85 of file ConsumeRefinementRequests.py.

◆ get_body_of_createGridControlEventsForNextTraversal()

exahype2.api.blockstructured.ConsumeRefinementRequests.ConsumeRefinementRequests.get_body_of_createGridControlEventsForNextTraversal ( self )

Return the grid control events that this action set wants to trigger.

Please consult the documentation of grid control events for details on what these events are and how they are used.

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Definition at line 53 of file ConsumeRefinementRequests.py.

Referenced by peano4.api.solversteps.ActionSet.ActionSet.get_implementation_of_createGridControlEventsForNextTraversal().

Here is the caller graph for this function:

◆ get_body_of_operation()

exahype2.api.blockstructured.ConsumeRefinementRequests.ConsumeRefinementRequests.get_body_of_operation	(	self,
		operation_name
	)

Return actual C++ code snippets to be inserted into C++ code.

See class' string constants starting with OPERATION_ for possible values of operation_name. The snippet is executed if and only if the guard returned by get_guard_of_operation() holds, i.e. the body should not evaluate the guard itself. See the section "Guard and body" in the class documentation.

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Definition at line 77 of file ConsumeRefinementRequests.py.

Referenced by peano4.api.solversteps.ActionSet.ActionSet.get_implementation_of_operation().

Here is the caller graph for this function:

◆ get_body_of_prepareTraversal()

exahype2.api.blockstructured.ConsumeRefinementRequests.ConsumeRefinementRequests.get_body_of_prepareTraversal ( self )

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Definition at line 56 of file ConsumeRefinementRequests.py.

Referenced by peano4.api.solversteps.ActionSet.ActionSet.get_implementation_of_prepareTraversal().

Here is the caller graph for this function:

◆ get_body_of_unprepareTraversal()

exahype2.api.blockstructured.ConsumeRefinementRequests.ConsumeRefinementRequests.get_body_of_unprepareTraversal ( self )

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Definition at line 59 of file ConsumeRefinementRequests.py.

Referenced by peano4.api.solversteps.ActionSet.ActionSet.get_implementation_of_unprepareTraversal().

Here is the caller graph for this function:

◆ get_constructor_body()

exahype2.api.blockstructured.ConsumeRefinementRequests.ConsumeRefinementRequests.get_constructor_body ( self )

Define a tailored constructor body.

By default, the constructor of an action set is empty. If you you assign attributes to your action set, you however might want to initialise them here. We do not support initialisation lists, to all has to be done via setters unless you create attributes on the heap.

The constructor's signature will look similar to

   EnumerateAndInitSolution2petsc_actionsets_InitVertexDoFs0(int treeNumber);

where the treeNumber is -1 if this is the global instance of the action set owned by a rank, or a number greater or equal 0 if this action set is a clone of the glocal action set that's used by one tree traversal.

See also: get_attributes() to add attributes to your action set

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Definition at line 47 of file ConsumeRefinementRequests.py.

◆ get_destructor_body()

exahype2.api.blockstructured.ConsumeRefinementRequests.ConsumeRefinementRequests.get_destructor_body ( self )

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Definition at line 50 of file ConsumeRefinementRequests.py.

◆ get_includes()

exahype2.api.blockstructured.ConsumeRefinementRequests.ConsumeRefinementRequests.get_includes ( self )

Return include statements that you need.

All of these includes will eventually end up in the header of the generated C++ code.

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Definition at line 101 of file ConsumeRefinementRequests.py.

◆ get_static_initialisations()

exahype2.api.blockstructured.ConsumeRefinementRequests.ConsumeRefinementRequests.get_static_initialisations	(	self,
		full_qualified_classname
	)

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Definition at line 90 of file ConsumeRefinementRequests.py.

◆ user_should_modify_template()

exahype2.api.blockstructured.ConsumeRefinementRequests.ConsumeRefinementRequests.user_should_modify_template ( self )

Is the user allowed to modify the output.

Return whether you expect the user to modify the generated code. If this is the case, then the API places the generated output in the directory actions. Otherwise, it goes into the observer directory and will be overwritten in each and every Python run.

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Definition at line 98 of file ConsumeRefinementRequests.py.

Field Documentation

◆ _solver

exahype2.api.blockstructured.ConsumeRefinementRequests.ConsumeRefinementRequests._solver

protected

Definition at line 45 of file ConsumeRefinementRequests.py.

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

src/exahype2/api/blockstructured/ConsumeRefinementRequests.py

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ get_action_set_name()

◆ get_attributes()

◆ get_body_of_createGridControlEventsForNextTraversal()

◆ get_body_of_operation()

◆ get_body_of_prepareTraversal()

◆ get_body_of_unprepareTraversal()

◆ get_constructor_body()

◆ get_destructor_body()

◆ get_includes()

◆ get_static_initialisations()

◆ user_should_modify_template()

Field Documentation

◆ _solver

◆ init()