Reconstruct a cell patch together with its halo into a separate, already-declared reconstructed_patch cell submodel. More...

Inheritance diagram for api.ReconstructPatchWithHalo.ReconstructPatchWithHalo:

[legend]

Collaboration diagram for api.ReconstructPatchWithHalo.ReconstructPatchWithHalo:

[legend]

Public Member Functions
	__init__ (self, patch, patch_overlap, reconstructed_patch, guard="true", add_assertions_to_halo_exchange=True, additional_includes="")
	patch: peano4.api.datamodel.Patch Patch which is to be used

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

	no_of_unknowns

	dofs_per_axis

	total_overlap

	overlap_name

	patch_name

	reconstructed_patch_name

	add_assertions_to_halo_exchange

	additional_includes

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

	parallel

Protected Member Functions
	_add_action_set_entries_to_dictionary (self, d)
	Befill dictionary.

Static Protected Attributes
str	_Template_TouchCellFirstTime_Preamble

str	_Template_TouchCellFirstTime_Fill_Patch

str	_Template_TouchCellFirstTime_Fill_Halos

str	_Template_TouchCellFirstTime_Epilogue

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

Reconstruct a cell patch together with its halo into a separate, already-declared reconstructed_patch cell submodel.

This class assumes that you have an NxNxN patch within your block. It also assumes that you have a 2MxNxN patch on your faces, M<N. The code interprets these face-associated data as overlap with the patch, hooks into touchCellFirstTime, and gathers the cell patch and its face-associated overlaps into reconstructed_patch - a real, separately-declared cell submodel of shape (N+2M)x(N+2M)x(N+2M) (

See also: ProjectPatchOntoFaces for the counterpart that fills the face-associated overlap patches in the first place).

reconstructed_patch is not a scratch array this class allocates and frees itself - it is a proper Peano-managed cell submodel handed in directly by the caller (declared on the surrounding Task/Step the same way patch and patch_overlap are), so this class never has to choose where or how to allocate memory for it: it simply writes into reconstructed_patch's own accessor.

See also: ReconstructPatchAndApplyFunctor, which extends this with an additional functor invoked once the reconstruction is done.

Definition at line 6 of file ReconstructPatchWithHalo.py.

Constructor & Destructor Documentation

◆ init()

api.ReconstructPatchWithHalo.ReconstructPatchWithHalo.__init__	(	self,
		patch,
		patch_overlap,
		reconstructed_patch,
		guard = `"true"`,
		add_assertions_to_halo_exchange = `True`,
		additional_includes = `""`
	)

patch: peano4.api.datamodel.Patch Patch which is to be used

patch_overlap: peano4.api.datamodel.Patch Consult remark above about how the dimensions of this overlap patch have to match

reconstructed_patch: peano4.api.datamodel.Patch Where to write the reconstructed patch-plus-halo to - has to already be declared (use_cell()) on the surrounding Task/Step, just like patch and patch_overlap, and its dimensions have to be patch's plus twice patch_overlap's overlap width, per axis.

additional_includes: str Further includes this action set's generated code needs - e.g. a solver's own default and user includes.

Data validation

I use quite a lot of validitiy checks for the copied data via comparison to its self. This way, I can at least spot nans. I use the dictionary entries ASSERTION_WITH_X_ARGUMENTS to realise this, and they are, by default, set to Peano's assertion macros. You can redefine them.

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

Reimplemented in api.ReconstructPatchAndApplyFunctor.ReconstructPatchAndApplyFunctor.

Definition at line 33 of file ReconstructPatchWithHalo.py.

References api.ReconstructPatchWithHalo.ReconstructPatchWithHalo.__init__(), and assert.

Referenced by api.ReconstructPatchWithHalo.ReconstructPatchWithHalo.__init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ _add_action_set_entries_to_dictionary()

api.ReconstructPatchWithHalo.ReconstructPatchWithHalo._add_action_set_entries_to_dictionary	(	self,
		d
	)

protected

Befill dictionary.

If you inherit from this class and specialise this routine, you can add more entries to the dictionary. This is important if you change the actual compute kernels (templates) and use futher unknowns in there. If you specialise the function, i.e. overwrite it in a subclass, please ensure that you use the superclass still.

Reimplemented in api.ReconstructPatchAndApplyFunctor.ReconstructPatchAndApplyFunctor.

Definition at line 95 of file ReconstructPatchWithHalo.py.

Referenced by api.ReconstructPatchAndApplyFunctor.ReconstructPatchAndApplyFunctor.get_body_of_operation(), and api.ReconstructPatchWithHalo.ReconstructPatchWithHalo.get_body_of_operation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_action_set_name()

api.ReconstructPatchWithHalo.ReconstructPatchWithHalo.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 api.ReconstructPatchAndApplyFunctor.ReconstructPatchAndApplyFunctor.

Definition at line 142 of file ReconstructPatchWithHalo.py.

