Evaluate the point-wise refinement criterion and collect the outcome as refine and erase requests. More...

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

[legend]

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

[legend]

Public Member Functions
	__init__ (self, solver, int patch_size, str guard, float min_volume_size=None, float max_volume_size=None, int event_lifetime=2, bool hand_events_to_peano=False, bool veto_erase=False)

str	get_volume_evaluation (self)
	C++ Jinja2 template evaluating the criterion within one volume.

	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_body_of_unprepareTraversal (self)
	Commit the new events once per rank and mesh sweep, after all trees have merged their local events into the service.

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

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

	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_constructor_body (self)
	Define a tailored constructor body.

	get_static_initialisations (self, full_qualified_classname)

	get_destructor_body (self)

	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_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
	patch_size

	guard

	event_lifetime

	min_volume_size

	max_volume_size

	hand_events_to_peano

	veto_erase

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

	parallel

Static Public Attributes
str	TemplateEvaluateVolume
	Per-volume evaluation of the point-wise criterion.

str	TemplateEvaluateCriterion

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"

Protected Attributes
	_solver

Detailed Description

Evaluate the point-wise refinement criterion and collect the outcome as refine and erase requests.

The numerical schemes add this action set to the very last task of their time step if the solver has an exahype2.api.RefineErasePointwisely PDE term (exahype2.api.blockstructured.create_dynamic_mesh_refinement_action_set.create_dynamic_mesh_refinement_action_set()). The action set loops over all volumes of each patch and invokes the term per volume centre. It initialises the term's output with Keep. From the outcomes of all the volumes, it derives one command for the whole cell:

If any volume says Refine, the cell asks for a refinement.
If all volumes say Erase, the cell asks to be erased, i.e. coarsened.
Otherwise, the cell is kept and does not issue any command.

The action set bounds the mesh size. Refine commands are dropped for cells whose volumes are already smaller than min_volume_size. Erase commands are dropped if the volumes of the coarsened cell would not be smaller than max_volume_size. If a bound is None, the mesh size is not constrained. As the action set drops these commands, it does not issue requests which the mesh cannot realise anyway, and the mesh adaptation phase is only triggered if the mesh actually can change. The numerical schemes take the two bounds as constructor arguments and pass them through.

Peano erases the children of a cell only if they all ask for it. Erase commands therefore carry the cell's position within its parent, and the refinement service keeps them only if all 3^d children of a parent have asked to be erased within the same mesh sweep (exahype2::RefinementControlService::keepOnlyCompleteSiblingEraseEvents()). Incomplete sets of erase requests are dropped right away, so they never trigger the mesh adaptation phase.

The action set collects the commands of one tree within a local exahype2::RefinementControl, merges it into the rank's exahype2::RefinementControlService at the end of the traversal, and commits the new events once per rank in unprepareTraversal(). By default, it does not hand any event over to Peano, i.e. the time step itself never changes the mesh. The mesh adaptation phase consumes the requests (exahype2::isMeshAdaptationRequired()). The setup's mesh adaptation (exahype2.api.fv.SetupSimulationWithUserCodedRefinementCriterion) instead lets the action set hand the events over to Peano right away (hand_events_to_peano). It also vetoes all erase commands (veto_erase): The setup has no restriction which would hand the patches of erased cells over to their parent, i.e. a parent would end up with an uninitialised patch. The mesh adaptation phase of the time stepping always restricts (toolbox.blockstructured.api.InterpolateAndRestrictCells).

Subclasses which evaluate a different adaptivity criterion only replace the per-volume evaluation (exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.get_volume_evaluation()), e.g. exahype2.api.blockstructured.DynamicMeshRefinementWithGradients.

The action set works for all block-structured schemes which hold their unknowns as patch_size^d volumes (or grid cells) per mesh cell, i.e. for exahype2.api.fv and exahype2.api.rkfd4.

Definition at line 8 of file DynamicMeshRefinement.py.

Constructor & Destructor Documentation

◆ init()

exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.__init__	(		self,
			solver,
		int	patch_size,
		str	guard,
		float	min_volume_size = `None`,
		float	max_volume_size = `None`,
		int	event_lifetime = `2`,
		bool	hand_events_to_peano = `False`,
		bool	veto_erase = `False`
	)

Parameters

