The global periodic boundary conditions are set in the Constants.h. More...

Inheritance diagram for solvers.fv.actionsets.HandleBoundary.HandleBoundary:

[legend]

Collaboration diagram for solvers.fv.actionsets.HandleBoundary.HandleBoundary:

[legend]

Public Member Functions
	__init__ (self, solver, guard)
	solver: ADERDG Reference to creating class

	get_body_of_operation (self, operation_name)
	Return actual C++ code snippets to be inserted into C++ code.

	get_includes (self)
	Return include statements that you need.

	get_action_set_name (self)
	You should replicate this function in each subclass, so you get meaningful action set names (otherwise, it will be AbstractFVActionSet0,1,2,...).

Public Member Functions inherited from solvers.fv.actionsets.AbstractFVActionSet.AbstractFVActionSet
	user_should_modify_template (self)
	Is the user allowed to modify the output.

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_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_guard_of_operation (self, operation_name)
	Return the guard of an operation.

	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.

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

Data Fields
	guard

	d

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

	parallel

Static Public Attributes
str	TemplateHandleBoundary_Prologue

str	TemplateHandleBoundary_KernelCalls

str	TemplateHandleBoundary_Epilogue

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"

Additional Inherited Members
Protected Attributes inherited from solvers.fv.actionsets.AbstractFVActionSet.AbstractFVActionSet
	_solver

Detailed Description

The global periodic boundary conditions are set in the Constants.h.

There is no need to update QOld along the faces. QOld is always rolled over from QNew, i.e. we may assume it is already set correctly. It is not correctly set in the very first time step (after InitGrid, we haven't yet set QOld), so apply the boundary conditions here would even confuse the assertions.

Definition at line 9 of file HandleBoundary.py.

Constructor & Destructor Documentation

◆ init()

solvers.fv.actionsets.HandleBoundary.HandleBoundary.__init__	(	self,
		solver,
		guard
	)

solver: ADERDG Reference to creating class

Reimplemented from solvers.fv.actionsets.AbstractFVActionSet.AbstractFVActionSet.

Definition at line 105 of file HandleBoundary.py.

Member Function Documentation

◆ get_action_set_name()

solvers.fv.actionsets.HandleBoundary.HandleBoundary.get_action_set_name ( self )

You should replicate this function in each subclass, so you get meaningful action set names (otherwise, it will be AbstractFVActionSet0,1,2,...).

Reimplemented from solvers.fv.actionsets.AbstractFVActionSet.AbstractFVActionSet.

Definition at line 131 of file HandleBoundary.py.

◆ get_body_of_operation()

solvers.fv.actionsets.HandleBoundary.HandleBoundary.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 110 of file HandleBoundary.py.

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

Here is the caller graph for this function:

◆ get_includes()

solvers.fv.actionsets.HandleBoundary.HandleBoundary.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 solvers.fv.actionsets.AbstractFVActionSet.AbstractFVActionSet.

Definition at line 125 of file HandleBoundary.py.

Field Documentation

◆ d

solvers.fv.actionsets.HandleBoundary.HandleBoundary.d

Definition at line 113 of file HandleBoundary.py.

◆ guard

solvers.fv.actionsets.HandleBoundary.HandleBoundary.guard

Definition at line 107 of file HandleBoundary.py.

◆ TemplateHandleBoundary_Epilogue

str solvers.fv.actionsets.HandleBoundary.HandleBoundary.TemplateHandleBoundary_Epilogue

static

Initial value:

=  """
 
    bool isLeftEntryOutside = marker.getSelectedFaceNumber() < Dimensions;
    double innerTimeStamp;
    
    innerTimeStamp = {{FACE_METADATA_ACCESSOR}}.getUpdatedTimeStamp( isLeftEntryOutside ? 1 : 0 );
    {{FACE_METADATA_ACCESSOR}}.setUpdatedTimeStamp( isLeftEntryOutside ? 0 : 1, innerTimeStamp );
    
    innerTimeStamp = {{FACE_METADATA_ACCESSOR}}.getNewTimeStamp( isLeftEntryOutside ? 1 : 0 );
    {{FACE_METADATA_ACCESSOR}}.setNewTimeStamp( isLeftEntryOutside ? 0 : 1, innerTimeStamp );
 
    innerTimeStamp = {{FACE_METADATA_ACCESSOR}}.getOldTimeStamp( isLeftEntryOutside ? 1 : 0 );
    {{FACE_METADATA_ACCESSOR}}.setOldTimeStamp( isLeftEntryOutside ? 0 : 1, innerTimeStamp );
 
    logTraceOut( "touchFaceFirstTime(...)" );
  }
  else {
    logDebug( "touchFaceFirstTime(...)", "skip face " << marker.toString() );
  }
"""

Definition at line 84 of file HandleBoundary.py.

Referenced by solvers.rkdg.actionsets.HandleBoundary.HandleBoundary.get_body_of_operation().

◆ TemplateHandleBoundary_KernelCalls

str solvers.fv.actionsets.HandleBoundary.HandleBoundary.TemplateHandleBoundary_KernelCalls

static

Definition at line 36 of file HandleBoundary.py.

Referenced by solvers.rkdg.actionsets.HandleBoundary.HandleBoundary.get_body_of_operation().

◆ TemplateHandleBoundary_Prologue

str solvers.fv.actionsets.HandleBoundary.HandleBoundary.TemplateHandleBoundary_Prologue

static

Initial value:

=  """
  if (
    {{PREDICATE}}
    and
    not repositories::{{SOLVER_INSTANCE}}.PeriodicBC[marker.getSelectedFaceNumber()%Dimensions]
    and
    not marker.hasBeenRefined() 
    and 
    fineGridFace{{SOLVER_NAME}}FaceLabel.getBoundary()
  ) {
    logTraceInWith3Arguments( "touchFaceFirstTime(...)", fineGridFace{{SOLVER_NAME}}FaceLabel.toString(), (repositories::{{SOLVER_INSTANCE}}.PeriodicBC[marker.getSelectedFaceNumber()%Dimensions]), marker.toString() );
 
"""

Definition at line 21 of file HandleBoundary.py.

Referenced by solvers.rkdg.actionsets.HandleBoundary.HandleBoundary.get_body_of_operation().

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

python/exahype2/solvers/fv/actionsets/HandleBoundary.py

Public Member Functions

Data Fields

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ get_action_set_name()

◆ get_body_of_operation()

◆ get_includes()

Field Documentation

◆ d

◆ guard

◆ TemplateHandleBoundary_Epilogue

◆ TemplateHandleBoundary_KernelCalls

◆ TemplateHandleBoundary_Prologue

◆ init()