Peano

Searching...

No Matches

Couple the solution and updates of two different solvers. More...

Inheritance diagram for solvers.api.actionsets.DGCGCoupling.AbstractDGCGCoupling:

[legend]

Collaboration diagram for solvers.api.actionsets.DGCGCoupling.AbstractDGCGCoupling:

[legend]

Public Member Functions
	__init__ (self, dg_solver, cg_solver, prolongation_matrix, prolongation_matrix_scaling, restriction_matrix, restriction_matrix_scaling, injection_matrix, injection_matrix_scaling, use_fas)
	Construct action set.

	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"

Protected Attributes
	_use_fas

Static Private Attributes
str	__TemplateTouchVertexFirstTime

str	__TemplateTouchCellLastTime_FAS

str	__TemplateTouchCellLastTime_CorrectionScheme

Detailed Description

Couple the solution and updates of two different solvers.

Usage

This action set has to be used as a preprocessing step of the CG:

solver.preprocessing_action_set = mghype.matrixfree.solvers.api.actionsets.AbstractDGCGCoupling(
    solver,                      # dg_solver
    ...
    )

I recommend not to use the coupling directly, but one of its subclasses.

Behaviour

We have a new variable SumOfInjectedValues. This one is set to zero at the end of touchVertexFirstTime(), i.e. at the begin of a mesh sweep. In each fine grid cell, i.e. each cell carrying a DG polynomial, we evaluate this polynomial's value in the \( 2^d \) vertices (corners) of the cell. Of these values, we restrict \( 2^{=-d} \)th of its value to the next coarser mesh level. Prior to the start of a new mesh sweep, SumOfInjectedValues holds the average value of the solution in a vertex. This is just before we clear it again, i.e. we can plug into touchVertexFirstTime() just before we clear this field to read our a coarsened representation of the solution at this point.

Realisation

This class takes the solution of a DG solver and injects the current solution onto the vertices. For this, it simply averages the \( 2^d \) different values of the DG polynomials into the vertex. We do this only for unrefined vertices obviously.

To realise this behaviour, we rely on functions held within AbstractDGCGCoupling.h.
It is important that prepare_and_order_DG_CG_solvers() has been invoked for the two solvers whenever we use this action set.

Definition at line 41 of file DGCGCoupling.py.

Constructor & Destructor Documentation

◆ init()

solvers.api.actionsets.DGCGCoupling.AbstractDGCGCoupling.__init__	(	self,
		dg_solver,
		cg_solver,
		prolongation_matrix,
		prolongation_matrix_scaling,
		restriction_matrix,
		restriction_matrix_scaling,
		injection_matrix,
		injection_matrix_scaling,
		use_fas )

Construct action set.

Parameters

prolongation_matrix	Please consult the action set ComputeAndRestrictBiasedHierarchicalResidual.
prolongation_matrix_scaling	Please consult the action set ComputeAndRestrictBiasedHierarchicalResidual.
injection_matrix	[ \( \mathbb{R}^{2^dK \times (p+1}^dK } \) ] Sequence of matrices. Each takes the solution over the cell spanned by \( (p+1}^dK \) weights and maps them onto \( K \) quantities on the vertices. These quantities are typically just the value of the polynomial in the vertex, but you can pick other schemes, too. Most of the time, it will be a single injection (with one scaling, see below). To be in line with the other signatures, you can however specify the total injection through a sequence of matrices, each one with its own \( h^s \) scaling.
injection_matrix_scaling	[ Integer ] Specifies a sequence of values \( s \). They define with which \( h^s \) the corresponding matrices in injection_matrix are to be scaled. That is, if you pass in a [3,0], then the first matrix in injection_matrix will be scaled with \( h^3 \) and the second one with one. If you work with a simple function evaluation as injection, then you are fine with one matrix, and its scaline will be [ 0 ].
use_fas	Boolean If this flag is set, we realise a FAS following the HTMG idea by Griebel et al.

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Reimplemented in solvers.api.actionsets.DGCGCoupling.MultiplicativeDGCGCoupling, and solvers.api.actionsets.DGCGCoupling.AdditiveDGCGCoupling.

Definition at line 397 of file DGCGCoupling.py.

References solvers.api.actionsets.DGCGCoupling.AbstractDGCGCoupling.__init__(), and solvers.api.actionsets.DGCGCoupling.prepare_CG_correction_solvers().

