Refine the mesh such that it matches the mesh of a checkpoint. More...

Inheritance diagram for exahype2.api.blockstructured.LoadCheckpoint._RefineFromCheckpoint:

[legend]

Collaboration diagram for exahype2.api.blockstructured.LoadCheckpoint._RefineFromCheckpoint:

[legend]

Public Member Functions
	__init__ (self, reader, includes)

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

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

	get_body_of_prepareTraversal (self)

	get_body_of_unprepareTraversal (self)

	get_constructor_body (self)
	Define a tailored constructor body.

	get_action_set_name (self)
	Return unique action set name.

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

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

	get_includes (self)
	Return include statements that you need.

Public Member Functions inherited from peano4.api.solversteps.ActionSet.ActionSet
	get_static_initialisations (self, full_qualified_classname)

	get_destructor_body (self)

	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
	_reader

	_includes

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

Refine the mesh such that it matches the mesh of a checkpoint.

The action set hands the refinement events of the checkpoint (exahype2::CheckpointReader::getRefinementEvents()) to Peano. As the mesh setup over a regular grid, it pauses the refinement while the load balancing has just split.

Definition at line 27 of file LoadCheckpoint.py.

Constructor & Destructor Documentation

◆ init()

exahype2.api.blockstructured.LoadCheckpoint._RefineFromCheckpoint.__init__	(	self,
		reader,
		includes
	)

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

Definition at line 39 of file LoadCheckpoint.py.

References exahype2.api.blockstructured.LoadCheckpoint._RefineFromCheckpoint.__init__().

Referenced by exahype2.api.blockstructured.LoadCheckpoint._RefineFromCheckpoint.__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.LoadCheckpoint._RefineFromCheckpoint.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 68 of file LoadCheckpoint.py.

◆ get_attributes()

exahype2.api.blockstructured.LoadCheckpoint._RefineFromCheckpoint.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 74 of file LoadCheckpoint.py.

◆ get_body_of_createGridControlEventsForNextTraversal()

exahype2.api.blockstructured.LoadCheckpoint._RefineFromCheckpoint.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 44 of file LoadCheckpoint.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.LoadCheckpoint._RefineFromCheckpoint.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 56 of file LoadCheckpoint.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.LoadCheckpoint._RefineFromCheckpoint.get_body_of_prepareTraversal ( self )

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

Definition at line 59 of file LoadCheckpoint.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.LoadCheckpoint._RefineFromCheckpoint.get_body_of_unprepareTraversal ( self )

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

Definition at line 62 of file LoadCheckpoint.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.LoadCheckpoint._RefineFromCheckpoint.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 65 of file LoadCheckpoint.py.

◆ get_includes()

exahype2.api.blockstructured.LoadCheckpoint._RefineFromCheckpoint.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 77 of file LoadCheckpoint.py.

References exahype2.api.blockstructured.LoadCheckpoint._RefineFromCheckpoint._includes, and exahype2.api.blockstructured.LoadCheckpoint._LoadPatchesFromCheckpoint._includes.

◆ user_should_modify_template()

exahype2.api.blockstructured.LoadCheckpoint._RefineFromCheckpoint.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 71 of file LoadCheckpoint.py.

Field Documentation

◆ _includes

exahype2.api.blockstructured.LoadCheckpoint._RefineFromCheckpoint._includes

protected

Definition at line 42 of file LoadCheckpoint.py.

Referenced by exahype2.api.blockstructured.LoadCheckpoint._RefineFromCheckpoint.get_includes(), and exahype2.api.blockstructured.LoadCheckpoint._LoadPatchesFromCheckpoint.get_includes().

◆ _reader

exahype2.api.blockstructured.LoadCheckpoint._RefineFromCheckpoint._reader

protected

Definition at line 41 of file LoadCheckpoint.py.

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

src/exahype2/api/blockstructured/LoadCheckpoint.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_includes()

◆ user_should_modify_template()

Field Documentation

◆ _includes

◆ _reader

◆ init()