Inheritance diagram for peano4.api.toolbox.multigrid.MatrixFreeJacobi.MatrixFreeJacobi:

[legend]

Collaboration diagram for peano4.api.toolbox.multigrid.MatrixFreeJacobi.MatrixFreeJacobi:

[legend]

Public Member Functions
	__init__ (self, vertex_data, relaxation_coefficient, rhs_expr, unknown_setter="setU", unknown_getter="getU", residual_setter="setResidual", residual_getter="getResidual", store_residual_persistently_and_update_in_touch_first=True)
	:Attibutes:

	get_body_of_createGridControlEventsForNextTraversal (self)
	Return the grid control events that this action set wants to trigger.

	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.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_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.

Data Fields
	d

	additional_includes

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

	parallel

Static Public Attributes
str	Template_ResetResidual

str	Template_CreateHangingVertex

str	Template_TouchCellFirstTime

str	Template_UpdateValue

str	Template_CreatePersistentVertex

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"

Protected Attributes
	_store_residual_persistently_and_update_in_touch_first

Static Private Attributes
	__Template_Constructor = jinja2.Template()

Detailed Description

Definition at line 9 of file MatrixFreeJacobi.py.

Constructor & Destructor Documentation

◆ init()

peano4.api.toolbox.multigrid.MatrixFreeJacobi.MatrixFreeJacobi.__init__	(	self,
		vertex_data,
		relaxation_coefficient,
		rhs_expr,
		unknown_setter = `"setU"`,
		unknown_getter = `"getU"`,
		residual_setter = `"setResidual"`,
		residual_getter = `"getResidual"`,
		store_residual_persistently_and_update_in_touch_first = `True`
	)

:Attibutes:

vertex_data: DaStGen object This object must have at least two attributes: A double value u and a double value residual.

kappa_expr: C++ code (string) Material parameter. Pass in 1.0 if there's no jump anywhere.

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

Definition at line 13 of file MatrixFreeJacobi.py.

Member Function Documentation

◆ get_action_set_name()

peano4.api.toolbox.multigrid.MatrixFreeJacobi.MatrixFreeJacobi.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.api.solversteps.ActionSet.ActionSet.

Definition at line 52 of file MatrixFreeJacobi.py.

◆ get_attributes()

peano4.api.toolbox.multigrid.MatrixFreeJacobi.MatrixFreeJacobi.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.api.solversteps.ActionSet.ActionSet.

Definition at line 181 of file MatrixFreeJacobi.py.

◆ get_body_of_createGridControlEventsForNextTraversal()

peano4.api.toolbox.multigrid.MatrixFreeJacobi.MatrixFreeJacobi.get_body_of_createGridControlEventsForNextTraversal ( self )

Return the grid control events that this action set wants to trigger.

Please consult the documentation of grid control events for details on what these events are and how they are used.

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

Definition at line 48 of file MatrixFreeJacobi.py.

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

Here is the caller graph for this function:

◆ get_body_of_operation()

peano4.api.toolbox.multigrid.MatrixFreeJacobi.MatrixFreeJacobi.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 133 of file MatrixFreeJacobi.py.

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

Here is the caller graph for this function:

◆ get_includes()

peano4.api.toolbox.multigrid.MatrixFreeJacobi.MatrixFreeJacobi.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.api.solversteps.ActionSet.ActionSet.

Definition at line 187 of file MatrixFreeJacobi.py.

Here is the call graph for this function:

◆ user_should_modify_template()

peano4.api.toolbox.multigrid.MatrixFreeJacobi.MatrixFreeJacobi.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.api.solversteps.ActionSet.ActionSet.

Definition at line 56 of file MatrixFreeJacobi.py.

Field Documentation

◆ __Template_Constructor

peano4.api.toolbox.multigrid.MatrixFreeJacobi.MatrixFreeJacobi.__Template_Constructor = jinja2.Template()

staticprivate

Definition at line 60 of file MatrixFreeJacobi.py.

◆ _store_residual_persistently_and_update_in_touch_first

peano4.api.toolbox.multigrid.MatrixFreeJacobi.MatrixFreeJacobi._store_residual_persistently_and_update_in_touch_first

protected

Definition at line 45 of file MatrixFreeJacobi.py.

Referenced by peano4.api.toolbox.multigrid.MatrixFreeJacobi.MatrixFreeJacobi.get_body_of_operation(), and peano4.api.toolbox.multigrid.vertexbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.get_body_of_operation().

◆ additional_includes

peano4.api.toolbox.multigrid.MatrixFreeJacobi.MatrixFreeJacobi.additional_includes

Definition at line 44 of file MatrixFreeJacobi.py.

◆ d

peano4.api.toolbox.multigrid.MatrixFreeJacobi.MatrixFreeJacobi.d

Definition at line 36 of file MatrixFreeJacobi.py.

◆ Template_CreateHangingVertex

str peano4.api.toolbox.multigrid.MatrixFreeJacobi.MatrixFreeJacobi.Template_CreateHangingVertex

static

Initial value:

=  """
fineGridVertex{{UNKNOWN}}.{{RESIDUAL_SETTER}}(0.0);
"""

Definition at line 81 of file MatrixFreeJacobi.py.

Referenced by peano4.api.toolbox.multigrid.MatrixFreeJacobi.MatrixFreeJacobi.get_body_of_operation(), and peano4.api.toolbox.multigrid.vertexbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.get_body_of_operation().

