Peano

peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR.__init__	(	self,
		patch,
		patch_overlap_interpolation,
		patch_overlap_restriction,
		interpolation_scheme,
		restriction_scheme,
		clear_guard = "true",
		restrict_guard = "true",
		interpolate_guard = "true",
		additional_includes = "" )

restrict_guard: String Predicate as C++ expression.

It determines which faces are cleared.

interpolation_scheme: String This is a string that is used to assemble the interpolation scheme that is actually used. At the moment, I mainly offer three variants here:

piecewise_constant.
linear.
linear_precomputed_operators<3>. The 3 has to be replaced by the number of unknowns that you use per coordinate axis.

Definition at line 25 of file DynamicAMR.py.

References __init__().

Referenced by __init__().

Here is the call graph for this function:

Here is the caller graph for this function:

peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR.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.solversteps.ActionSet.ActionSet.

Reimplemented in exahype2.solvers.fv.actionsets.DynamicAMR.DynamicAMR, and exahype2.solvers.rkfd.actionsets.DynamicAMR.DynamicAMR.

Definition at line 87 of file DynamicAMR.py.

peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR.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.solversteps.ActionSet.ActionSet.

Definition at line 264 of file DynamicAMR.py.

peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR.get_body_of_getGridControlEvents ( self )

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 83 of file DynamicAMR.py.

peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR.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.

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 235 of file DynamicAMR.py.

peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR.get_clear_guard ( self )

Definition at line 277 of file DynamicAMR.py.

peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR.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.solversteps.ActionSet.ActionSet.

Definition at line 75 of file DynamicAMR.py.

peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR.get_destructor_body ( self )

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 79 of file DynamicAMR.py.

peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR.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.solversteps.ActionSet.ActionSet.

Reimplemented in exahype2.solvers.fv.actionsets.DynamicAMR.DynamicAMR, and exahype2.solvers.rkfd.actionsets.DynamicAMR.DynamicAMR.

Definition at line 268 of file DynamicAMR.py.

References dastgen2.DataModel.DataModel.additional_includes, and additional_includes.

peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR.get_interpolate_guard ( self )

Definition at line 285 of file DynamicAMR.py.

peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR.get_restrict_guard ( self )

Definition at line 281 of file DynamicAMR.py.

peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR.switch_interpolation_scheme	(		self,
			interpolation_scheme )

Definition at line 289 of file DynamicAMR.py.

peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR.switch_restriction_scheme	(		self,
			restriction_scheme )

Definition at line 293 of file DynamicAMR.py.

peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR.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.solversteps.ActionSet.ActionSet.

Definition at line 91 of file DynamicAMR.py.

str peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR._Template_CreateCell

staticprotected

Initial value:

=  """
logTraceIn( "createCell(...)" );
 
::toolbox::blockstructured::interpolateCell_AoS_{{INTERPOLATION_SCHEME}}(
    marker,
    {{DOFS_PER_AXIS}},
    {{UNKNOWNS}},
    {{COARSE_GRID_CELL}}.value,
    {{FINE_GRID_CELL}}.value
);
 
logTraceOut( "createCell(...)" );
"""

Definition at line 205 of file DynamicAMR.py.

Referenced by get_body_of_operation(), and peano4.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.get_body_of_operation().

str peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR._Template_CreateHangingFace

staticprotected

Initial value:

=  """
if ( {{INTERPOLATE_GUARD}} ) {
  logTraceInWith1Argument( "createHangingFace(...)", marker.toString() );
 
  ::toolbox::blockstructured::interpolateHaloLayer_AoS_{{INTERPOLATION_SCHEME}}(
    marker,
    {{DOFS_PER_AXIS}},
    {{OVERLAP}},
    {{UNKNOWNS}},
    {{COARSE_GRID_FACE_ACCESSOR_INTERPOLATION}}(marker.getSelectedFaceNumber()).value,
    {{FINE_GRID_FACE_ACCESSOR_INTERPOLATION}}.value
  );
 
  logTraceOut( "createHangingFace(...)" );
}
else {
  logDebug( "createHangingFace(...)", "skip interpolation for " << marker.toString() << " as interpolation guard did not yield true" );
}
"""

Definition at line 128 of file DynamicAMR.py.

Referenced by get_body_of_operation(), and peano4.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.get_body_of_operation().

str peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR._Template_CreatePersistentFace

staticprotected

Initial value:

=  """
logTraceInWith1Argument( "createPersistentFace(...)", marker.toString() );
 
::toolbox::blockstructured::interpolateHaloLayer_AoS_{{INTERPOLATION_SCHEME}}(
    marker,
    {{DOFS_PER_AXIS}},
    {{OVERLAP}},
    {{UNKNOWNS}},
    {{COARSE_GRID_CELL}}.value,
    {{COARSE_GRID_FACE_ACCESSOR_INTERPOLATION}}(marker.getSelectedFaceNumber()).value,
    {{FINE_GRID_FACE_ACCESSOR_INTERPOLATION}}.value
);
 
logTraceOutWith1Argument( "createPersistentFace(...)", marker.toString() );
"""

Definition at line 170 of file DynamicAMR.py.

Referenced by get_body_of_operation(), and peano4.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.get_body_of_operation().

str peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR._Template_DestroyCell

staticprotected

Initial value:

=  """
logTraceInWith1Argument( "destroyCell(...)", marker.toString() );
 
::toolbox::blockstructured::restrictCell_AoS_{{RESTRICTION_SCHEME}}(
    marker,
    {{DOFS_PER_AXIS}},
    {{UNKNOWNS}},
    {{FINE_GRID_CELL}}.value,
    {{COARSE_GRID_CELL}}.value
);
 
logTraceOut( "destroyCell(...)" );
"""

Definition at line 220 of file DynamicAMR.py.

Referenced by get_body_of_operation().

str peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR._Template_DestroyHangingFace

staticprotected

Initial value:

=  """
if ( {{RESTRICT_GUARD}} ) {
  logTraceInWith4Arguments( "destroyHangingFace(...)", "{{FINE_GRID_FACE_ACCESSOR_RESTRICTION}}", "{{COARSE_GRID_FACE_ACCESSOR_RESTRICTION}}", marker.getSelectedFaceNumber(), marker.toString() );
 
  ::toolbox::blockstructured::restrictInnerHalfOfHaloLayer_AoS_{{RESTRICTION_SCHEME}}(
    marker,
    {{DOFS_PER_AXIS}},
    {{OVERLAP}},
    {{UNKNOWNS}},
    {{FINE_GRID_FACE_ACCESSOR_RESTRICTION}}.value,
    {{COARSE_GRID_FACE_ACCESSOR_RESTRICTION}}(marker.getSelectedFaceNumber()).value
  );
 
  logTraceOut( "destroyHangingFace(...)" );
}
"""

Definition at line 149 of file DynamicAMR.py.

Referenced by get_body_of_operation(), and peano4.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.get_body_of_operation().

str peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR._Template_DestroyPersistentFace

staticprotected

Initial value:

=  """
if ( not marker.isInteriorFaceWithinPatch() ) {
  logTraceIn( "destroyPersistentFace(...)" );
  
  ::toolbox::blockstructured::restrictHaloLayer_AoS_{{RESTRICTION_SCHEME}}(
    marker,
    {{DOFS_PER_AXIS}},
    {{OVERLAP}},
    {{UNKNOWNS}},
    {{FINE_GRID_FACE_ACCESSOR_RESTRICTION}}.value,
    {{COARSE_GRID_FACE_ACCESSOR_RESTRICTION}}(marker.getSelectedFaceNumber()).value
  );
  
  logTraceOut( "destroyPersistentFace(...)" );
}
"""

Definition at line 187 of file DynamicAMR.py.

Referenced by get_body_of_operation().

str peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR._Template_TouchCellFirstTime

staticprotected

Initial value:

=  """
if ( marker.hasBeenRefined() and not marker.willBeRefined() ) {
  logTraceInWith2Arguments( "touchCellFirstTime(...)", marker.toString(), "clear cell {{FINE_GRID_CELL}}" );
  
  ::toolbox::blockstructured::clearCell(
    marker,
    {{DOFS_PER_AXIS}},
    {{UNKNOWNS}},
    {{FINE_GRID_CELL}}.value
  );
 
  logTraceOut( "touchCellFirstTime(...)" );
}
"""

Definition at line 112 of file DynamicAMR.py.

Referenced by get_body_of_operation().

str peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR._Template_TouchFaceFirstTime

staticprotected

Initial value:

