Peano

Searching...

No Matches

The action set to realise AMR. More...

Inheritance diagram for exahype2.solvers.rkdg.actionsets.AdaptivityCriterion.AdaptivityCriterion:

[legend]

Collaboration diagram for exahype2.solvers.rkdg.actionsets.AdaptivityCriterion.AdaptivityCriterion:

[legend]

Public Member Functions
	__init__ (self, solver, guard, build_up_new_refinement_instructions, implement_previous_refinement_instructions, called_by_grid_construction, event_lifetime=2)
	:: Attributes

	get_body_of_getGridControlEvents (self)

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

	event_lifetime (self)

	event_lifetime (self, value)
	By default, a refinement/coarsening event is only alive for one grid sweep.

	get_attributes (self)
	Return attributes as copied and pasted into the generated class.

	get_action_set_name (self)
	You should replicate this function in each subclass, so you get meaningful action set names (otherwise, it will be AbstractFVActionSet0,1,2,...).

	get_includes (self)
	Return include statements that you need.

Public Member Functions inherited from exahype2.solvers.rkdg.actionsets.AbstractRungeKuttaDGActionSet.AbstractRungeKuttaDGActionSet
	user_should_modify_template (self)
	Is the user allowed to modify the output.

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
	guard

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

	parallel

Static Public Attributes
str	TemplateAMR

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
	_build_up_new_refinement_instructions

	_implement_previous_refinement_instructions

	_event_lifetime

	_called_by_grid_construction

Protected Attributes inherited from exahype2.solvers.rkdg.actionsets.AbstractRungeKuttaDGActionSet.AbstractRungeKuttaDGActionSet
	_solver

Detailed Description

The action set to realise AMR.

AMR is a multistep process in ExaHyPE. Most of the relevant documentation on it is documented in the class exahype2::RefinementControl.

There are different phases in ExaHyPE: grid generation (either with refinement or without), initialisation, plotting and time stepping. It depends on your solver in which time stepping to use AMR, but the there are some things to take into account that are in common for all schemes:

The grid creation does not use any actual solver data, so we should not evalutae the adaptivity criterion here.
InitGrid has volumetric data and might want to evaluate the criterion. This is implicitly done by the t=0 check below.
The plotting does not alter the solution. It thus makes no sense to evaluate the criterion here.

Please consult EnclaveTasking.create_action_sets for details regarding the handling of AMR within the enclave tasking concept.

Definition at line 8 of file AdaptivityCriterion.py.

Constructor & Destructor Documentation

◆ init()

exahype2.solvers.rkdg.actionsets.AdaptivityCriterion.AdaptivityCriterion.__init__	(	self,
		solver,
		guard,
		build_up_new_refinement_instructions,
		implement_previous_refinement_instructions,
		called_by_grid_construction,
		event_lifetime = 2 )

:: Attributes

_implement_previous_refinement_instructions: Boolean This name might be misleading. Consult exahype2::RefinementControl for a description of the control flow. This flag controls if instructions are picked up from the RefinementControl database.

:: Arguments

guard: C++ expression which evaluates to true or false A per cell decision whether we should study a cell or not.

build_up_new_refinement_instructions: Boolean See remarks on multistep realisation of AMR in C++ class exahype2::RefinementControl.

implement_previous_refinement_instructions: Boolean See remarks on multistep realisation of AMR in C++ class exahype2::RefinementControl.

event_lifetime: Int See setter below

Reimplemented from exahype2.solvers.rkdg.actionsets.AbstractRungeKuttaDGActionSet.AbstractRungeKuttaDGActionSet.

Definition at line 109 of file AdaptivityCriterion.py.

References exahype2.solvers.rkdg.actionsets.AdaptivityCriterion.AdaptivityCriterion.__init__().

Referenced by exahype2.solvers.rkdg.actionsets.AdaptivityCriterion.AdaptivityCriterion.__init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ event_lifetime() [1/2]

exahype2.solvers.rkdg.actionsets.AdaptivityCriterion.AdaptivityCriterion.event_lifetime ( self )

Definition at line 196 of file AdaptivityCriterion.py.

◆ event_lifetime() [2/2]

exahype2.solvers.rkdg.actionsets.AdaptivityCriterion.AdaptivityCriterion.event_lifetime	(		self,
			value )

By default, a refinement/coarsening event is only alive for one grid sweep.

After that one, the set of refine/coarsen commands is reset and we start again. If you work with local time stepping, subcycling, multiphysics codes, you might want to keep an event for more steps. In this case, you have to invoke this setter.

Definition at line 201 of file AdaptivityCriterion.py.

◆ get_action_set_name()

exahype2.solvers.rkdg.actionsets.AdaptivityCriterion.AdaptivityCriterion.get_action_set_name ( self )

You should replicate this function in each subclass, so you get meaningful action set names (otherwise, it will be AbstractFVActionSet0,1,2,...).

Reimplemented from exahype2.solvers.rkdg.actionsets.AbstractRungeKuttaDGActionSet.AbstractRungeKuttaDGActionSet.

Definition at line 220 of file AdaptivityCriterion.py.

◆ get_attributes()

