Run over solution volume by volume. More...

Inheritance diagram for solvers.fv.actionsets.PreprocessSolution.VolumeWisePreprocessSolution:

[legend]

Collaboration diagram for solvers.fv.actionsets.PreprocessSolution.VolumeWisePreprocessSolution:

[legend]

Public Member Functions
	__init__ (self, solver)
	solver: ADERDG Reference to creating class

	add_postprocessing_kernel (self, operation_per_point)
	Add a code snippet which is applied to each and every point.

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

	get_action_set_name (self)
	You should replicate this function in each subclass, so you get meaningful action set names (otherwise, it will be AbstractFVActionSet0,1,2,...).

Public Member Functions inherited from solvers.fv.actionsets.AbstractFVActionSet.AbstractFVActionSet
	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_constructor_body (self)
	Define a tailored constructor body.

	get_static_initialisations (self, full_qualified_classname)

	get_destructor_body (self)

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

	get_implementation_of_createGridControlEventsForNextTraversal (self)
	Return the C++ implementation of createGridControlEventsForNextTraversal()

	get_body_of_prepareTraversal (self)

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

	get_body_of_unprepareTraversal (self)

	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.

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

Data Fields
	guard

	descend_invocation_order

Data Fields inherited from peano4.api.solversteps.ActionSet.ActionSet
	descend_invocation_order

	parallel

Protected Attributes
	_compute_kernel

Protected Attributes inherited from solvers.fv.actionsets.AbstractFVActionSet.AbstractFVActionSet
	_solver

Additional Inherited Members
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

Run over solution volume by volume.

PreprocessSolution differs from other action sets, as I only create it once. See FV.create_action_sets(). Once the instance does exist, you can tailor it. But you can also completely overwrite it.

See also FV.postprocess_updated_patch(self, kernel) for a discussion what options ExaHyPE offers for postprocessing. This volume-wise postprocessing might be too heavy-weight for some applications.

The postprocessing plugs into touch cell last time. It is the last action set added by the default implementation. Therefore, it is the first action set of which touchCellLastTime() is called. The reason why I plug into the leaving of the cell is that some solvers may add further action sets to the solve. Enclave tasking for example adds the merger as additional action set. These action sets plug into touchCellFirstTime() - and consequently their first time is called after the postprocessing's first time. By making the postprocessing use touchCellLastTime(), I ensure that any additional action set added by a subclass can still precede the postprocessing.

Definition at line 36 of file PreprocessSolution.py.

Constructor & Destructor Documentation

◆ init()

solvers.fv.actionsets.PreprocessSolution.VolumeWisePreprocessSolution.__init__	(	self,
		solver
	)

solver: ADERDG Reference to creating class

Reimplemented from solvers.fv.actionsets.AbstractFVActionSet.AbstractFVActionSet.

Definition at line 61 of file PreprocessSolution.py.

Member Function Documentation

◆ add_postprocessing_kernel()

solvers.fv.actionsets.PreprocessSolution.VolumeWisePreprocessSolution.add_postprocessing_kernel	(	self,
		operation_per_point
	)

Add a code snippet which is applied to each and every point.

You have the following variables which are well-defined:

value: Is a pointer to the current finite volume's data
volumeX: A tarch::la::Vector over doubles
volumeH: A tarch::la::Vector over doubles

operation_per_point: String C/C++ code snippet

Definition at line 68 of file PreprocessSolution.py.

◆ get_action_set_name()

solvers.fv.actionsets.PreprocessSolution.VolumeWisePreprocessSolution.get_action_set_name ( self )

You should replicate this function in each subclass, so you get meaningful action set names (otherwise, it will be AbstractFVActionSet0,1,2,...).

Reimplemented from solvers.fv.actionsets.AbstractFVActionSet.AbstractFVActionSet.

Definition at line 124 of file PreprocessSolution.py.

◆ get_body_of_operation()

solvers.fv.actionsets.PreprocessSolution.VolumeWisePreprocessSolution.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 112 of file PreprocessSolution.py.

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ _compute_kernel

solvers.fv.actionsets.PreprocessSolution.VolumeWisePreprocessSolution._compute_kernel

protected

Definition at line 64 of file PreprocessSolution.py.

◆ descend_invocation_order

solvers.fv.actionsets.PreprocessSolution.VolumeWisePreprocessSolution.descend_invocation_order

Definition at line 65 of file PreprocessSolution.py.

◆ guard

solvers.fv.actionsets.PreprocessSolution.VolumeWisePreprocessSolution.guard

Definition at line 63 of file PreprocessSolution.py.

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

python/exahype2/solvers/fv/actionsets/PreprocessSolution.py

Public Member Functions

Data Fields

Protected Attributes

Additional Inherited Members