◆ get_attributes()

api.ReconstructPatchWithHalo.ReconstructPatchWithHalo.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 262 of file ReconstructPatchWithHalo.py.

◆ get_body_of_operation()

api.ReconstructPatchWithHalo.ReconstructPatchWithHalo.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.

Reimplemented in api.ReconstructPatchAndApplyFunctor.ReconstructPatchAndApplyFunctor.

Definition at line 243 of file ReconstructPatchWithHalo.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_constructor_body()

api.ReconstructPatchWithHalo.ReconstructPatchWithHalo.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 138 of file ReconstructPatchWithHalo.py.

◆ get_guard_of_operation()

api.ReconstructPatchWithHalo.ReconstructPatchWithHalo.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 256 of file ReconstructPatchWithHalo.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()

api.ReconstructPatchWithHalo.ReconstructPatchWithHalo.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 266 of file ReconstructPatchWithHalo.py.

Here is the call graph for this function:

◆ user_should_modify_template()

api.ReconstructPatchWithHalo.ReconstructPatchWithHalo.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 146 of file ReconstructPatchWithHalo.py.

Field Documentation

◆ _Template_TouchCellFirstTime_Epilogue

str api.ReconstructPatchWithHalo.ReconstructPatchWithHalo._Template_TouchCellFirstTime_Epilogue

staticprotected

Initial value:

=  """
  logTraceOut( "touchCellFirstTime(...)" );
"""

Definition at line 238 of file ReconstructPatchWithHalo.py.

Referenced by solvers.aderdg.actionsets.Prediction.Prediction.get_body_of_operation(), api.ReconstructPatchAndApplyFunctor.ReconstructPatchAndApplyFunctor.get_body_of_operation(), and api.ReconstructPatchWithHalo.ReconstructPatchWithHalo.get_body_of_operation().

◆ _Template_TouchCellFirstTime_Fill_Halos

str api.ReconstructPatchWithHalo.ReconstructPatchWithHalo._Template_TouchCellFirstTime_Fill_Halos

staticprotected

Definition at line 188 of file ReconstructPatchWithHalo.py.

Referenced by api.ReconstructPatchAndApplyFunctor.ReconstructPatchAndApplyFunctor.get_body_of_operation(), and api.ReconstructPatchWithHalo.ReconstructPatchWithHalo.get_body_of_operation().

◆ _Template_TouchCellFirstTime_Fill_Patch

str api.ReconstructPatchWithHalo.ReconstructPatchWithHalo._Template_TouchCellFirstTime_Fill_Patch

staticprotected

Initial value:

=  """
  //
  // Loop over original patch (k) and copy stuff over.
  //
  dfor(sourceCell,{DOFS_PER_AXIS}) {{
    tarch::la::Vector<Dimensions,int> destinationCell = sourceCell + tarch::la::Vector<Dimensions,int>({OVERLAP});
    int sourceCellSerialised       = peano4::utils::dLinearised(sourceCell,{DOFS_PER_AXIS});
    int destinationCellSerialised  = peano4::utils::dLinearised(destinationCell,{DOFS_PER_AXIS} + 2*{OVERLAP});
    for (int j=0; j<{UNKNOWNS}; j++) {{
      oldQWithHalo[destinationCellSerialised*{UNKNOWNS}+j] = {CELL_ACCESSOR}.value[ sourceCellSerialised*{UNKNOWNS}+j ];
      {ASSERTION_WITH_4_ARGUMENTS}( oldQWithHalo[destinationCellSerialised*{UNKNOWNS}+j]==oldQWithHalo[destinationCellSerialised*{UNKNOWNS}+j], sourceCell, j, "Unknown Tree Number", marker.toString() );
    }}
  }}
"""

Definition at line 172 of file ReconstructPatchWithHalo.py.

Referenced by api.ReconstructPatchAndApplyFunctor.ReconstructPatchAndApplyFunctor.get_body_of_operation(), and api.ReconstructPatchWithHalo.ReconstructPatchWithHalo.get_body_of_operation().

◆ _Template_TouchCellFirstTime_Preamble

str api.ReconstructPatchWithHalo.ReconstructPatchWithHalo._Template_TouchCellFirstTime_Preamble

staticprotected

Initial value:

=  """
auto serialisePatchIndex = [](tarch::la::Vector<Dimensions,int> overlapCell, int normal) {{
  int base   = 1;
  int result = 0;
  for (int d=0; d<Dimensions; d++) {{
    result += overlapCell(d) * base;
    if (d==normal) {{
      base *= {OVERLAP}*2;
    }}
    else {{
      base *= {DOFS_PER_AXIS};
    }}
  }}
  return result;
}};
 
  logTraceInWith1Argument( "touchCellFirstTime(...)", marker.toString() );
 
  double* oldQWithHalo = {RECONSTRUCTED_PATCH_ACCESSOR}.value;
"""