Peano

Searching...

No Matches

A finite volume solver. More...

Inheritance diagram for SBH.FVSolver:

[legend]

Collaboration diagram for SBH.FVSolver:

[legend]

Public Member Functions
	__init__ (self, name, patch_size, min_cell_size, max_cell_size)
	Construct the Finite Volume solver.

	create_action_sets (self)
	Tailor action set behaviour.

Public Member Functions inherited from CCZ4Solver.CCZ4Solver_FV_GlobalAdaptiveTimeStepWithEnclaveTasking
	add_tracer (self, name, coordinates, project, number_of_entries_between_two_db_flushes, data_delta_between_two_snapsots, time_delta_between_two_snapsots, clear_database_after_flush, tracer_unknowns)
	Add tracer to project.

Public Member Functions inherited from CCZ4Solver.AbstractCCZ4Solver
	enable_second_order (self)

	add_all_solver_constants (self)
	Add domain-specific constants.

	add_makefile_parameters (self, peano4_project, path_of_ccz4_application)
	Add include path and minimal required cpp files to makefile.

Public Member Functions inherited from exahype2.solvers.fv.rusanov.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking
	set_implementation (self, flux=None, ncp=None, eigenvalues=None, boundary_conditions=None, refinement_criterion=None, initial_conditions=None, source_term=None, memory_location=None, use_split_loop=False, 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.

	create_data_structures (self)
	This routine does not really add new data, but it heavily tailors when data are stored, exchanged, ... Each generator has some guard attributes, i.e., some guards, which control when data is stored, sent, received.

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

Public Member Functions inherited from exahype2.solvers.fv.EnclaveTasking.EnclaveTasking
	add_entries_to_text_replacement_dictionary (self, d)
	d: Dictionary of string to string in/out argument

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

	add_actions_to_init_grid (self, step)
	Add all the action sets to init grid.

	add_actions_to_perform_time_step (self, step)
	Add enclave aspect to time stepping.

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

	switch_storage_scheme (self, Storage cell_data_storage, Storage face_data_storage)
	By default, we hold all data on the heap using smart pointers.

Public Member Functions inherited from exahype2.solvers.fv.FV.FV
	__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_finite_volumes (self, domain_size)

	get_finest_number_of_finite_volumes (self, domain_size)

	get_coarsest_volume_size (self, domain_size)

	get_finest_volume_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.

	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 Peano 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.

	plot_description (self)

	plot_description (self, description)
	Add a proper description to the plots.

	add_actions_to_plot_solution (self, step, output_path, restart_from_checkpoint=False)
	Add action sets to plot solution step.

	add_actions_to_checkpoint_solution (self, step, output_path, restart_from_checkpoint=False)
	Add action sets to plot solution step.

	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)
	Set a new processing kernel.

	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)

	restriction (self)

	restriction (self, value)

Protected Attributes
	_auxiliary_variables

Protected Attributes inherited from exahype2.solvers.fv.rusanov.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking
	_time_step_relaxation

	_flux_implementation

	_ncp_implementation

	_eigenvalues_implementation

	_source_term_implementation

	_compute_eigenvalue

	_compute_kernel_call

	_compute_kernel_call_stateless

	_fused_compute_kernel_call_stateless_cpu

	_fused_compute_kernel_call_stateless_gpu

	_abstract_solver_user_declarations

	_abstract_solver_user_definitions

	_solver_user_declarations

	_solver_user_definitions

	_compute_time_step_size

	_compute_new_time_step_size

	_start_time_step_implementation

	_finish_time_step_implementation

	_constructor_implementation

Protected Attributes inherited from exahype2.solvers.fv.EnclaveTasking.EnclaveTasking
	_name

	_fused_compute_kernel_call_stateless_cpu

	_fused_compute_kernel_call_stateless_gpu

	_solver_template_file_class_name

	_initialisation_sweep_guard

	_first_iteration_after_initialisation_guard

	_primary_sweep_guard

	_primary_sweep_or_plot_guard

	_primary_or_initialisation_sweep_guard

	_primary_or_grid_construction_or_initialisation_sweep_guard

	_secondary_sweep_guard

	_secondary_sweep_or_grid_construction_guard

	_secondary_sweep_or_grid_initialisation_guard

	_secondary_sweep_or_grid_initialisation_or_plot_guard

	_action_set_update_cell

	_action_set_merge_enclave_task_outcome

	_boundary_conditions_implementation

	_refinement_criterion_implementation

	_initial_conditions_implementation

	_reconstructed_array_memory_location

	_use_split_loop