solver	exahype2.api.Solver The solver whose criterion is evaluated.
patch_size	int Number of volumes per axis within one patch.
guard	str C++ boolean expression, evaluated per cell, guarding whether the criterion is evaluated for that cell.
min_volume_size	float A cell asks for a refinement only if its volumes are at least of this size. None does not bound the refinement.
max_volume_size	float A cell asks to be erased only if the volumes of the coarser cell are strictly smaller than this size. None does not bound the coarsening.
event_lifetime	int Number of mesh sweeps a refinement or erase event remains alive within the refinement service (exahype2::RefinementControl::addCommand()).
hand_events_to_peano	bool Hand the refinement service's committed events over to Peano, so Peano realises them in the subsequent mesh sweeps. The time step leaves this off, the setup's mesh adaptation switches it on.
veto_erase	bool Drop all erase commands, i.e. only ever refine. The time step leaves this off, the setup's mesh adaptation switches it on.

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

Definition at line 68 of file DynamicMeshRefinement.py.

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

Referenced by exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.__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.DynamicMeshRefinement.DynamicMeshRefinement.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.

Reimplemented in exahype2.api.blockstructured.DynamicMeshRefinementWithGradients.DynamicMeshRefinementWithGradients.

Definition at line 226 of file DynamicMeshRefinement.py.

◆ get_attributes()

exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.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 221 of file DynamicMeshRefinement.py.

◆ get_body_of_createGridControlEventsForNextTraversal()

exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.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 216 of file DynamicMeshRefinement.py.

References exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.get_body_of_createGridControlEventsForNextTraversal(), and exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.hand_events_to_peano.

Referenced by exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.get_body_of_createGridControlEventsForNextTraversal(), and peano4.api.solversteps.ActionSet.ActionSet.get_implementation_of_createGridControlEventsForNextTraversal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_body_of_operation()

exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.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 169 of file DynamicMeshRefinement.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:

◆ get_body_of_unprepareTraversal()

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

Commit the new events once per rank and mesh sweep, after all trees have merged their local events into the service.

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

Definition at line 207 of file DynamicMeshRefinement.py.

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

Here is the caller graph for this function:

◆ get_guard_of_operation()

exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.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 202 of file DynamicMeshRefinement.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:

◆ get_includes()

exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.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 232 of file DynamicMeshRefinement.py.

◆ get_volume_evaluation()

str exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.get_volume_evaluation ( self )

C++ Jinja2 template evaluating the criterion within one volume.

The template runs within a loop over the volumes of the patch, i.e. it has access to the volume's index volume. It has to update the two flags anyVolumeWantsToRefine and allVolumesWantToErase.

Definition at line 138 of file DynamicMeshRefinement.py.

References exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.TemplateEvaluateVolume, and exahype2.api.blockstructured.DynamicMeshRefinementWithGradients.DynamicMeshRefinementWithGradients.TemplateEvaluateVolume.

Referenced by exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.get_body_of_operation().

Here is the caller graph for this function:

◆ user_should_modify_template()

exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.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 229 of file DynamicMeshRefinement.py.

Field Documentation

◆ _solver

exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement._solver

protected

Definition at line 115 of file DynamicMeshRefinement.py.

◆ event_lifetime

exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.event_lifetime

Definition at line 118 of file DynamicMeshRefinement.py.

Referenced by exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.get_body_of_operation().

◆ guard

exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.guard

Definition at line 117 of file DynamicMeshRefinement.py.

◆ hand_events_to_peano

exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.hand_events_to_peano

Definition at line 121 of file DynamicMeshRefinement.py.

Referenced by exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.get_body_of_createGridControlEventsForNextTraversal().

◆ max_volume_size

exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.max_volume_size

Definition at line 120 of file DynamicMeshRefinement.py.

Referenced by exahype2.api.fv.RusanovWithExplicitEuler.RusanovWithExplicitEuler.construct_output(), exahype2.api.fv.RusanovWithOptimisticExplicitEuler.RusanovWithOptimisticExplicitEuler.construct_output(), and exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.get_body_of_operation().

◆ min_volume_size

exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.min_volume_size

Definition at line 119 of file DynamicMeshRefinement.py.

Referenced by exahype2.api.fv.SetupSimulationWithUserCodedRefinementCriterion.SetupSimulationWithUserCodedRefinementCriterion._create_adapt_mesh_task(), exahype2.api.fv.RusanovWithExplicitEuler.RusanovWithExplicitEuler.construct_output(), exahype2.api.fv.RusanovWithOptimisticExplicitEuler.RusanovWithOptimisticExplicitEuler.construct_output(), and exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.get_body_of_operation().

