Peano

Searching...

No Matches

Probably the simplest solver you could think off. More...

Inheritance diagram for exahype2.solvers.rkfd.OneSweepPerRungeKuttaStep.OneSweepPerRungeKuttaStep:

[legend]

Collaboration diagram for exahype2.solvers.rkfd.OneSweepPerRungeKuttaStep.OneSweepPerRungeKuttaStep:

[legend]

Public Member Functions
	__init__ (self, name, patch_size, overlap, rk_order, unknowns, auxiliary_variables, min_meshcell_h, max_meshcell_h, plot_grid_properties, kernel_namespace)
	Instantiate a generic FV scheme with an overlap of 1.

	create_data_structures (self)
	Call the superclass' create_data_structures() to ensure that all the data structures are in place, i.e.

	create_action_sets (self)
	Call superclass routine and then reconfigure the update cell call.

	user_action_set_includes (self)
	Add further includes to this property, if your action sets require some additional routines from other header files.

	set_implementation (self, flux, ncp, source_term, eigenvalues, boundary_conditions, refinement_criterion, initial_conditions, memory_location, additional_action_set_includes, additional_user_includes)
	If you pass in User_Defined, then the generator will create C++ stubs that you have to befill manually.

	add_entries_to_text_replacement_dictionary (self, d)
	d: Dictionary of string to string in/out argument

Public Member Functions inherited from exahype2.solvers.rkfd.CellCenteredFiniteDifferences.CellCenteredFiniteDifferences
	__str__ (self)

	get_min_number_of_spacetree_levels (self, domain_size)

	get_max_number_of_spacetree_levels (self, domain_size)

	get_coarsest_number_of_patches (self, domain_size)

	get_finest_number_of_patches (self, domain_size)

	get_coarsest_number_of_compute_grid_cells (self, domain_size)

	get_finest_number_of_compute_grid_cells (self, domain_size)

	get_coarsest_compute_grid_cell_size (self, domain_size)

	get_finest_compute_grid_cell_size (self, domain_size)

	create_readme_descriptor (self, domain_offset, domain_size)

	user_solver_includes (self)
	Add further includes to this property, if your solver requires some additional routines from other header files.

	number_of_Runge_Kutta_steps (self)
	Return number of steps required to realise the Runge-Kutta scheme.

	add_user_action_set_includes (self, value)
	Add further includes to this property, if your action sets require some additional routines from other header files.

	add_user_solver_includes (self, value)
	Add further includes to this property, if your solver requires some additional routines from other header files.

	get_name_of_global_instance (self)

	add_to_Peano4_datamodel (self, datamodel, verbose)
	Add all required data to the Peano4 project's datamodel so it is properly built up.

	add_use_data_statements_to_Peano4_solver_step (self, step)
	Tell Peano what data to move around.

	add_actions_to_init_grid (self, step, restart_from_checkpoint=False)
	Add your actions to init grid.

	add_actions_to_create_grid (self, step, evaluate_refinement_criterion)
	The boundary information is set only once.

	plot_description (self)

	plot_description (self, description)
	Use this one to set a description within the output patch file that tells the vis solver what the semantics of the entries are.

	add_actions_to_plot_solution (self, step, output_path, restart_from_checkpoint=False)
	Add action sets to plotting grid sweep.

	add_actions_to_checkpoint_solution (self, step, output_path, restart_from_checkpoint=False)
	Add action sets to checkpoint grid sweep.

	add_actions_to_perform_time_step (self, step)
	AMR.

	add_implementation_files_to_project (self, namespace, output, dimensions, subdirectory="")
	The ExaHyPE2 project will call this operation when it sets up the overall environment.

	set_solver_constants (self, datastring)

	add_solver_constants (self, datastring)

	unknowns (self)

	patch_size (self)

	auxiliary_variables (self)

	patch_size (self, value)

	unknowns (self, value)

	auxiliary_variables (self, value)

	preprocess_reconstructed_patch (self)

	preprocess_reconstructed_patch (self, kernel)
	Please consult exahype2.solvers.fv.FV.preprocess_reconstructed_patch() for a documentation on this routine.

	name (self)

	postprocess_updated_patch (self)

	postprocess_updated_patch (self, kernel)
	Define a postprocessing routine over the data.

	overlap (self)

	overlap (self, value)

	interpolation (self)

	interpolation (self, value)
	Set the interpolation scheme.

	restriction (self)
	Set the restriction scheme.

	restriction (self, value)

	switch_storage_scheme (self, Storage cell_data_storage, Storage face_data_storage)
	By default, we hold all data on the call stacks.

