api.ApplyPointWiselyToPatch.ApplyPointWiselyToPatch Class Reference

Apply a C++ snippet to each entry of a cell's patch. More...

Inheritance diagram for api.ApplyPointWiselyToPatch.ApplyPointWiselyToPatch:

Collaboration diagram for api.ApplyPointWiselyToPatch.ApplyPointWiselyToPatch:

Public Member Functions
	__init__ (self, patch, str implementation, str guard="true", str additional_includes="")
	guard (self)
	guard (self, value)
	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_action_set_name (self)
	Return unique action set name.
	user_should_modify_template (self)
	Is the user allowed to modify the output.
	get_body_of_operation (self, operation_name)
	Return actual C++ code snippets to be inserted into C++ code.
	get_guard_of_operation (self, operation_name)
	Return the guard of an operation.
	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_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_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.

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

Protected Attributes
	_patch
	_implementation
	_guard

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

Apply a C++ snippet to each entry of a cell's patch.

The action set hooks into touchCellFirstTime() and runs over all NxNxN entries (volumes or grid points) of the patch. For each entry, it runs implementation, i.e. a C++ snippet which may use

• Q: a pointer (double*) to the patch.no_of_unknowns doubles of the entry, which the snippet may read and write;
• x: the position (tarch::la::Vector<Dimensions,double>) of the entry, i.e. the centre of the volume if we interpret the patch as N^d volumes which tessellate the cell.

A typical use case is the postprocessing of a solution, e.g. the enforcement of algebraic constraints or the clipping of unphysical values.

As the action set plugs into touchCellFirstTime(), it runs after all action sets of tasks it depends on which plug into touchCellFirstTime() as well, and before all action sets plugging into touchCellLastTime() such as toolbox.blockstructured.api.ProjectPatchOntoFaces, if the task graph compiler fuses the tasks into one mesh traversal.

Definition at line 6 of file ApplyPointWiselyToPatch.py.

Constructor & Destructor Documentation

__init__()

api.ApplyPointWiselyToPatch.ApplyPointWiselyToPatch.__init__	(		self,
			patch,
		str	implementation,
		str	guard = "true",
		str	additional_includes = ""
	)

Parameters

patch	peano4.api.datamodel.Patch The cell's patch. It has to be a cube, i.e. have the same number of entries along each axis.
implementation	str C++ snippet that is applied to each entry,

See also

class documentation for the variables it may use.

Parameters

guard	str C++ boolean expression. The action set only processes cells for which the guard holds.
additional_includes	str Includes that the snippet needs.

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

Definition at line 33 of file ApplyPointWiselyToPatch.py.

References api.ApplyPointWiselyToPatch.ApplyPointWiselyToPatch.__init__().

Referenced by api.ApplyPointWiselyToPatch.ApplyPointWiselyToPatch.__init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

get_action_set_name()

api.ApplyPointWiselyToPatch.ApplyPointWiselyToPatch.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 84 of file ApplyPointWiselyToPatch.py.

get_attributes()

api.ApplyPointWiselyToPatch.ApplyPointWiselyToPatch.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 114 of file ApplyPointWiselyToPatch.py.

get_body_of_createGridControlEventsForNextTraversal()

api.ApplyPointWiselyToPatch.ApplyPointWiselyToPatch.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 81 of file ApplyPointWiselyToPatch.py.

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

Here is the caller graph for this function:

get_body_of_operation()

api.ApplyPointWiselyToPatch.ApplyPointWiselyToPatch.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 90 of file ApplyPointWiselyToPatch.py.

References solvers.fv.FV.FV._patch, exagrype.api.CCZ4Solver.CCZ4Solver._patch, and api.ApplyPointWiselyToPatch.ApplyPointWiselyToPatch._patch.

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

Here is the caller graph for this function:

get_constructor_body()

api.ApplyPointWiselyToPatch.ApplyPointWiselyToPatch.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 75 of file ApplyPointWiselyToPatch.py.

get_destructor_body()

api.ApplyPointWiselyToPatch.ApplyPointWiselyToPatch.get_destructor_body

(

self

)

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

Definition at line 78 of file ApplyPointWiselyToPatch.py.

get_guard_of_operation()

