Peano

Searching...

No Matches

Init the degrees of freedom of a higher order scheme where nodes sit in cells. More...

Inheritance diagram for solvers.api.actionsets.InitHigherOrderDofs.InitHigherOrderDofs:

[legend]

Collaboration diagram for solvers.api.actionsets.InitHigherOrderDofs.InitHigherOrderDofs:

[legend]

Public Member Functions
	__init__ (self, solver)
	Configure the initialisation 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

str	templateTouchFaceFirstTime

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

Init the degrees of freedom of a higher order scheme where nodes sit in cells.

This action set is usually only used throughout the initialisation, i.e. once all mesh cells are in place. However, you we can also use it for dynamic AMR later on (not implemented yet).

Cell initialisation

The routine loops over the nodes within the cell, computes the location and invokes the solver's initialisation routine. As much knowledge (such as spacing of the integration points) as possible is kept in the C++ code to keep this routine lightweight.

Face initialisation

The faces do not need an initialisation. It is the job of the very first projection to assign them valid data. Indeed, they can hold garbage. The very first compute of the numerical flux then yields garbage, too. But projecting garbage into the cell just means another initial guess for the cell data, and the solver should converge nevertheless.

However, we have encountered situations where the faces' garbage held NaN, and these NaNs then somehow propagated through the solver and polluted all the outcomes. Therefore, we initialise the faces to zero by default.

Definition at line 9 of file InitHigherOrderDofs.py.

Constructor & Destructor Documentation

◆ init()

solvers.api.actionsets.InitHigherOrderDofs.InitHigherOrderDofs.__init__	(		self,
			solver )

Configure the initialisation action set.

Parameters

solver The underlying higher-order solver We will use it to read out information such as the polynomial degree. See remarks on template realisation.

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 148 of file InitHigherOrderDofs.py.

References solvers.api.actionsets.InitHigherOrderDofs.InitHigherOrderDofs.__init__().

Referenced by solvers.api.actionsets.InitHigherOrderDofs.InitHigherOrderDofs.__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.InitHigherOrderDofs.InitHigherOrderDofs.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 176 of file InitHigherOrderDofs.py.

◆ get_body_of_operation()

solvers.api.actionsets.InitHigherOrderDofs.InitHigherOrderDofs.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 166 of file InitHigherOrderDofs.py.

◆ get_includes()

solvers.api.actionsets.InitHigherOrderDofs.InitHigherOrderDofs.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 200 of file InitHigherOrderDofs.py.

◆ user_should_modify_template()

solvers.api.actionsets.InitHigherOrderDofs.InitHigherOrderDofs.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 190 of file InitHigherOrderDofs.py.

Field Documentation

◆ d

solvers.api.actionsets.InitHigherOrderDofs.InitHigherOrderDofs.d

Definition at line 161 of file InitHigherOrderDofs.py.

◆ templateTouchCellFirstTime

str solvers.api.actionsets.InitHigherOrderDofs.InitHigherOrderDofs.templateTouchCellFirstTime

static

Definition at line 40 of file InitHigherOrderDofs.py.

◆ templateTouchFaceFirstTime

str solvers.api.actionsets.InitHigherOrderDofs.InitHigherOrderDofs.templateTouchFaceFirstTime

static

Definition at line 97 of file InitHigherOrderDofs.py.

Referenced by UpdateFacets.UpdateFacets.get_body_of_operation(), solvers.api.actionsets.DGSolver.UpdateFaceSolution.UpdateFaceSolution.get_body_of_operation(), solvers.api.actionsets.InitHigherOrderDofs.InitHigherOrderDofs.get_body_of_operation(), and InitDG.InitDofsDGTest1.get_body_of_operation().

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

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

Public Member Functions

Data Fields

Static Public Attributes

Detailed Description

Cell initialisation

Face initialisation

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

◆ templateTouchFaceFirstTime

◆ init()