Protected Attributes inherited from exahype2.solvers.fv.FV.FV
	_name

	_min_volume_h

	_max_volume_h

	_plot_grid_properties

	_patch_size

	_overlap

	_use_var_shortcut

	_variable_names

	_variable_pos

	_unknowns

	_auxiliary_variables

	_solver_constants

	_user_action_set_includes

	_user_solver_includes

	_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_throughout_grid_construction

	_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_kernel_call_stateless

	_pde_terms_without_state

	_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

	_kernel_namespace

	_baseline_action_set_descend_invocation_order

	_cell_data_storage

	_face_data_storage

	_eigenvalues_implementation

	_flux_implementation

	_ncp_implementation

	_source_term_implementation

	_patch

	_patch_overlap_old

	_patch_overlap_new

	_patch_overlap_update

	_cell_label

	_face_label

	_action_set_update_face_label

	_action_set_update_cell_label

	_action_set_update_cell

Additional Inherited Members
Data Fields inherited from CCZ4Solver.AbstractCCZ4Solver
	integer_constants

	double_constants

	Default_Time_Step_Size_Relaxation

Data Fields inherited from exahype2.solvers.fv.EnclaveTasking.EnclaveTasking
	enclave_task_priority

	make_copy_of_enclave_task_data

Data Fields inherited from exahype2.solvers.fv.FV.FV
	select_dofs_to_print

Static Public Attributes inherited from CCZ4Solver.AbstractCCZ4Solver
float	Default_Time_Step_Size_Relaxation = 0.1

Protected Member Functions inherited from CCZ4Solver.AbstractCCZ4Solver
	_add_standard_includes (self)
	Add the headers for the compute kernels and initial condition implementations.

Protected Member Functions inherited from exahype2.solvers.fv.EnclaveTasking.EnclaveTasking
	_create_guards (self)
	All the internal logic depends on guards, i.e., boolean predicates.

	_optimise_patch_storage_for_global_time_stepping (self)
	Make storage and loading more restrictive such that enclave data are not held in-between primary and secondary sweep.

	_enclave_task_name (self)

Protected Member Functions inherited from exahype2.solvers.fv.FV.FV
	_provide_cell_data_to_compute_kernels_default_guard (self)
	Default logic when to create cell data or not.

	_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().

Static Protected Attributes inherited from CCZ4Solver.AbstractCCZ4Solver
dict	_FO_formulation_unknowns

dict	_SO_formulation_unknowns

Detailed Description

A finite volume solver.

This solver is not appropriate to simulate black holes as a stand-alone solver, as it is way too diffusive. If you use it without another scheme, you typically see the black hole disappear after a brief period. So we have it in here merely for performance tests.

Definition at line 700 of file SBH.py.

Constructor & Destructor Documentation

◆ init()

SBH.FVSolver.__init__	(	self,
		name,
		patch_size,
		min_cell_size,
		max_cell_size )

Construct the Finite Volume solver.

Parameters

patch_size	Integer Defines how big the individual patches are. If you pass in 10, each Finite Volume patch will have the dimensions 10x10x10.
min_cell_size	Float This parameter refers to the cell size, i.e. the size of a whole patch. We use this one here, to make the signature the same as for the FD and DG solver variants. The superclass constructor argues over finite volume sizes, and we hence have to recalibrate this parameter with patch_size.

Reimplemented from CCZ4Solver.CCZ4Solver_FV_GlobalAdaptiveTimeStepWithEnclaveTasking.

Definition at line 712 of file SBH.py.

Referenced by SBH.FVSolver.__init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ create_action_sets()

SBH.FVSolver.create_action_sets ( self )

Tailor action set behaviour.

We first make a few additional cells skeleton cells. The rationale behind additional skeletons is given in the generic overview. Given the first remark there on FD4-FV coupling, one would be tempted to use the predicate

self._action_set_update_cell.additional_skeleton_guard = " " "(
  repositories::instanceOf" " " + self._name_without_FD4_extension + " " "_FV.isCellOverlappingWithBHImpactArea(marker)
  and
  not repositories::instanceOf" " " + self._name_without_FD4_extension + " " "_FV.areAllFaceConnectedCellsOverlappingWithBHImpactArea(marker)
)
" " "