api.ApplyPointWiselyToPatch.ApplyPointWiselyToPatch.get_guard_of_operation	(		self,
			operation_name
	)

Return the guard of an operation.

The guard is a C++ boolean expression. The body of the operation (see get_body_of_operation()) is executed if and only if the guard holds. The guard can use the same arguments as the body, i.e. the marker and the fine and coarse grid data. By default, the guard is true, i.e. the body is always executed.

See class' string constants starting with OPERATION_ for possible values of operation_name.

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

Definition at line 109 of file ApplyPointWiselyToPatch.py.

References solvers.aderdg.actionsets.AdaptivityCriterion.AdaptivityCriterion._guard, solvers.aderdg.actionsets.Correction.Correction._guard, solvers.aderdg.actionsets.HandleBoundary.HandleBoundary._guard, solvers.aderdg.actionsets.InitialCondition.InitialCondition._guard, solvers.aderdg.actionsets.PostprocessSolution.DoFWisePostprocessSolution._guard, solvers.aderdg.actionsets.PostprocessSolution.CellWisePostprocessSolution._guard, solvers.aderdg.actionsets.Prediction.Prediction._guard, exahype2.api.blockstructured.LoadCheckpoint._LoadPatchesFromCheckpoint._guard, peano4.api.toolbox.FixedResolutionGridSelector.FixedResolutionGridSelector._guard(), and api.ApplyPointWiselyToPatch.ApplyPointWiselyToPatch._guard.

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:

get_includes()

api.ApplyPointWiselyToPatch.ApplyPointWiselyToPatch.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 117 of file ApplyPointWiselyToPatch.py.

References dastgen2.DataModel.DataModel.additional_includes, exahype2.api.fv.actionsets.RollOverUpdatedFace.RollOverUpdatedFace.additional_includes, exahype2.api.Project.Project.additional_includes(), exahype2.api.rkfd4.actionsets.RollOverUpdatedFace.RollOverUpdatedFace.additional_includes, peano4.api.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.additional_includes, peano4.api.toolbox.multigrid.MatrixFreeJacobi.MatrixFreeJacobi.additional_includes, peano4.api.toolbox.multigrid.vertexbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.additional_includes, peano4.api.toolbox.particles.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.additional_includes, peano4.api.toolbox.particles.InsertParticlesByCoordinates.InsertParticlesByCoordinates.additional_includes, peano4.api.toolbox.particles.InsertRandomParticlesIntoUnrefinedCells.InsertRandomParticlesIntoUnrefinedCells.additional_includes, peano4.api.toolbox.particles.PlotParticlesInVTKFormat.PlotParticlesInVTKFormat.additional_includes, peano4.api.toolbox.PlotCellDataInPeanoBlockFormat.PlotCellDataInPeanoBlockFormat.additional_includes, peano4.api.toolbox.PlotGridInPeanoBlockFormat.PlotGridInPeanoBlockFormat.additional_includes, peano4.api.toolbox.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.additional_includes, api.ApplyPointWiselyToPatch.ApplyPointWiselyToPatch.additional_includes, api.DynamicAMR.DynamicAMR.additional_includes, api.InterpolateAndRestrictCells.InterpolateAndRestrictCells.additional_includes, api.InterpolateHangingFaces.InterpolateHangingFaces.additional_includes, api.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat.additional_includes, api.PlotPatchesOverFacesInPeanoBlockFormat.PlotPatchesOverFacesInPeanoBlockFormat.additional_includes, api.ProjectPatchOntoFaces.ProjectPatchOntoFaces.additional_includes, api.ProjectPatchWithHaloOntoFaces.ProjectPatchWithHaloOntoFaces.additional_includes, api.ReconstructPatchWithHalo.ReconstructPatchWithHalo.additional_includes, and api.RestrictHangingFaces.RestrictHangingFaces.additional_includes.

Here is the call graph for this function:

guard() [1/2]

api.ApplyPointWiselyToPatch.ApplyPointWiselyToPatch.guard

(

self

)

Definition at line 68 of file ApplyPointWiselyToPatch.py.