◆ Template_CreatePersistentVertex

str peano4.api.toolbox.multigrid.MatrixFreeJacobi.MatrixFreeJacobi.Template_CreatePersistentVertex

static

Initial value:

= """

"""

Definition at line 130 of file MatrixFreeJacobi.py.

Referenced by peano4.api.toolbox.multigrid.MatrixFreeJacobi.MatrixFreeJacobi.get_body_of_operation(), and peano4.api.toolbox.multigrid.vertexbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.get_body_of_operation().

◆ Template_ResetResidual

str peano4.api.toolbox.multigrid.MatrixFreeJacobi.MatrixFreeJacobi.Template_ResetResidual

static

Initial value:

=  """ 
fineGridVertex{{UNKNOWN}}.{{RESIDUAL_SETTER}}(0.0);
"""

Definition at line 69 of file MatrixFreeJacobi.py.

Referenced by peano4.api.toolbox.multigrid.MatrixFreeJacobi.MatrixFreeJacobi.get_body_of_operation(), and peano4.api.toolbox.multigrid.vertexbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.get_body_of_operation().

◆ Template_TouchCellFirstTime

str peano4.api.toolbox.multigrid.MatrixFreeJacobi.MatrixFreeJacobi.Template_TouchCellFirstTime

static

Initial value:

=  """
const tarch::la::Vector<ThreePowerD,double> stencil = toolbox::finiteelements::getLaplacian(
  marker.h(), 1.0
);
const toolbox::finiteelements::ElementWiseAssemblyMatrix A = toolbox::finiteelements::getElementWiseAssemblyMatrix(
  stencil
);
 
tarch::la::Vector<TwoPowerD,double> u;
for (int i=0; i<TwoPowerD; i++) {
  u(i) = fineGridVertices{{UNKNOWN}}(i).{{UNKNOWN_GETTER}}();
}
 
tarch::la::Vector<TwoPowerD,double> r = A * u;
 
for (int i=0; i<TwoPowerD; i++) {
  fineGridVertices{{UNKNOWN}}(i).{{RESIDUAL_SETTER}}(
    fineGridVertices{{UNKNOWN}}(i).{{RESIDUAL_GETTER}}() + r(i)
  );
}
"""

Definition at line 86 of file MatrixFreeJacobi.py.

Referenced by solvers.api.actionsets.PlotDGDataInPeanoBlockFormat.PlotDGDataInPeanoBlockFormat.get_body_of_operation(), solvers.api.actionsets.PlotDGPatchesInPeanoBlockFormat.PlotDGPatchesInPeanoBlockFormat.get_body_of_operation(), api.actionsets.PlotDGDataInPeanoBlockFormat.PlotDGDataInPeanoBlockFormat.get_body_of_operation(), peano4.api.toolbox.multigrid.MatrixFreeJacobi.MatrixFreeJacobi.get_body_of_operation(), peano4.api.toolbox.multigrid.vertexbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.get_body_of_operation(), and peano4.api.toolbox.PlotCellDataInPeanoBlockFormat.PlotCellDataInPeanoBlockFormat.get_body_of_operation().

◆ Template_UpdateValue

str peano4.api.toolbox.multigrid.MatrixFreeJacobi.MatrixFreeJacobi.Template_UpdateValue

static

Initial value:

=  """
const tarch::la::Vector<ThreePowerD,double> stencil = toolbox::finiteelements::getLaplacian(
  marker.h(), 1.0
);
const double diag     = stencil(ThreePowerD/2);
const double residual = {{RHS}} * tarch::la::volume(marker.h()) - fineGridVertex{{UNKNOWN}}.{{RESIDUAL_GETTER}}();
fineGridVertex{{UNKNOWN}}.{{UNKNOWN_SETTER}}(
  fineGridVertex{{UNKNOWN}}.{{UNKNOWN_GETTER}}()
  + 
  {{OMEGA}} * residual / diag
);  
 
if ( marker.coincidesWithCoarseGridVertex() ) {
  tarch::la::Vector<Dimensions,int> parent = marker.getRelativePositionWithinFatherCell() / 3;
  coarseGridVertices{{UNKNOWN}}( peano4::utils::dLinearised(parent,2) ).{{UNKNOWN_SETTER}}(
    fineGridVertex{{UNKNOWN}}.{{UNKNOWN_GETTER}}()
  );
}
"""

Definition at line 109 of file MatrixFreeJacobi.py.

Referenced by peano4.api.toolbox.multigrid.MatrixFreeJacobi.MatrixFreeJacobi.get_body_of_operation(), and peano4.api.toolbox.multigrid.vertexbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.get_body_of_operation().

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

src/peano4/api/toolbox/multigrid/MatrixFreeJacobi.py

Public Member Functions

Data Fields

Static Public Attributes

Protected Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ get_action_set_name()

◆ get_attributes()

◆ get_body_of_createGridControlEventsForNextTraversal()

◆ get_body_of_operation()

◆ get_includes()

◆ user_should_modify_template()

Field Documentation

◆ __Template_Constructor

◆ _store_residual_persistently_and_update_in_touch_first

◆ additional_includes

◆ d

◆ Template_CreateHangingVertex

◆ Template_CreatePersistentVertex

◆ Template_ResetResidual

◆ Template_TouchCellFirstTime

◆ Template_UpdateValue

◆ init()