Peano

Searching...

No Matches

Inheritance diagram for peano4.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation:

[legend]

Collaboration diagram for peano4.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation:

[legend]

Public Member Functions
	construct_face_helper_data (peano4.datamodel.DaStGen2 cell_data_model)
	We cannot access neighbouring cells within Peano.

	__init__ (self, peano4.datamodel.DaStGen2 cell_data, peano4.datamodel.DaStGen2 face_data, relaxation_coefficient, rhs_expr, unknown_setter="setU", unknown_getter="getU", guard="true")
	:Attibutes:

	get_body_of_getGridControlEvents (self)

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

	get_body_of_unprepareTraversal (self)

Data Fields
	d

	additional_includes

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

	parallel

Static Protected Attributes
str	_Template_CreateCell

str	_Template_CreatePersistentFace

str	_Template_CreateHangingFace

str	_Template_DestroyHangingFace

str	_Template_TouchFaceFirstTime

str	_Template_TouchCellFirstTime_UpdateSolution

str	_Template_TouchCellFirstTime_UpdateFaceHelperData

Additional Inherited Members
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

Definition at line 11 of file ScalarJacobiWithRediscretisation.py.

Constructor & Destructor Documentation

◆ init()

peano4.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.__init__	(		self,
		peano4.datamodel.DaStGen2	cell_data,
		peano4.datamodel.DaStGen2	face_data,
			relaxation_coefficient,
			rhs_expr,
			unknown_setter = "setU",
			unknown_getter = "getU",
			guard = "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.solversteps.ActionSet.ActionSet.

Definition at line 42 of file ScalarJacobiWithRediscretisation.py.

Member Function Documentation

◆ construct_face_helper_data()

peano4.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.construct_face_helper_data ( peano4.datamodel.DaStGen2 cell_data_model )

We cannot access neighbouring cells within Peano.

Therefore, we have to store helper data on the faces such that we can reconstruct the value within the face-connected neighbours.

cell_data_mode:

Definition at line 14 of file ScalarJacobiWithRediscretisation.py.

◆ get_action_set_name()

peano4.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.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.solversteps.ActionSet.ActionSet.

Definition at line 82 of file ScalarJacobiWithRediscretisation.py.

◆ get_attributes()

peano4.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.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.solversteps.ActionSet.ActionSet.

Definition at line 175 of file ScalarJacobiWithRediscretisation.py.

◆ get_body_of_getGridControlEvents()

peano4.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.get_body_of_getGridControlEvents ( self )

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 78 of file ScalarJacobiWithRediscretisation.py.

◆ get_body_of_operation()

peano4.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.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 157 of file ScalarJacobiWithRediscretisation.py.

◆ get_includes()

peano4.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.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.solversteps.ActionSet.ActionSet.

Definition at line 181 of file ScalarJacobiWithRediscretisation.py.

Here is the call graph for this function:

◆ user_should_modify_template()

peano4.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.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.solversteps.ActionSet.ActionSet.

Definition at line 86 of file ScalarJacobiWithRediscretisation.py.

Field Documentation

◆ _Template_CreateCell

str peano4.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation._Template_CreateCell

staticprotected

Initial value:

=  """
fineGridCell{{CELL_NAME}}.{{UNKNOWN_SETTER}}(0.0);
"""

Definition at line 94 of file ScalarJacobiWithRediscretisation.py.

Referenced by exahype2.solvers.aderdg.actionsets.DynamicAMR.DynamicAMR.get_body_of_operation(), peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR.get_body_of_operation(), and peano4.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.get_body_of_operation().

◆ _Template_CreateHangingFace

str peano4.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation._Template_CreateHangingFace

staticprotected

Initial value:

=  """
auto coarseValue = coarseGridFaces{{FACE_NAME}}( marker.getSelectedFaceNumber() ).getOldAverage();
 
fineGridFace{{FACE_NAME}}.setOldAverage( coarseValue );
fineGridFace{{FACE_NAME}}.setNewAverage( coarseValue );
"""

Definition at line 103 of file ScalarJacobiWithRediscretisation.py.

Referenced by exahype2.grid.FaceLabel.UpdateFaceLabel.get_body_of_operation(), exahype2.solvers.aderdg.actionsets.DynamicAMR.DynamicAMR.get_body_of_operation(), peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR.get_body_of_operation(), and peano4.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.get_body_of_operation().

◆ _Template_CreatePersistentFace

str peano4.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation._Template_CreatePersistentFace

staticprotected

Initial value:

=  """
fineGridFace{{FACE_NAME}}.setNewAverage(0.0);
fineGridFace{{FACE_NAME}}.setOldAverage(0.0);
"""

Definition at line 98 of file ScalarJacobiWithRediscretisation.py.

Referenced by peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR.get_body_of_operation(), and peano4.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.get_body_of_operation().

◆ _Template_DestroyHangingFace

str peano4.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation._Template_DestroyHangingFace

staticprotected

Initial value:

=  """
coarseGridFaces{{FACE_NAME}}( marker.getSelectedFaceNumber() ).setNewAverage(
  coarseGridFaces{{FACE_NAME}}( marker.getSelectedFaceNumber() ).getNewAverage()
  +
  ThreePowerD/3.0 * fineGridFace{{FACE_NAME}}.getNewAverage()
);
"""

Definition at line 110 of file ScalarJacobiWithRediscretisation.py.

◆ _Template_TouchCellFirstTime_UpdateFaceHelperData

str peano4.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation._Template_TouchCellFirstTime_UpdateFaceHelperData

staticprotected

Initial value:

=  """
for (int d=0; d<Dimensions; d++) {
  const double newValue = fineGridCell{{CELL_NAME}}.{{UNKNOWN_GETTER}}();
  fineGridFaces{{FACE_NAME}}(d).setNewAverage(            fineGridFaces{{FACE_NAME}}(d).getNewAverage()            + 0.5 * newValue );
  fineGridFaces{{FACE_NAME}}(d+Dimensions).setNewAverage( fineGridFaces{{FACE_NAME}}(d+Dimensions).getNewAverage() + 0.5 * newValue );
}
"""

Definition at line 148 of file ScalarJacobiWithRediscretisation.py.

Referenced by peano4.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.get_body_of_operation().

◆ _Template_TouchCellFirstTime_UpdateSolution

str peano4.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation._Template_TouchCellFirstTime_UpdateSolution

staticprotected

Initial value:

=  """
// @todo Das ist nicht schoen. Ich haette hier gerne nen allgemeinen Stencil
 
if ({{GUARD}}) {  
  double diagonal = 0.0;
  double residual = {{RHS}};
 
  double centralValue = fineGridCell{{CELL_NAME}}.{{UNKNOWN_GETTER}}();
 
  for (int d=0; d<Dimensions; d++) {
    double leftNeighbour  = 2.0 * (fineGridFaces{{FACE_NAME}}(d).getOldAverage()            - 0.5 * centralValue);
    double rightNeighbour = 2.0 * (fineGridFaces{{FACE_NAME}}(d+Dimensions).getOldAverage() - 0.5 * centralValue);
  
    residual -= (-1.0 * leftNeighbour + 2.0 * centralValue - 1.0 * rightNeighbour) / marker.h()(d) / marker.h()(d);
    diagonal += (2.0) / marker.h()(d) / marker.h()(d);
  }
  
  double newValue = fineGridCell{{CELL_NAME}}.{{UNKNOWN_GETTER}}() + {{OMEGA}} / diagonal * residual;
 
  fineGridCell{{CELL_NAME}}.{{UNKNOWN_SETTER}}( newValue );
}
"""

Definition at line 124 of file ScalarJacobiWithRediscretisation.py.

Referenced by peano4.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.get_body_of_operation().

◆ _Template_TouchFaceFirstTime

str peano4.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation._Template_TouchFaceFirstTime

staticprotected

Initial value:

=  """
fineGridFace{{FACE_NAME}}.setOldAverage( fineGridFace{{FACE_NAME}}.getNewAverage() );
fineGridFace{{FACE_NAME}}.setNewAverage( 0.0 );
"""

Definition at line 118 of file ScalarJacobiWithRediscretisation.py.

Referenced by exahype2.grid.FaceLabel.UpdateFaceLabel.get_body_of_operation(), exahype2.solvers.aderdg.actionsets.Correction.Correction.get_body_of_operation(), peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR.get_body_of_operation(), and peano4.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.get_body_of_operation().

◆ additional_includes

peano4.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.additional_includes

Definition at line 75 of file ScalarJacobiWithRediscretisation.py.

◆ d

peano4.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.d

Definition at line 67 of file ScalarJacobiWithRediscretisation.py.

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

python/peano4/toolbox/multigrid/cellbased/ScalarJacobiWithRediscretisation.py

Public Member Functions

Data Fields

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ construct_face_helper_data()

◆ get_action_set_name()

◆ get_attributes()

◆ get_body_of_getGridControlEvents()

◆ get_body_of_operation()

◆ get_includes()

◆ user_should_modify_template()

Field Documentation

◆ _Template_CreateCell

◆ _Template_CreateHangingFace

◆ _Template_CreatePersistentFace

◆ _Template_DestroyHangingFace

◆ _Template_TouchCellFirstTime_UpdateFaceHelperData

◆ _Template_TouchCellFirstTime_UpdateSolution

◆ _Template_TouchFaceFirstTime

◆ additional_includes

◆ d

◆ init()