References solvers.aderdg.actionsets.AdaptivityCriterion.AdaptivityCriterion._guard, solvers.aderdg.actionsets.Correction.Correction._guard, solvers.aderdg.actionsets.HandleBoundary.HandleBoundary._guard, solvers.aderdg.actionsets.InitialCondition.InitialCondition._guard, solvers.aderdg.actionsets.PostprocessSolution.DoFWisePostprocessSolution._guard, solvers.aderdg.actionsets.PostprocessSolution.CellWisePostprocessSolution._guard, solvers.aderdg.actionsets.Prediction.Prediction._guard, exahype2.api.blockstructured.LoadCheckpoint._LoadPatchesFromCheckpoint._guard, peano4.api.toolbox.FixedResolutionGridSelector.FixedResolutionGridSelector._guard(), and api.ApplyPointWiselyToPatch.ApplyPointWiselyToPatch._guard.

Referenced by api.ReconstructPatchWithHalo.ReconstructPatchWithHalo._add_action_set_entries_to_dictionary(), solvers.aderdg.actionsets.Correction.Correction.get_body_of_operation(), solvers.aderdg.actionsets.Prediction.Prediction.get_body_of_operation(), solvers.fv.actionsets.AdaptivityCriterion.AdaptivityCriterion.get_body_of_operation(), solvers.fv.actionsets.InitialCondition.InitialCondition.get_body_of_operation(), solvers.fv.actionsets.PostprocessSolution.VolumeWisePostprocessSolution.get_body_of_operation(), solvers.fv.actionsets.PreprocessSolution.VolumeWisePreprocessSolution.get_body_of_operation(), solvers.fv.EnclaveTasking.MergeEnclaveTaskOutcome.get_body_of_operation(), solvers.limiting.actionsets.SaveNewCellData.SaveNewCellData.get_body_of_operation(), solvers.limiting.actionsets.SpreadLimiterStatus.SpreadLimiterStatus.get_body_of_operation(), solvers.limiting.actionsets.VerifyTroubledness.VerifyTroubledness.get_body_of_operation(), solvers.rkdg.actionsets.AdaptivityCriterion.AdaptivityCriterion.get_body_of_operation(), solvers.rkdg.actionsets.ComputeFinalLinearCombination.ComputeFinalLinearCombination.get_body_of_operation(), solvers.rkdg.actionsets.InitialCondition.InitialCondition.get_body_of_operation(), solvers.rkdg.actionsets.PostprocessSolution.DoFWisePostprocessSolution.get_body_of_operation(), solvers.rkdg.actionsets.PostprocessSolution.CellWisePostprocessSolution.get_body_of_operation(), solvers.rkdg.actionsets.PreprocessSolution.DoFWisePreprocessSolution.get_body_of_operation(), solvers.rkdg.actionsets.PreprocessSolution.CellWisePreprocessSolution.get_body_of_operation(), solvers.fv.actionsets.InitialCondition.InitialCondition.get_body_of_prepareTraversal(), exagrype.api.actionsets.AddKreissOligerDissipation.AddKreissOligerDissipation.get_guard_of_operation(), exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.get_guard_of_operation(), exahype2.api.fv.actionsets.ApplyDirichletBoundaryConditions.ApplyDirichletBoundaryConditions.get_guard_of_operation(), exahype2.api.fv.actionsets.ComputeGlobalCFLCondition.ComputeGlobalCFLCondition.get_guard_of_operation(), exahype2.api.fv.actionsets.DiscardPatchInterior.DiscardPatchInterior.get_guard_of_operation(), exahype2.api.fv.actionsets.InitialCondition.InitialCondition.get_guard_of_operation(), exahype2.api.fv.actionsets.InitialiseNewCells.InitialiseNewCells.get_guard_of_operation(), exahype2.api.fv.actionsets.InsertPatchInterior.InsertPatchInterior.get_guard_of_operation(), exahype2.api.fv.actionsets.ReadjustTimeStepSizeForOptimisticGlobalTimestepping.ReadjustTimeStepSizeForOptimisticGlobalTimestepping.get_guard_of_operation(), exahype2.api.fv.actionsets.SpawnTaskToUpdateCellInterior.SpawnTaskToUpdateCellInterior.get_guard_of_operation(), exahype2.api.fv.actionsets.UpdateCell.UpdateCell.get_guard_of_operation(), exahype2.api.fv.actionsets.UpdateCellInterior.UpdateCellInterior.get_guard_of_operation(), exahype2.api.fv.actionsets.UpdateCellShell.UpdateCellShell.get_guard_of_operation(), exahype2.api.rkfd4.actionsets.AddLopsidedAdvection.AddLopsidedAdvection.get_guard_of_operation(), exahype2.api.rkfd4.actionsets.ApplyDirichletBoundaryConditions.ApplyDirichletBoundaryConditions.get_guard_of_operation(), exahype2.api.rkfd4.actionsets.ComputeLinearCombination.ComputeLinearCombination.get_guard_of_operation(), exahype2.api.rkfd4.actionsets.ComputeMaxEigenvalue.ComputeMaxEigenvalue.get_guard_of_operation(), exahype2.api.rkfd4.actionsets.ComputeTimeStepSize.ComputeTimeStepSize.get_guard_of_operation(), exahype2.api.rkfd4.actionsets.EvaluateRightHandSide.EvaluateRightHandSide.get_guard_of_operation(), exahype2.api.rkfd4.actionsets.InitialCondition.InitialCondition.get_guard_of_operation(), api.InterpolateHangingFaces.InterpolateHangingFaces.get_guard_of_operation(), api.ProjectPatchWithHaloOntoFaces.ProjectPatchWithHaloOntoFaces.get_guard_of_operation(), api.ReconstructPatchWithHalo.ReconstructPatchWithHalo.get_guard_of_operation(), and api.RestrictHangingFaces.RestrictHangingFaces.get_guard_of_operation().

