Setup over a regular mesh which is then refined adaptively by the user's adaptivity criterion. More...

Inheritance diagram for exahype2.api.fv.SetupSimulationWithUserCodedRefinementCriterion.SetupSimulationWithUserCodedRefinementCriterion:

[legend]

Collaboration diagram for exahype2.api.fv.SetupSimulationWithUserCodedRefinementCriterion.SetupSimulationWithUserCodedRefinementCriterion:

[legend]

Public Member Functions
	__init__ (self, Solver solver, float volume_size, float min_volume_size)

	construct_output (self, exahype2_project, peano_project, setup_simulation)
	Construct the setup over the regular mesh and insert the mesh adaptation after it, if the solver has an adaptivity criterion.

Data Fields
	min_volume_size

Data Fields inherited from exahype2.api.fv.SetupSimulationOverRegularGrid.SetupSimulationOverRegularGrid
	volume_size

	FinishedInitialRegularMeshSetup

Static Public Attributes
tuple	RepeatCondition
	Repeat condition of the mesh adaptation task.

Static Public Attributes inherited from exahype2.api.fv.SetupSimulationOverRegularGrid.SetupSimulationOverRegularGrid
str	FinishedInitialRegularMeshSetup = "exahype2.api.fv.SetupSimulationOverRegularGrid.FinishedInitialRegularMeshSetup"
	Tag of the task which completes the setup over the initial regular mesh.

Protected Member Functions
	_create_adapt_mesh_task (self)
	Create the repeating task which adapts the mesh.

Protected Member Functions inherited from exahype2.api.fv.SetupSimulationOverRegularGrid.SetupSimulationOverRegularGrid
	_construct_task_graph (self, exahype2_project, peano_project, setup_simulation)
	Add the tasks of the setup over a regular mesh to setup_simulation.

	_report_task_graph (self, setup_simulation)
	Visualise or log the setup task graph, depending on the logger's verbosity.

Protected Attributes
	_solver

Protected Attributes inherited from exahype2.api.fv.SetupSimulationOverRegularGrid.SetupSimulationOverRegularGrid
	_solver
	On adaptive meshes, restrict the fine data from the hanging faces onto the coarse faces.

Protected Attributes inherited from exahype2.api.Solver.Solver.GridConstruction
	_solver

Detailed Description

Setup over a regular mesh which is then refined adaptively by the user's adaptivity criterion.

The setup does everything SetupSimulationOverRegularGrid does: It constructs a regular mesh and sets the initial condition. If the solver has an exahype2.api.AdaptivityCriterion PDE term, the setup then adapts this mesh. It inserts one further task after the task tagged with SetupSimulationOverRegularGrid.FinishedInitialRegularMeshSetup, i.e. after the initial condition. The projection onto the faces, which has followed the initial condition so far, follows this new task instead and hence remains the very last task of the setup.

The new task repeats until the mesh is stationary. It hosts two action sets:

The action set which also evaluates the criterion within the time step (exahype2.api.blockstructured.create_dynamic_mesh_refinement_action_set.create_dynamic_mesh_refinement_action_set()) turns the criterion's outcome into refine or erase events for ExaHyPE's refinement service. Different to the time step, it also hands the service's events over to Peano. The mesh is never refined below min_volume_size. The setup vetoes all erase commands, i.e. it only ever refines the regular mesh: It has no restriction which would hand the patches of erased cells over to their parent. Erase commands of the criterion hence only take effect once the time stepping runs.
exahype2.api.fv.actionsets.InitialiseNewCells sets the initial condition within each cell which the refinement creates.

Without an adaptivity criterion, the setup is the same as SetupSimulationOverRegularGrid.

Peano realises a refinement event one to two mesh sweeps after the criterion has asked for it (exahype2::RefinementControl). The mesh hence might still be stationary in the sweeps right after the criterion has issued an event. The task therefore repeats as long as the mesh changes or the refinement service still holds events.

Definition at line 14 of file SetupSimulationWithUserCodedRefinementCriterion.py.

Constructor & Destructor Documentation

◆ init()

exahype2.api.fv.SetupSimulationWithUserCodedRefinementCriterion.SetupSimulationWithUserCodedRefinementCriterion.__init__	(		self,
		Solver	solver,
		float	volume_size,
		float	min_volume_size
	)