=  """
if ( {{CLEAR_GUARD}} ) {
  logTraceInWith2Arguments( "touchFaceFirstTime(...)", marker.toString(), "clear halo layer {{FINE_GRID_FACE_ACCESSOR_RESTRICTION}}" );
  
  ::toolbox::blockstructured::clearHaloLayerAoS(
    marker,
    {{DOFS_PER_AXIS}},
    {{OVERLAP}},
    {{UNKNOWNS}},
    {{FINE_GRID_FACE_ACCESSOR_RESTRICTION}}.value
  );
 
  logTraceOut( "touchFaceFirstTime(...)" );
}
"""

Definition at line 95 of file DynamicAMR.py.

Referenced by get_body_of_operation(), and peano4.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.get_body_of_operation().

peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR.additional_includes = additional_includes

Definition at line 72 of file DynamicAMR.py.

dict peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR.d = {}

Definition at line 51 of file DynamicAMR.py.

Public Member Functions
	__init__ (self, patch, patch_overlap_interpolation, patch_overlap_restriction, interpolation_scheme, restriction_scheme, clear_guard="true", restrict_guard="true", interpolate_guard="true", additional_includes="")
	restrict_guard: String Predicate as C++ expression.
	get_constructor_body (self)
	Define a tailored constructor body.
	get_destructor_body (self)
	get_body_of_getGridControlEvents (self)
	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_attributes (self)
	Return attributes as copied and pasted into the generated class.
	get_includes (self)
	Return include statements that you need.
	get_clear_guard (self)
	get_restrict_guard (self)
	get_interpolate_guard (self)
	switch_interpolation_scheme (self, interpolation_scheme)
	switch_restriction_scheme (self, restriction_scheme)
Public Member Functions inherited from peano4.solversteps.ActionSet.ActionSet
	__init__ (self, descend_invocation_order=0, parallel=False)
	get_static_initialisations (self, full_qualified_classname)
	get_body_of_prepareTraversal (self)
	get_body_of_unprepareTraversal (self)

Data Fields
dict	d = {}
	additional_includes = additional_includes
Data Fields inherited from peano4.solversteps.ActionSet.ActionSet
	descend_invocation_order = descend_invocation_order
	parallel = parallel

Additional Inherited Members
Static Public Attributes inherited from peano4.solversteps.ActionSet.ActionSet
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"

Public Member Functions

Data Fields

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ init()

Member Function Documentation

◆ get_action_set_name()

◆ get_attributes()

◆ get_body_of_getGridControlEvents()

◆ get_body_of_operation()

◆ get_clear_guard()

◆ get_constructor_body()

◆ get_destructor_body()

◆ get_includes()

◆ get_interpolate_guard()

◆ get_restrict_guard()

◆ switch_interpolation_scheme()

◆ switch_restriction_scheme()

◆ user_should_modify_template()

Field Documentation

◆ _Template_CreateCell

◆ _Template_CreateHangingFace

◆ _Template_CreatePersistentFace

◆ _Template_DestroyCell

◆ _Template_DestroyHangingFace

◆ _Template_DestroyPersistentFace

◆ _Template_TouchCellFirstTime

◆ _Template_TouchFaceFirstTime

◆ additional_includes

◆ d

Static Protected Attributes
str	_Template_TouchFaceFirstTime
str	_Template_TouchCellFirstTime
str	_Template_CreateHangingFace
str	_Template_DestroyHangingFace
str	_Template_CreatePersistentFace
str	_Template_DestroyPersistentFace
str	_Template_CreateCell
str	_Template_DestroyCell

Public Member Functions

Data Fields

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ get_action_set_name()

◆ get_attributes()

◆ get_body_of_getGridControlEvents()

◆ get_body_of_operation()

◆ get_clear_guard()

◆ get_constructor_body()

◆ get_destructor_body()

◆ get_includes()

◆ get_interpolate_guard()

◆ get_restrict_guard()

◆ switch_interpolation_scheme()

◆ switch_restriction_scheme()

◆ user_should_modify_template()

Field Documentation

◆ _Template_CreateCell

◆ _Template_CreateHangingFace

◆ _Template_CreatePersistentFace

◆ _Template_DestroyCell

◆ _Template_DestroyHangingFace

◆ _Template_DestroyPersistentFace

◆ _Template_TouchCellFirstTime

◆ _Template_TouchFaceFirstTime

◆ additional_includes

◆ d

◆ init()