Here is the call graph for this function:

Here is the caller graph for this function:

guard() [2/2]

api.ApplyPointWiselyToPatch.ApplyPointWiselyToPatch.guard	(		self,
			value
	)

Definition at line 72 of file ApplyPointWiselyToPatch.py.

References solvers.aderdg.actionsets.AdaptivityCriterion.AdaptivityCriterion._guard, solvers.aderdg.actionsets.Correction.Correction._guard, solvers.aderdg.actionsets.HandleBoundary.HandleBoundary._guard, solvers.aderdg.actionsets.InitialCondition.InitialCondition._guard, solvers.aderdg.actionsets.PostprocessSolution.DoFWisePostprocessSolution._guard, solvers.aderdg.actionsets.PostprocessSolution.CellWisePostprocessSolution._guard, solvers.aderdg.actionsets.Prediction.Prediction._guard, exahype2.api.blockstructured.LoadCheckpoint._LoadPatchesFromCheckpoint._guard, peano4.api.toolbox.FixedResolutionGridSelector.FixedResolutionGridSelector._guard(), and api.ApplyPointWiselyToPatch.ApplyPointWiselyToPatch._guard.

Referenced by api.ReconstructPatchWithHalo.ReconstructPatchWithHalo._add_action_set_entries_to_dictionary(), solvers.aderdg.actionsets.Correction.Correction.get_body_of_operation(), solvers.aderdg.actionsets.Prediction.Prediction.get_body_of_operation(), solvers.fv.actionsets.AdaptivityCriterion.AdaptivityCriterion.get_body_of_operation(), solvers.fv.actionsets.InitialCondition.InitialCondition.get_body_of_operation(), solvers.fv.actionsets.PostprocessSolution.VolumeWisePostprocessSolution.get_body_of_operation(), solvers.fv.actionsets.PreprocessSolution.VolumeWisePreprocessSolution.get_body_of_operation(), solvers.fv.EnclaveTasking.MergeEnclaveTaskOutcome.get_body_of_operation(), solvers.limiting.actionsets.SaveNewCellData.SaveNewCellData.get_body_of_operation(), solvers.limiting.actionsets.SpreadLimiterStatus.SpreadLimiterStatus.get_body_of_operation(), solvers.limiting.actionsets.VerifyTroubledness.VerifyTroubledness.get_body_of_operation(), solvers.rkdg.actionsets.AdaptivityCriterion.AdaptivityCriterion.get_body_of_operation(), solvers.rkdg.actionsets.ComputeFinalLinearCombination.ComputeFinalLinearCombination.get_body_of_operation(), solvers.rkdg.actionsets.InitialCondition.InitialCondition.get_body_of_operation(), solvers.rkdg.actionsets.PostprocessSolution.DoFWisePostprocessSolution.get_body_of_operation(), solvers.rkdg.actionsets.PostprocessSolution.CellWisePostprocessSolution.get_body_of_operation(), solvers.rkdg.actionsets.PreprocessSolution.DoFWisePreprocessSolution.get_body_of_operation(), solvers.rkdg.actionsets.PreprocessSolution.CellWisePreprocessSolution.get_body_of_operation(), solvers.fv.actionsets.InitialCondition.InitialCondition.get_body_of_prepareTraversal(), exagrype.api.actionsets.AddKreissOligerDissipation.AddKreissOligerDissipation.get_guard_of_operation(), exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.get_guard_of_operation(), exahype2.api.fv.actionsets.ApplyDirichletBoundaryConditions.ApplyDirichletBoundaryConditions.get_guard_of_operation(), exahype2.api.fv.actionsets.ComputeGlobalCFLCondition.ComputeGlobalCFLCondition.get_guard_of_operation(), exahype2.api.fv.actionsets.DiscardPatchInterior.DiscardPatchInterior.get_guard_of_operation(), exahype2.api.fv.actionsets.InitialCondition.InitialCondition.get_guard_of_operation(), exahype2.api.fv.actionsets.InitialiseNewCells.InitialiseNewCells.get_guard_of_operation(), exahype2.api.fv.actionsets.InsertPatchInterior.InsertPatchInterior.get_guard_of_operation(), exahype2.api.fv.actionsets.ReadjustTimeStepSizeForOptimisticGlobalTimestepping.ReadjustTimeStepSizeForOptimisticGlobalTimestepping.get_guard_of_operation(), exahype2.api.fv.actionsets.SpawnTaskToUpdateCellInterior.SpawnTaskToUpdateCellInterior.get_guard_of_operation(), exahype2.api.fv.actionsets.UpdateCell.UpdateCell.get_guard_of_operation(), exahype2.api.fv.actionsets.UpdateCellInterior.UpdateCellInterior.get_guard_of_operation(), exahype2.api.fv.actionsets.UpdateCellShell.UpdateCellShell.get_guard_of_operation(), exahype2.api.rkfd4.actionsets.AddLopsidedAdvection.AddLopsidedAdvection.get_guard_of_operation(), exahype2.api.rkfd4.actionsets.ApplyDirichletBoundaryConditions.ApplyDirichletBoundaryConditions.get_guard_of_operation(), exahype2.api.rkfd4.actionsets.ComputeLinearCombination.ComputeLinearCombination.get_guard_of_operation(), exahype2.api.rkfd4.actionsets.ComputeMaxEigenvalue.ComputeMaxEigenvalue.get_guard_of_operation(), exahype2.api.rkfd4.actionsets.ComputeTimeStepSize.ComputeTimeStepSize.get_guard_of_operation(), exahype2.api.rkfd4.actionsets.EvaluateRightHandSide.EvaluateRightHandSide.get_guard_of_operation(), exahype2.api.rkfd4.actionsets.InitialCondition.InitialCondition.get_guard_of_operation(), api.InterpolateHangingFaces.InterpolateHangingFaces.get_guard_of_operation(), api.ProjectPatchWithHaloOntoFaces.ProjectPatchWithHaloOntoFaces.get_guard_of_operation(), api.ReconstructPatchWithHalo.ReconstructPatchWithHalo.get_guard_of_operation(), and api.RestrictHangingFaces.RestrictHangingFaces.get_guard_of_operation().