◆ patch_size

exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.patch_size

Definition at line 116 of file DynamicMeshRefinement.py.

Referenced by exahype2.api.fv.RusanovWithExplicitEuler.RusanovWithExplicitEuler.__create_data_structures(), exahype2.api.fv.RusanovWithOptimisticExplicitEuler.RusanovWithOptimisticExplicitEuler.__create_data_structures(), exahype2.api.rkfd4.CentralDifferencesWithRungeKutta.CentralDifferencesWithRungeKutta.__create_data_structures(), exahype2.api.fv.RusanovWithExplicitEuler.RusanovWithExplicitEuler.construct_output(), exahype2.api.fv.RusanovWithOptimisticExplicitEuler.RusanovWithOptimisticExplicitEuler.construct_output(), exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.get_body_of_operation(), and exahype2.api.fv.actionsets.InsertPatchInterior.InsertPatchInterior.get_body_of_operation().

◆ TemplateEvaluateCriterion

str exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.TemplateEvaluateCriterion

static

Initial value:

=  """
  logTraceIn( "touchCellFirstTime(...)---DynamicMeshRefinement" );
  bool anyVolumeWantsToRefine = false;
  bool allVolumesWantToErase  = true;
  dfor( volume, {{NUMBER_OF_VOLUMES_PER_AXIS}} ) {
{{EVALUATE_VOLUME}}
  }
 
  if ( anyVolumeWantsToRefine {{REFINE_BOUND}}) {
_localRefinementControl.addCommand( marker.x(), marker.h(), ::exahype2::RefinementCommand::Refine, {{EVENT_LIFETIME}} );
  }
{%- if not VETO_ERASE %}
  else if ( not anyVolumeWantsToRefine and allVolumesWantToErase {{ERASE_BOUND}}) {
_localRefinementControl.addCommand( marker.x(), marker.h(), ::exahype2::RefinementCommand::Erase, {{EVENT_LIFETIME}}, marker.getRelativePositionWithinFatherCell() );
  }
{%- endif %}
  logTraceOut( "touchCellFirstTime(...)---DynamicMeshRefinement" );
"""

Definition at line 150 of file DynamicMeshRefinement.py.

Referenced by exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.get_body_of_operation().

◆ TemplateEvaluateVolume

str exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.TemplateEvaluateVolume

static

Initial value:

=  """
const int index = peano4::utils::dLinearised(volume,{{NUMBER_OF_VOLUMES_PER_AXIS}}) * ({{NUMBER_OF_UNKNOWNS}} + {{NUMBER_OF_AUXILIARY_VARIABLES}});
::exahype2::RefinementCommand command = ::exahype2::RefinementCommand::Keep;
repositories::{{SOLVER_INSTANCE}}.refineErasePointwisely(
  fineGridCell{{UNKNOWN_IDENTIFIER}}.value + index,
  ::exahype2::fv::getVolumeCentre( marker.x(), marker.h(), {{NUMBER_OF_VOLUMES_PER_AXIS}}, volume),
  repositories::{{SOLVER_INSTANCE}}.getMinTimeStamp(),
  &command
);
anyVolumeWantsToRefine = anyVolumeWantsToRefine or command == ::exahype2::RefinementCommand::Refine;
allVolumesWantToErase  = allVolumesWantToErase  and command == ::exahype2::RefinementCommand::Erase;
"""

Per-volume evaluation of the point-wise criterion.

Definition at line 125 of file DynamicMeshRefinement.py.

Referenced by exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.get_volume_evaluation().

◆ veto_erase

exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.veto_erase

Definition at line 122 of file DynamicMeshRefinement.py.

Referenced by exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.get_body_of_operation().

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

src/exahype2/api/blockstructured/DynamicMeshRefinement.py

Public Member Functions

Data Fields

Static Public Attributes

Protected Attributes

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_unprepareTraversal()

◆ get_guard_of_operation()

◆ get_includes()

◆ get_volume_evaluation()

◆ user_should_modify_template()

Field Documentation

◆ _solver

◆ event_lifetime

◆ guard

◆ hand_events_to_peano

◆ max_volume_size

◆ min_volume_size

◆ patch_size

◆ TemplateEvaluateCriterion

◆ TemplateEvaluateVolume

◆ veto_erase

◆ init()