Peano

Searching...

No Matches

This is for DG solver. More...

Inheritance diagram for UpdateResidual.UpdateResidual:

[legend]

Collaboration diagram for UpdateResidual.UpdateResidual:

[legend]

Public Member Functions
	__init__ (self, solver, descend_invocation_order=0, parallel=True)

	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.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_getGridControlEvents (self)

	get_body_of_prepareTraversal (self)

	get_body_of_unprepareTraversal (self)

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

Data Fields
	d

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

	parallel

Static Public Attributes
str	templateTouchCellFirstTime

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 is for DG solver.

Todo: Documntation missing

Definition at line 7 of file UpdateResidual.py.

Constructor & Destructor Documentation

◆ init()

UpdateResidual.UpdateResidual.__init__	(	self,
		solver,
		descend_invocation_order = 0,
		parallel = True )

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 43 of file UpdateResidual.py.

References UpdateResidual.UpdateResidual.__init__().

Referenced by UpdateResidual.UpdateResidual.__init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ get_action_set_name()

UpdateResidual.UpdateResidual.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.solversteps.ActionSet.ActionSet.

Definition at line 62 of file UpdateResidual.py.

◆ get_body_of_operation()

UpdateResidual.UpdateResidual.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 55 of file UpdateResidual.py.

◆ get_includes()

UpdateResidual.UpdateResidual.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.solversteps.ActionSet.ActionSet.

Definition at line 86 of file UpdateResidual.py.

◆ user_should_modify_template()

UpdateResidual.UpdateResidual.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.solversteps.ActionSet.ActionSet.

Definition at line 76 of file UpdateResidual.py.

Field Documentation

◆ d

UpdateResidual.UpdateResidual.d

Definition at line 51 of file UpdateResidual.py.

◆ templateTouchCellFirstTime

str UpdateResidual.UpdateResidual.templateTouchCellFirstTime

static

Initial value:

= """
if ( 
  fineGridCell{{SOLVER_NAME}}.getType() != celldata::{{SOLVER_NAME}}::Type::Coarse 
  and
  // only one condition here - ensures that we don't do this when restricting the residual
  repositories::{{SOLVER_INSTANCE}}.updateResidual()
) {
  logTraceInWith4Arguments("updateResidual", 
    fineGridCell{{SOLVER_NAME}}.getSolution(),
    fineGridCell{{SOLVER_NAME}}.getRhs(),
    marker.toString(),
    repositories::{{SOLVER_INSTANCE}}.getMassMatrix( marker.x(), marker.h() )
  );
 
  // write Mb into it, i.e. mass matrix * rhs
  tarch::la::Vector< repositories::{{SOLVER_INSTANCE}}.CellUnknowns, double > r =
    repositories::{{SOLVER_INSTANCE}}.getMassMatrix( marker.x(), marker.h() ) * fineGridCell{{SOLVER_NAME}}.getRhs();
 
  // also subtract A^cc u^c
  r = r - repositories::{{SOLVER_INSTANCE}}.getLocalAssemblyMatrix(marker.x(), marker.h()) * fineGridCell{{SOLVER_NAME}}.getSolution();
 
  fineGridCell{{SOLVER_NAME}}.setResidual( r );
 
  logTraceOut("updateResidual");
}
"""

Definition at line 15 of file UpdateResidual.py.

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

src/mghype/matrixfree/solvers/api/actionsets/DGSolver/UpdateResidual.py

Public Member Functions

Data Fields

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ get_action_set_name()

◆ get_body_of_operation()

◆ get_includes()

◆ user_should_modify_template()

Field Documentation

◆ d

◆ templateTouchCellFirstTime

◆ init()