Protected Attributes
	_solver_template_file_class_name

	_flux_implementation

	_ncp_implementation

	_eigenvalues_implementation

	_source_term_implementation

	_action_set_update_cell

	_name

	_boundary_conditions_implementation

	_refinement_criterion_implementation

	_initial_conditions_implementation

	_reconstructed_array_memory_location

Protected Attributes inherited from exahype2.solvers.rkfd.CellCenteredFiniteDifferences.CellCenteredFiniteDifferences
	_name

	_min_meshcell_h

	_max_meshcell_h

	_plot_grid_properties

	_patch_size

	_overlap

	_rk_order

	_use_var_shortcut

	_variable_names

	_variable_pos

	_unknowns

	_auxiliary_variables

	_solver_constants

	_user_action_set_includes

	_user_solver_includes

	_kernel_namespace

	_reconstructed_array_memory_location

	_solver_template_file_class_name

	_plot_description

	_action_set_initial_conditions

	_action_set_initial_conditions_for_grid_construction

	_action_set_AMR

	_action_set_AMR_commit_without_further_analysis

	_action_set_handle_boundary

	_action_set_project_patch_onto_faces

	_action_set_roll_over_update_of_faces

	_action_set_copy_new_faces_onto_old_faces

	_action_set_couple_resolution_transitions_and_handle_dynamic_mesh_refinement

	_action_set_postprocess_solution

	_action_set_preprocess_solution

	_compute_time_step_size

	_compute_new_time_step_size

	_preprocess_reconstructed_patch

	_postprocess_updated_patch

	_compute_kernel_call

	_compute_eigenvalue

	_abstract_solver_user_declarations

	_abstract_solver_user_definitions

	_solver_user_declarations

	_solver_user_definitions

	_start_time_step_implementation

	_finish_time_step_implementation

	_constructor_implementation

	_boundary_conditions_implementation

	_refinement_criterion_implementation

	_initial_conditions_implementation

	_interpolation

	_restriction

	_baseline_action_set_descend_invocation_order

	_patch

	_patch_estimates

	_patch_overlap_old

	_patch_overlap_new

	_patch_overlap_update

	_cell_data_storage

	_face_data_storage

	_cell_label

	_face_label

	_action_set_AMR_throughout_grid_construction

	_action_set_compute_final_linear_combination

	_action_set_update_face_label

	_action_set_update_cell_label

	_action_set_update_cell

Additional Inherited Members
Data Fields inherited from exahype2.solvers.rkfd.CellCenteredFiniteDifferences.CellCenteredFiniteDifferences
	select_dofs_to_print

Protected Member Functions inherited from exahype2.solvers.rkfd.CellCenteredFiniteDifferences.CellCenteredFiniteDifferences
	_provide_cell_data_to_compute_kernels_default_guard (self)

	_provide_face_data_to_compute_kernels_default_guard (self)

	_store_cell_data_default_guard (self)
	Extend the guard via ands only.

	_load_cell_data_default_guard (self)
	Extend the guard via ands only.

	_store_face_data_default_guard (self)
	Extend the guard via ands only.

	_load_face_data_default_guard (self)
	Extend the guard via ands only.

	_unknown_identifier (self)

	_get_default_includes (self)

	_init_dictionary_with_default_parameters (self, d)
	This one is called by all algorithmic steps before I invoke add_entries_to_text_replacement_dictionary().

Detailed Description

Probably the simplest solver you could think off.

This particular variant works only for Runge-Kutta order greater or equal to two.

:: Write your own specialisation ::

self._preprocess_reconstructed_patch Has to hold any preprocessing, but it also has to set the doubles timeStepSize and timeStamp to valid data.

self._postprocess_updated_patch You don't have to redefine this one, but if you want to alter the time step size, then this is the right place to do so. If you don't alter timeStepSize, the code will automatically continue with the current one subject to a preprocessing in the next step.

Definition at line 190 of file OneSweepPerRungeKuttaStep.py.

Constructor & Destructor Documentation

◆ init()

