This also should be called before the solver stuff. More...

Inheritance diagram for solvers.api.actionsets.CollocatedMGSolver.Prolongation.Prolongation:

[legend]

Collaboration diagram for solvers.api.actionsets.CollocatedMGSolver.Prolongation.Prolongation:

[legend]

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

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

	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.

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

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	templateTouchVertexFirstTime

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

This also should be called before the solver stuff.

Definition at line 7 of file Prolongation.py.

Constructor & Destructor Documentation

◆ init()

solvers.api.actionsets.CollocatedMGSolver.Prolongation.Prolongation.__init__	(	self,
		solver,
		descend_invocation_order = `0`,
		parallel = `False`
	)

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

Definition at line 41 of file Prolongation.py.

References solvers.api.actionsets.CollocatedMGSolver.Prolongation.Prolongation.__init__().

Referenced by solvers.api.actionsets.CollocatedMGSolver.Prolongation.Prolongation.__init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ get_action_set_name()

solvers.api.actionsets.CollocatedMGSolver.Prolongation.Prolongation.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 84 of file Prolongation.py.

◆ get_body_of_operation()

solvers.api.actionsets.CollocatedMGSolver.Prolongation.Prolongation.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 54 of file Prolongation.py.

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

Here is the caller graph for this function:

◆ get_includes()

solvers.api.actionsets.CollocatedMGSolver.Prolongation.Prolongation.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 71 of file Prolongation.py.

◆ user_should_modify_template()

solvers.api.actionsets.CollocatedMGSolver.Prolongation.Prolongation.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 61 of file Prolongation.py.

Field Documentation

◆ d

solvers.api.actionsets.CollocatedMGSolver.Prolongation.Prolongation.d

Definition at line 49 of file Prolongation.py.

◆ templateTouchVertexFirstTime

str solvers.api.actionsets.CollocatedMGSolver.Prolongation.Prolongation.templateTouchVertexFirstTime

static

Initial value:

= """
if (
  repositories::{{SOLVER_INSTANCE}}.prolongate()
  and
  fineGridVertex{{SOLVER_NAME}}.getLevel() == repositories::{{SOLVER_INSTANCE}}.getActiveLevel() - 1
) {
  logTraceInWith1Argument("prolongate::setDelta", fineGridVertex{{SOLVER_NAME}}.toString());
  for (int i=0; i<{{VERTEX_CARDINALITY}}; i++) 
    fineGridVertex{{SOLVER_NAME}}.setDelta(
      i,
      fineGridVertex{{SOLVER_NAME}}.getU(i) - fineGridVertex{{SOLVER_NAME}}.getOldU(i)
    );
  logTraceOutWith1Argument("prolongate::setDelta", fineGridVertex{{SOLVER_NAME}}.toString());
}
 
else if (
  repositories::{{SOLVER_INSTANCE}}.prolongate()
  and
  fineGridVertex{{SOLVER_NAME}}.getLevel() == repositories::{{SOLVER_INSTANCE}}.getActiveLevel()
) {
  // do some real prolongation...
  mghype::matrixfree::solvers::cgmultigrid::prolongate<{{SOLVER_NAME}}>(
    repositories::{{SOLVER_INSTANCE}}.getProlongationMatrix(marker.x(), marker.h()),
    coarseGridVertices{{SOLVER_NAME}},
    fineGridVertex{{SOLVER_NAME}},
    marker
  );
}
"""

Definition at line 11 of file Prolongation.py.

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

src/mghype/matrixfree/solvers/api/actionsets/CollocatedMGSolver/Prolongation.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

◆ templateTouchVertexFirstTime

◆ init()