Peano

Searching...

No Matches

This class plugs into the first access to a face and copies the data over. More...

Inheritance diagram for peano4.toolbox.blockstructured.BackupPatchOverlap.BackupPatchOverlap:

[legend]

Collaboration diagram for peano4.toolbox.blockstructured.BackupPatchOverlap.BackupPatchOverlap:

[legend]

Public Member Functions
	__init__ (self, patch_overlap_in, patch_overlap_out, invoke_in_touch_first, guard="", additional_includes="")

	set_guard_predicate (self, guard)

	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.

Public Member Functions inherited from peano4.solversteps.ActionSet.ActionSet
	get_static_initialisations (self, full_qualified_classname)

	get_body_of_prepareTraversal (self)

	get_body_of_unprepareTraversal (self)

Data Fields
	d

	invoke_in_touch_first

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

	parallel

Protected Attributes
	_additional_includes

Static Private Attributes
str	__Template

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"

Detailed Description

This class plugs into the first access to a face and copies the data over.

patch_overlap_in: peano4.datamodel.Patch Patch data associated with cell.

patch_overlap_out: peano4.datamodel.Patch Patch data associated with faces.

invoke_in_touch_first: Boolean If you set this one to True, then I do the copying in touchFaceFirstTime. Otherwise, I do it in touchFaceLastTime

guard: Boolean Predicate to determine when to invoke this thing. Pass in true if you wanna be it called always

Definition at line 7 of file BackupPatchOverlap.py.

Constructor & Destructor Documentation

◆ init()

peano4.toolbox.blockstructured.BackupPatchOverlap.BackupPatchOverlap.__init__	(	self,
		patch_overlap_in,
		patch_overlap_out,
		invoke_in_touch_first,
		guard = "",
		additional_includes = "" )

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 29 of file BackupPatchOverlap.py.

References peano4.toolbox.blockstructured.BackupPatchOverlap.BackupPatchOverlap.__init__().

Referenced by peano4.toolbox.blockstructured.BackupPatchOverlap.BackupPatchOverlap.__init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ get_action_set_name()

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

Definition at line 59 of file BackupPatchOverlap.py.

◆ get_attributes()

peano4.toolbox.blockstructured.BackupPatchOverlap.BackupPatchOverlap.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 96 of file BackupPatchOverlap.py.

◆ get_body_of_getGridControlEvents()

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

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 55 of file BackupPatchOverlap.py.

◆ get_body_of_operation()

peano4.toolbox.blockstructured.BackupPatchOverlap.BackupPatchOverlap.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 85 of file BackupPatchOverlap.py.

◆ get_constructor_body()

peano4.toolbox.blockstructured.BackupPatchOverlap.BackupPatchOverlap.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 47 of file BackupPatchOverlap.py.

◆ get_destructor_body()

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

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 51 of file BackupPatchOverlap.py.

◆ get_includes()

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

Definition at line 100 of file BackupPatchOverlap.py.

References exahype2.Project.Project._additional_includes, and peano4.toolbox.blockstructured.BackupPatchOverlap.BackupPatchOverlap._additional_includes.

◆ set_guard_predicate()

peano4.toolbox.blockstructured.BackupPatchOverlap.BackupPatchOverlap.set_guard_predicate	(		self,
			guard )

Definition at line 43 of file BackupPatchOverlap.py.

◆ user_should_modify_template()

peano4.toolbox.blockstructured.BackupPatchOverlap.BackupPatchOverlap.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 63 of file BackupPatchOverlap.py.

Field Documentation

◆ __Template

str peano4.toolbox.blockstructured.BackupPatchOverlap.BackupPatchOverlap.__Template

staticprivate

Initial value:

=  """
  if ({GUARD_PREDICATE}) {{
    logTraceInWith3Arguments( "--backup patch overlap from {FACES_ACCESSOR_IN} into {FACES_ACCESSOR_OUT}--(...)", marker.toString(), {FACES_ACCESSOR_OUT}.value, {FACES_ACCESSOR_IN}.value );
    int counter = 0;
    dfore(k,{DOFS_PER_AXIS},0,0) {{
      for (int i=0; i<{OVERLAP}*2; i++) {{
        for (int j=0; j<{UNKNOWNS}; j++) {{
          // assertion4( {FACES_ACCESSOR_IN}.value[counter]=={FACES_ACCESSOR_IN}.value[counter], k,i,j, marker.toString() );
          {FACES_ACCESSOR_OUT}.value[counter] = {FACES_ACCESSOR_IN}.value[counter];
          counter++;
        }}
      }}
    }}
    logTraceOutWith1Argument( "--backup patch overlap from {FACES_ACCESSOR_IN} into {FACES_ACCESSOR_OUT}--(...)", {FACES_ACCESSOR_IN}.value[0] );
  }}
"""

Definition at line 67 of file BackupPatchOverlap.py.

Referenced by peano4.toolbox.blockstructured.BackupPatchOverlap.BackupPatchOverlap.get_body_of_operation().

◆ _additional_includes

peano4.toolbox.blockstructured.BackupPatchOverlap.BackupPatchOverlap._additional_includes

protected

Definition at line 40 of file BackupPatchOverlap.py.

Referenced by exahype2.Project.Project.add_mainfile_include(), exahype2.Project.Project.additional_includes(), and peano4.toolbox.blockstructured.BackupPatchOverlap.BackupPatchOverlap.get_includes().

◆ d

peano4.toolbox.blockstructured.BackupPatchOverlap.BackupPatchOverlap.d

Definition at line 31 of file BackupPatchOverlap.py.

◆ invoke_in_touch_first

peano4.toolbox.blockstructured.BackupPatchOverlap.BackupPatchOverlap.invoke_in_touch_first

Definition at line 39 of file BackupPatchOverlap.py.

Referenced by peano4.toolbox.blockstructured.BackupPatchOverlap.BackupPatchOverlap.get_body_of_operation().

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

python/peano4/toolbox/blockstructured/BackupPatchOverlap.py

Public Member Functions

Data Fields

Protected Attributes

Static Private 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_constructor_body()

◆ get_destructor_body()

◆ get_includes()

◆ set_guard_predicate()

◆ user_should_modify_template()

Field Documentation

◆ __Template

◆ _additional_includes

◆ d

◆ invoke_in_touch_first

◆ init()