Action set implementing the facet update of the continuous Galerkin solver. More...

Inheritance diagram for ProjectResidualsAndDiagonalOntoFacets.ProjectResidualsAndDiagonalOntoFacets:

[legend]

Collaboration diagram for ProjectResidualsAndDiagonalOntoFacets.ProjectResidualsAndDiagonalOntoFacets:

[legend]

Public Member Functions
	__init__ (self, solver)

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

	get_action_set_name (self)
	Configure name of generated C++ action set.

	user_should_modify_template (self)
	The action set that Peano will generate that corresponds to this class should not be modified by users and can safely be overwritten every time we run the Python toolkit.

	get_includes (self)
	We need the solver repository in this action set, as we directly access the solver object.

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
	d

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

	parallel

Static Public Attributes
str	templateTouchCellFirstTime

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

Action set implementing the facet update of the continuous Galerkin solver.

There are two key elements/events here:

When we hit the face, we compute the update due to the Jacobi solver and subsequently clear all the data that is accumulated. We don't need it anymore as we have already determined the face update.
When we hit the cell, we first map the facet update onto the cell. Now we have an updated cell guess. After that, we immediately compute the residual and throw it back onto the facet.

The latter step might seem to be stupid: After all, we could first update the cell interior and then use the updated solution to determine a residual for the facet. This would be a proper block-Jacobi. However, I prefer a pure Jacobi here, as it allows us to deploy the block update onto a separate task.

The key properties of the solver that we use here are the following ones:

self._degrees_of_freedom_per_cell            = unknowns_per_node * ( polynomial_degree + 1) ** dimensions
self._degrees_of_freedom_per_face            = unknowns_per_node * ( polynomial_degree + 1) ** (dimensions-1)
self._inner_degrees_of_freedom_per_cell      = unknowns_per_node * ( polynomial_degree - 1) ** dimensions
 
self._cell_data.data.add_attribute(peano4.api.dastgen2.Peano4DoubleArray( "solution", str(self._degrees_of_freedom_per_cell) ))
self._cell_data.data.add_attribute(peano4.api.dastgen2.Peano4DoubleArray( "residual", str(self._degrees_of_freedom_per_cell) ))
self._cell_data.data.add_attribute(peano4.api.dastgen2.Peano4DoubleArray( "rhs",      str(self._degrees_of_freedom_per_cell) ))
 
self._face_data.data.add_attribute(peano4.api.dastgen2.Peano4DoubleArray( "residual",      str(self._degrees_of_freedom_per_face) ))
self._face_data.data.add_attribute(peano4.api.dastgen2.Peano4DoubleArray( "diagonal",      str(self._degrees_of_freedom_per_face) ))
self._face_data.data.add_attribute(peano4.api.dastgen2.Peano4DoubleArray( "deltaU",        str(self._degrees_of_freedom_per_face) ))

Which map onto the

Definition at line 9 of file ProjectResidualsAndDiagonalOntoFacets.py.

Constructor & Destructor Documentation

◆ init()

ProjectResidualsAndDiagonalOntoFacets.ProjectResidualsAndDiagonalOntoFacets.__init__	(	self,
		solver
	)

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

Definition at line 120 of file ProjectResidualsAndDiagonalOntoFacets.py.

References ProjectResidualsAndDiagonalOntoFacets.ProjectResidualsAndDiagonalOntoFacets.__init__().

Referenced by ProjectResidualsAndDiagonalOntoFacets.ProjectResidualsAndDiagonalOntoFacets.__init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ get_action_set_name()

ProjectResidualsAndDiagonalOntoFacets.ProjectResidualsAndDiagonalOntoFacets.get_action_set_name ( self )

Configure name of generated C++ action set.

This action set will end up in the directory observers with a name that reflects how the observer (initialisation) is mapped onto this action set. The name pattern is ObserverName2ActionSetIdentifier where this routine co-determines the ActionSetIdentifier. We make is reflect the Python class name.

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

Definition at line 134 of file ProjectResidualsAndDiagonalOntoFacets.py.

◆ get_body_of_operation()

ProjectResidualsAndDiagonalOntoFacets.ProjectResidualsAndDiagonalOntoFacets.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 127 of file ProjectResidualsAndDiagonalOntoFacets.py.

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

Here is the caller graph for this function:

◆ get_includes()

ProjectResidualsAndDiagonalOntoFacets.ProjectResidualsAndDiagonalOntoFacets.get_includes ( self )

We need the solver repository in this action set, as we directly access the solver object.

We also need access to Peano's d-dimensional loops.

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

Definition at line 158 of file ProjectResidualsAndDiagonalOntoFacets.py.

◆ user_should_modify_template()

ProjectResidualsAndDiagonalOntoFacets.ProjectResidualsAndDiagonalOntoFacets.user_should_modify_template ( self )

The action set that Peano will generate that corresponds to this class should not be modified by users and can safely be overwritten every time we run the Python toolkit.

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

Definition at line 148 of file ProjectResidualsAndDiagonalOntoFacets.py.