exahype2.solvers.rkdg.actionsets.AdaptivityCriterion.AdaptivityCriterion.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 214 of file AdaptivityCriterion.py.

◆ get_body_of_getGridControlEvents()

exahype2.solvers.rkdg.actionsets.AdaptivityCriterion.AdaptivityCriterion.get_body_of_getGridControlEvents ( self )

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 152 of file AdaptivityCriterion.py.

References exahype2.solvers.aderdg.actionsets.AdaptivityCriterion.AdaptivityCriterion._implement_previous_refinement_instructions, exahype2.solvers.fv.actionsets.AdaptivityCriterion.AdaptivityCriterion._implement_previous_refinement_instructions, exahype2.solvers.rkdg.actionsets.AdaptivityCriterion.AdaptivityCriterion._implement_previous_refinement_instructions, and exahype2.solvers.rkfd.actionsets.AdaptivityCriterion.AdaptivityCriterion._implement_previous_refinement_instructions.

◆ get_body_of_operation()

exahype2.solvers.rkdg.actionsets.AdaptivityCriterion.AdaptivityCriterion.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 163 of file AdaptivityCriterion.py.

Here is the call graph for this function:

◆ get_includes()

exahype2.solvers.rkdg.actionsets.AdaptivityCriterion.AdaptivityCriterion.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 exahype2.solvers.rkdg.actionsets.AbstractRungeKuttaDGActionSet.AbstractRungeKuttaDGActionSet.

Definition at line 224 of file AdaptivityCriterion.py.

References exahype2.solvers.rkdg.actionsets.AdaptivityCriterion.AdaptivityCriterion.get_includes().

Referenced by exahype2.solvers.rkdg.actionsets.AdaptivityCriterion.AdaptivityCriterion.get_includes().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ _build_up_new_refinement_instructions

exahype2.solvers.rkdg.actionsets.AdaptivityCriterion.AdaptivityCriterion._build_up_new_refinement_instructions

protected

Definition at line 146 of file AdaptivityCriterion.py.

Referenced by exahype2.solvers.aderdg.actionsets.AdaptivityCriterion.AdaptivityCriterion.get_body_of_operation(), exahype2.solvers.fv.actionsets.AdaptivityCriterion.AdaptivityCriterion.get_body_of_operation(), exahype2.solvers.rkdg.actionsets.AdaptivityCriterion.AdaptivityCriterion.get_body_of_operation(), and exahype2.solvers.rkfd.actionsets.AdaptivityCriterion.AdaptivityCriterion.get_body_of_operation().

◆ _called_by_grid_construction

exahype2.solvers.rkdg.actionsets.AdaptivityCriterion.AdaptivityCriterion._called_by_grid_construction

protected

Definition at line 149 of file AdaptivityCriterion.py.

◆ _event_lifetime

exahype2.solvers.rkdg.actionsets.AdaptivityCriterion.AdaptivityCriterion._event_lifetime

protected

Definition at line 148 of file AdaptivityCriterion.py.

◆ _implement_previous_refinement_instructions

exahype2.solvers.rkdg.actionsets.AdaptivityCriterion.AdaptivityCriterion._implement_previous_refinement_instructions

protected

Definition at line 147 of file AdaptivityCriterion.py.

Referenced by exahype2.solvers.aderdg.actionsets.AdaptivityCriterion.AdaptivityCriterion.get_body_of_getGridControlEvents(), exahype2.solvers.fv.actionsets.AdaptivityCriterion.AdaptivityCriterion.get_body_of_getGridControlEvents(), exahype2.solvers.rkdg.actionsets.AdaptivityCriterion.AdaptivityCriterion.get_body_of_getGridControlEvents(), and exahype2.solvers.rkfd.actionsets.AdaptivityCriterion.AdaptivityCriterion.get_body_of_getGridControlEvents().

◆ guard

exahype2.solvers.rkdg.actionsets.AdaptivityCriterion.AdaptivityCriterion.guard

Definition at line 145 of file AdaptivityCriterion.py.

◆ TemplateAMR

str exahype2.solvers.rkdg.actionsets.AdaptivityCriterion.AdaptivityCriterion.TemplateAMR

static

Definition at line 34 of file AdaptivityCriterion.py.

Referenced by exahype2.solvers.fv.actionsets.AdaptivityCriterion.AdaptivityCriterion.get_body_of_operation(), exahype2.solvers.rkdg.actionsets.AdaptivityCriterion.AdaptivityCriterion.get_body_of_operation(), and exahype2.solvers.rkfd.actionsets.AdaptivityCriterion.AdaptivityCriterion.get_body_of_operation().

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

python/exahype2/solvers/rkdg/actionsets/AdaptivityCriterion.py

Public Member Functions

Data Fields

Static Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ event_lifetime() [1/2]

◆ event_lifetime() [2/2]

◆ get_action_set_name()

◆ get_attributes()

◆ get_body_of_getGridControlEvents()

◆ get_body_of_operation()

◆ get_includes()

Field Documentation

◆ _build_up_new_refinement_instructions

◆ _called_by_grid_construction

◆ _event_lifetime

◆ _implement_previous_refinement_instructions

◆ guard

◆ TemplateAMR

◆ init()