Referenced by solvers.api.actionsets.DGCGCoupling.AbstractDGCGCoupling.__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.DGCGCoupling.AbstractDGCGCoupling.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 490 of file DGCGCoupling.py.

◆ get_body_of_operation()

solvers.api.actionsets.DGCGCoupling.AbstractDGCGCoupling.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 474 of file DGCGCoupling.py.

◆ get_includes()

solvers.api.actionsets.DGCGCoupling.AbstractDGCGCoupling.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 514 of file DGCGCoupling.py.

◆ user_should_modify_template()

solvers.api.actionsets.DGCGCoupling.AbstractDGCGCoupling.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 504 of file DGCGCoupling.py.

Field Documentation

◆ __TemplateTouchCellLastTime_CorrectionScheme

str solvers.api.actionsets.DGCGCoupling.AbstractDGCGCoupling.__TemplateTouchCellLastTime_CorrectionScheme

staticprivate

Definition at line 288 of file DGCGCoupling.py.

Referenced by solvers.api.actionsets.DGCGCoupling.AbstractDGCGCoupling.get_body_of_operation().

◆ __TemplateTouchCellLastTime_FAS

str solvers.api.actionsets.DGCGCoupling.AbstractDGCGCoupling.__TemplateTouchCellLastTime_FAS

staticprivate

Definition at line 172 of file DGCGCoupling.py.

Referenced by solvers.api.actionsets.DGCGCoupling.AbstractDGCGCoupling.get_body_of_operation().

◆ __TemplateTouchVertexFirstTime

str solvers.api.actionsets.DGCGCoupling.AbstractDGCGCoupling.__TemplateTouchVertexFirstTime

staticprivate

Initial value:

= """
if (
  fineGridVertex{{CG_SOLVER_NAME}}.getType() != vertexdata::{{CG_SOLVER_NAME}}::Type::Coarse
) {
  
  if ({{PREDICATE_INJECT_AND_RESTRICT}}) {
    mghype::matrixfree::solvers::dgcgcoupling::rollOverAndPrepareCGVertex( 
      fineGridVertex{{CG_SOLVER_NAME}},
      true,        // restrictRhsAndInjectSolution
      {{USE_FAS}}
    );
  }
 
 
  /*
  We aim to visit this section just before we prolongate. Passing false to
  restrictRhsAndInjectSolution has the effect of setting delta to the "value"
  parameter, ie we pick up the final solution to be interpolated during
  touchCellFirstTime.
  */
  else if ( {{PREDICATE_PROLONGATE}} ) {
    mghype::matrixfree::solvers::dgcgcoupling::rollOverAndPrepareCGVertex( 
      fineGridVertex{{CG_SOLVER_NAME}},
      false,        // restrictRhsAndInjectSolution
      {{USE_FAS}}
    );
  }
}
"""

Definition at line 91 of file DGCGCoupling.py.

Referenced by solvers.api.actionsets.DGCGCoupling.AbstractDGCGCoupling.get_body_of_operation().

◆ _use_fas

solvers.api.actionsets.DGCGCoupling.AbstractDGCGCoupling._use_fas

protected

Definition at line 468 of file DGCGCoupling.py.

Referenced by solvers.api.actionsets.DGCGCoupling.AbstractDGCGCoupling.get_body_of_operation().

◆ d

solvers.api.actionsets.DGCGCoupling.AbstractDGCGCoupling.d

Definition at line 449 of file DGCGCoupling.py.

◆ templateTouchCellFirstTime

str solvers.api.actionsets.DGCGCoupling.AbstractDGCGCoupling.templateTouchCellFirstTime

static

Definition at line 122 of file DGCGCoupling.py.

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

src/mghype/matrixfree/solvers/api/actionsets/DGCGCoupling.py

Public Member Functions

Data Fields

Static Public Attributes

Protected Attributes

Static Private Attributes

Detailed Description

Usage

Behaviour

Realisation

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ get_action_set_name()

◆ get_body_of_operation()

◆ get_includes()

◆ user_should_modify_template()

Field Documentation

◆ __TemplateTouchCellLastTime_CorrectionScheme

◆ __TemplateTouchCellLastTime_FAS

◆ __TemplateTouchVertexFirstTime

◆ _use_fas

◆ d

◆ templateTouchCellFirstTime

◆ init()