Parameters

volume_size	float Maximum edge length of one Finite Volume. The setup first constructs a regular mesh with this volume size (exahype2.api.fv.SetupSimulationOverRegularGrid). The mesh refinement never erases cells of this regular mesh.
min_volume_size	float Minimum edge length of one Finite Volume. The setup refines a cell only if its volumes are at least of this size, i.e. the resulting volumes are strictly smaller than min_volume_size. The semantics are the same as for volume_size.

Reimplemented from exahype2.api.fv.SetupSimulationOverRegularGrid.SetupSimulationOverRegularGrid.

Definition at line 56 of file SetupSimulationWithUserCodedRefinementCriterion.py.

References exahype2.api.fv.SetupSimulationWithUserCodedRefinementCriterion.SetupSimulationWithUserCodedRefinementCriterion.__init__().

Referenced by exahype2.api.fv.SetupSimulationWithUserCodedRefinementCriterion.SetupSimulationWithUserCodedRefinementCriterion.__init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ _create_adapt_mesh_task()

exahype2.api.fv.SetupSimulationWithUserCodedRefinementCriterion.SetupSimulationWithUserCodedRefinementCriterion._create_adapt_mesh_task ( self )

protected

Create the repeating task which adapts the mesh.

Definition at line 110 of file SetupSimulationWithUserCodedRefinementCriterion.py.

◆ construct_output()

exahype2.api.fv.SetupSimulationWithUserCodedRefinementCriterion.SetupSimulationWithUserCodedRefinementCriterion.construct_output	(	self,
		exahype2_project,
		peano_project,
		setup_simulation
	)

Construct the setup over the regular mesh and insert the mesh adaptation after it, if the solver has an adaptivity criterion.

Reimplemented from exahype2.api.fv.SetupSimulationOverRegularGrid.SetupSimulationOverRegularGrid.

Definition at line 85 of file SetupSimulationWithUserCodedRefinementCriterion.py.

References exahype2.api.fv.SetupSimulationOverRegularGrid.SetupSimulationOverRegularGrid._construct_task_graph().

Here is the call graph for this function:

Field Documentation

◆ _solver

exahype2.api.fv.SetupSimulationWithUserCodedRefinementCriterion.SetupSimulationWithUserCodedRefinementCriterion._solver

protected

Definition at line 97 of file SetupSimulationWithUserCodedRefinementCriterion.py.

◆ min_volume_size

exahype2.api.fv.SetupSimulationWithUserCodedRefinementCriterion.SetupSimulationWithUserCodedRefinementCriterion.min_volume_size

Definition at line 77 of file SetupSimulationWithUserCodedRefinementCriterion.py.

Referenced by exahype2.api.fv.SetupSimulationWithUserCodedRefinementCriterion.SetupSimulationWithUserCodedRefinementCriterion._create_adapt_mesh_task(), exahype2.api.fv.RusanovWithExplicitEuler.RusanovWithExplicitEuler.construct_output(), exahype2.api.fv.RusanovWithOptimisticExplicitEuler.RusanovWithOptimisticExplicitEuler.construct_output(), and exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement.get_body_of_operation().

◆ RepeatCondition

tuple exahype2.api.fv.SetupSimulationWithUserCodedRefinementCriterion.SetupSimulationWithUserCodedRefinementCriterion.RepeatCondition

static

Initial value:

=  (
        "not peano4::grid::isGridStationary( peano4::parallel::SpacetreeSet::getInstance().getGridStatistics() )"
        " or not ::exahype2::RefinementControlService::getInstance().createGridControlEventsForNextTraversal().empty()"
    )

Repeat condition of the mesh adaptation task.

Definition at line 80 of file SetupSimulationWithUserCodedRefinementCriterion.py.

Referenced by exahype2.api.fv.SetupSimulationWithUserCodedRefinementCriterion.SetupSimulationWithUserCodedRefinementCriterion._create_adapt_mesh_task(), and exahype2.api.blockstructured.AdaptMeshAndBalanceLoad.AdaptMeshAndBalanceLoad.construct_output().

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

src/exahype2/api/fv/SetupSimulationWithUserCodedRefinementCriterion.py

Public Member Functions

Data Fields

Static Public Attributes

Protected Member Functions

Protected Attributes