Here is the call graph for this function:

Here is the caller graph for this function:

user_should_modify_template()

api.ApplyPointWiselyToPatch.ApplyPointWiselyToPatch.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 87 of file ApplyPointWiselyToPatch.py.

Field Documentation

_guard

api.ApplyPointWiselyToPatch.ApplyPointWiselyToPatch._guard

protected

Definition at line 64 of file ApplyPointWiselyToPatch.py.

Referenced by peano4.api.toolbox.FixedResolutionGridSelector.FixedResolutionGridSelector.createCellGuard(), peano4.api.toolbox.FixedResolutionGridSelector.FixedResolutionGridSelector.createFaceGuard(), peano4.api.toolbox.FixedResolutionGridSelector.FixedResolutionGridSelector.createVertexGuard(), solvers.aderdg.actionsets.AdaptivityCriterion.AdaptivityCriterion.get_body_of_operation(), solvers.aderdg.actionsets.HandleBoundary.HandleBoundary.get_body_of_operation(), solvers.aderdg.actionsets.InitialCondition.InitialCondition.get_body_of_operation(), solvers.aderdg.actionsets.PostprocessSolution.DoFWisePostprocessSolution.get_body_of_operation(), solvers.aderdg.actionsets.PostprocessSolution.CellWisePostprocessSolution.get_body_of_operation(), exahype2.api.blockstructured.LoadCheckpoint._LoadPatchesFromCheckpoint.get_guard_of_operation(), api.ApplyPointWiselyToPatch.ApplyPointWiselyToPatch.get_guard_of_operation(), api.ApplyPointWiselyToPatch.ApplyPointWiselyToPatch.guard(), and api.ApplyPointWiselyToPatch.ApplyPointWiselyToPatch.guard().

_implementation

api.ApplyPointWiselyToPatch.ApplyPointWiselyToPatch._implementation

protected

Definition at line 63 of file ApplyPointWiselyToPatch.py.

_patch

api.ApplyPointWiselyToPatch.ApplyPointWiselyToPatch._patch

protected

Definition at line 62 of file ApplyPointWiselyToPatch.py.

Referenced by solvers.fv.FV.FV._init_dictionary_with_default_parameters(), solvers.fv.FV.FV.add_actions_to_checkpoint_solution(), solvers.fv.FV.FV.add_actions_to_plot_solution(), ccz4.CCZ4Solver.add_Psi4W(), solvers.fv.FV.FV.add_to_Peano4_datamodel(), solvers.fv.FV.FV.add_use_data_statements_to_Peano4_solver_step(), and api.ApplyPointWiselyToPatch.ApplyPointWiselyToPatch.get_body_of_operation().

additional_includes

api.ApplyPointWiselyToPatch.ApplyPointWiselyToPatch.additional_includes

Definition at line 65 of file ApplyPointWiselyToPatch.py.

Referenced by exahype2.api.fv.actionsets.RollOverUpdatedFace.RollOverUpdatedFace.get_includes(), exahype2.api.rkfd4.actionsets.RollOverUpdatedFace.RollOverUpdatedFace.get_includes(), peano4.api.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.get_includes(), peano4.api.toolbox.multigrid.MatrixFreeJacobi.MatrixFreeJacobi.get_includes(), peano4.api.toolbox.multigrid.vertexbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.get_includes(), peano4.api.toolbox.particles.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.get_includes(), peano4.api.toolbox.particles.InsertParticlesByCoordinates.InsertParticlesByCoordinates.get_includes(), peano4.api.toolbox.particles.InsertRandomParticlesIntoUnrefinedCells.InsertRandomParticlesIntoUnrefinedCells.get_includes(), peano4.api.toolbox.particles.PlotParticlesInVTKFormat.PlotParticlesInVTKFormat.get_includes(), peano4.api.toolbox.PlotCellDataInPeanoBlockFormat.PlotCellDataInPeanoBlockFormat.get_includes(), peano4.api.toolbox.PlotGridInPeanoBlockFormat.PlotGridInPeanoBlockFormat.get_includes(), peano4.api.toolbox.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.get_includes(), api.ApplyPointWiselyToPatch.ApplyPointWiselyToPatch.get_includes(), api.DynamicAMR.DynamicAMR.get_includes(), api.InterpolateAndRestrictCells.InterpolateAndRestrictCells.get_includes(), api.InterpolateHangingFaces.InterpolateHangingFaces.get_includes(), api.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat.get_includes(), api.PlotPatchesOverFacesInPeanoBlockFormat.PlotPatchesOverFacesInPeanoBlockFormat.get_includes(), api.ProjectPatchOntoFaces.ProjectPatchOntoFaces.get_includes(), api.ProjectPatchWithHaloOntoFaces.ProjectPatchWithHaloOntoFaces.get_includes(), api.ReconstructPatchWithHalo.ReconstructPatchWithHalo.get_includes(), api.RestrictHangingFaces.RestrictHangingFaces.get_includes(), and dastgen2.DataModel.DataModel.write_header_file().

---

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

• src/toolbox/blockstructured/api/ApplyPointWiselyToPatch.py