exahype2.solvers.rkfd.OneSweepPerRungeKuttaStep.OneSweepPerRungeKuttaStep.__init__	(	self,
		name,
		patch_size,
		overlap,
		rk_order,
		unknowns,
		auxiliary_variables,
		min_meshcell_h,
		max_meshcell_h,
		plot_grid_properties,
		kernel_namespace )

Instantiate a generic FV scheme with an overlap of 1.

Reimplemented from exahype2.solvers.rkfd.CellCenteredFiniteDifferences.CellCenteredFiniteDifferences.

Definition at line 213 of file OneSweepPerRungeKuttaStep.py.

References exahype2.solvers.rkfd.OneSweepPerRungeKuttaStep.OneSweepPerRungeKuttaStep.__init__().

Referenced by exahype2.solvers.rkfd.OneSweepPerRungeKuttaStep.OneSweepPerRungeKuttaStep.__init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ add_entries_to_text_replacement_dictionary()

exahype2.solvers.rkfd.OneSweepPerRungeKuttaStep.OneSweepPerRungeKuttaStep.add_entries_to_text_replacement_dictionary	(		self,
			d )

d: Dictionary of string to string in/out argument

Reimplemented from exahype2.solvers.rkfd.CellCenteredFiniteDifferences.CellCenteredFiniteDifferences.

Definition at line 329 of file OneSweepPerRungeKuttaStep.py.

Here is the caller graph for this function:

◆ create_action_sets()

exahype2.solvers.rkfd.OneSweepPerRungeKuttaStep.OneSweepPerRungeKuttaStep.create_action_sets ( self )

Call superclass routine and then reconfigure the update cell call.

Only the UpdateCell action set is specific to a single sweep.

This operation is implicity called via the superconstructor.

Reimplemented from exahype2.solvers.rkfd.CellCenteredFiniteDifferences.CellCenteredFiniteDifferences.

Definition at line 265 of file OneSweepPerRungeKuttaStep.py.

References exahype2.solvers.rkfd.OneSweepPerRungeKuttaStep.OneSweepPerRungeKuttaStep.create_action_sets().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ create_data_structures()

exahype2.solvers.rkfd.OneSweepPerRungeKuttaStep.OneSweepPerRungeKuttaStep.create_data_structures ( self )

Call the superclass' create_data_structures() to ensure that all the data structures are in place, i.e.

each cell can host a patch, that each face hosts patch overlaps, and so forth. These quantities are all set to defaults. See FV.create_data_structures().

After that, take the patch overlap (that's the data stored within the faces) and ensure that these are sent and received via MPI whenever they are also stored persistently. The default in FV is that no domain boundary data exchange is active. Finally, ensure that the old data is only exchanged between the initialisation sweep and the first first grid run-through.

Reimplemented from exahype2.solvers.rkfd.CellCenteredFiniteDifferences.CellCenteredFiniteDifferences.

Definition at line 233 of file OneSweepPerRungeKuttaStep.py.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ set_implementation()

exahype2.solvers.rkfd.OneSweepPerRungeKuttaStep.OneSweepPerRungeKuttaStep.set_implementation	(	self,
		flux,
		ncp,
		source_term,
		eigenvalues,
		boundary_conditions,
		refinement_criterion,
		initial_conditions,
		memory_location,
		additional_action_set_includes,
		additional_user_includes )

If you pass in User_Defined, then the generator will create C++ stubs that you have to befill manually.

If you pass in None_Implementation, it will create nop, i.e. no implementation or defaults. Any other string is copied 1:1 into the implementation. If you pass in None, then the set value so far won't be overwritten.

Definition at line 289 of file OneSweepPerRungeKuttaStep.py.

Referenced by SBH.FVSolver.__init__(), ccz4.CCZ4Solver.__init__(), CCZ4Solver.CCZ4Solver_FV_GlobalAdaptiveTimeStep.__init__(), CCZ4Solver.CCZ4Solver_FV_GlobalAdaptiveTimeStepWithEnclaveTasking.__init__(), CCZ4Solver.CCZ4Solver_FD4_GlobalAdaptiveTimeStepWithEnclaveTasking.__init__(), CCZ4Solver.CCZ4Solver_FD4_GlobalAdaptiveTimeStep.__init__(), CCZ4Solver.CCZ4Solver_RKDG_GlobalAdaptiveTimeStepWithEnclaveTasking.__init__(), and CCZ4Solver.CCZ4Solver_RKDG_GlobalAdaptiveTimeStep.__init__().

Here is the caller graph for this function: