Peano

Searching...

No Matches

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

Inheritance diagram for exahype2.solvers.rkdg.SeparateSweeps.SeparateSweeps:

[legend]

Collaboration diagram for exahype2.solvers.rkdg.SeparateSweeps.SeparateSweeps:

[legend]

Public Member Functions
	__init__ (self, name, rk_order, polynomial_basis, number_of_face_projections, unknowns, auxiliary_variables, min_cell_h, max_cell_h, plot_grid_properties, pde_terms_without_state)
	The super call invokes the creation of the data sets, where the guards have to be known already.

	create_data_structures (self)
	First, call the superclass' create_data_structures() to ensure that all the data structures are in place.

	create_action_sets (self)
	We invoke the superclass which creates all the action sets, and then we set the appropriate guards.

Public Member Functions inherited from exahype2.solvers.rkdg.RungeKuttaDG.RungeKuttaDG
	__str__ (self)

	get_min_number_of_spacetree_levels (self, domain_size)

	get_max_number_of_spacetree_levels (self, domain_size)

	get_coarsest_number_of_cells (self, domain_size)

	get_finest_number_of_cells (self, domain_size)

	create_readme_descriptor (self, domain_offset, domain_size)

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

	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 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)
	Add the action sets to the grid initialisation.

	add_actions_to_create_grid (self, step, evaluate_refinement_criterion)

	set_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)
	Dump snapshot of solution.

	add_actions_to_perform_time_step (self, step)
	The tricky part here is that we have to get the order right.

	add_entries_to_text_replacement_dictionary (self, d)

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

	set_solver_constants (self, datastring)

	add_solver_constants (self, datastring)

	unknowns (self)

	auxiliary_variables (self)

	unknowns (self, value)

	auxiliary_variables (self, value)

	number_of_Runge_Kutta_steps (self)

	set_implementation (self, flux=None, ncp=None, eigenvalues=None, boundary_conditions=None, refinement_criterion=None, initial_conditions=None, source_term=None, point_source=None, 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.

	postprocess_updated_cell_after_Runge_Kutta_step (self)

	postprocess_updated_cell_after_final_linear_combination (self)

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

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

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

Protected Attributes
	_name

	_rk_order

	_initialisation_sweep_guard

	_first_iteration_after_initialisation_guard

	_primary_sweeps_of_Runge_Kutta_step_on_cell

	_secondary_sweeps_of_Runge_Kutta_step_on_cell

	_primary_sweeps_of_Runge_Kutta_step_on_face

	_secondary_sweeps_of_Runge_Kutta_step_on_face

	_any_primary_sweep_of_a_Runge_Kutta_step_on_cell

	_any_secondary_sweep_of_a_Runge_Kutta_step_on_cell

	_any_primary_sweep_of_a_Runge_Kutta_step_on_face

	_any_secondary_sweep_of_a_Runge_Kutta_step_on_face

	_solver_template_file_class_name

Protected Attributes inherited from exahype2.solvers.rkdg.RungeKuttaDG.RungeKuttaDG
	_name

	_rk_order

	_basis

	_face_projections

	_volumetric_compute_kernel_call

	_volumetric_compute_kernel_call_stateless

	_Riemann_compute_kernel_call

	_Riemann_compute_kernel_call_stateless

	_pde_terms_without_state

	_add_solver_contributions_call

	_multiply_with_inverted_mass_matrix_call

	_kernel_namespace

	_use_var_shortcut

	_variable_names

	_variable_pos

	_unknowns

	_auxiliary_variables

	_min_cell_h

	_max_cell_h

	_plot_grid_properties

	_solver_constants

	_user_action_set_includes

	_user_solver_includes

	_solver_template_file_class_name

	_action_set_postprocess_solution

	_action_set_preprocess_solution

	_compute_eigenvalue

	_compute_time_step_size

	_compute_new_time_step_size

	_preprocess_cell

	_postprocess_updated_cell_after_Runge_Kutta_step

	_postprocess_updated_cell_after_final_linear_combination

	_flux_implementation

	_ncp_implementation

	_eigenvalues_implementation

	_source_term_implementation

	_point_sources_implementation

	_boundary_conditions_implementation

	_refinement_criterion_implementation

	_initial_conditions_implementation

	_abstract_solver_user_declarations

	_abstract_solver_user_definitions

	_solver_user_declarations

	_solver_user_definitions

	_start_time_step_implementation

	_finish_time_step_implementation

	_constructor_implementation

	_cell_data_storage

	_face_data_storage

	_baseline_action_set_descend_invocation_order

	_current_time_step

	_rhs_estimates

	_linear_combination_of_estimates

	_estimate_projection

	_old_solution_projection

	_Riemann_solution

	_cell_label

	_face_label

	_action_set_initial_conditions

	_action_set_initial_conditions_for_grid_construction

	_action_set_AMR

	_action_set_AMR_commit_without_further_analysis

	_action_set_AMR_throughout_grid_construction

	_action_set_linear_combination_of_estimates

	_action_set_project_linear_combination_onto_faces

	_action_set_solve_volume_integral

	_action_set_handle_boundary

	_action_set_solve_Riemann_problem

	_action_set_add_volume_and_face_solution

	_action_set_compute_final_linear_combination_and_project_solution_onto_faces

	_action_set_couple_resolution_transitions_and_handle_dynamic_mesh_refinement

	_action_set_update_face_label

	_action_set_update_cell_label

Additional Inherited Members
Data Fields inherited from exahype2.solvers.rkdg.RungeKuttaDG.RungeKuttaDG
	plot_description

	select_dofs_to_print

Protected Member Functions inherited from exahype2.solvers.rkdg.RungeKuttaDG.RungeKuttaDG
	_query_fine_grid_cell_in_action_set_if_it_holds_solution (self)

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

We run over the grid twice per Runge-Kutta step. In the first step, we compute the linear reconstruction, project this one onto the faces and also compute the volumetric prediction. In the second step, we solve the Riemann problem and add it to the prediction.

In the attribute terminology, we call the two runs over the grid sweeps, i.e., we work with two grid sweeps per Runge-Kutta step.

Definition at line 14 of file SeparateSweeps.py.

Constructor & Destructor Documentation

◆ init()

exahype2.solvers.rkdg.SeparateSweeps.SeparateSweeps.__init__	(	self,
		name,
		rk_order,
		polynomial_basis,
		number_of_face_projections,
		unknowns,
		auxiliary_variables,
		min_cell_h,
		max_cell_h,
		plot_grid_properties,
		pde_terms_without_state )

The super call invokes the creation of the data sets, where the guards have to be known already.

So we bring those guys forward and then call the superclass constructor.

Reimplemented from exahype2.solvers.rkdg.RungeKuttaDG.RungeKuttaDG.

Reimplemented in create-dg-benchmark-executable-with-limiter.MyDGSolver, exahype2.solvers.rkdg.SeparateSweepsWithEnclaveTasking.SeparateSweepsWithEnclaveTasking, CCZ4Solver.CCZ4Solver_RKDG_GlobalAdaptiveTimeStepWithEnclaveTasking, CCZ4Solver.CCZ4Solver_RKDG_GlobalAdaptiveTimeStep, exahype2.solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep, exahype2.solvers.rkdg.rusanov.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking, and exahype2.solvers.rkdg.rusanov.GlobalFixedTimeStep.GlobalFixedTimeStep.

Definition at line 26 of file SeparateSweeps.py.

Member Function Documentation

◆ create_action_sets()

exahype2.solvers.rkdg.SeparateSweeps.SeparateSweeps.create_action_sets ( self )

We invoke the superclass which creates all the action sets, and then we set the appropriate guards.

_action_set_update_face_label - can be done always
_action_set_update_cell_label - can be done always
_action_set_linear_combination_of_estimates - primary sweeps only, as these kick off the Runge-Kutta step.
_action_set_couple_resolution_transitions_and_handle_dynamic_mesh_refinement - primary only, as the secondary step is a sole clean-up
_action_set_project_linear_combination_onto_faces - only required in primary sweep. In the secondary, we collect the results together, i.e., we don't immediately need the boundary data anymore.
_action_set_solve_volume_integral - only done in the primary sweep.
_action_set_handle_boundary - only in secondary sweep, as we now have access to the left and right face data and hence can invoke the Riemann solver.
_action_set_solve_Riemann_problem - secondary sweep. See discussion of previous item.
_action_set_add_volume_and_face_solution - secondary sweep. The Riemann solve plugs into the first touch of a face in the secondary sweep, so now we can sum up the solutions.
_action_set_compute_final_linear_combination_and_project_solution_onto_faces - very last secondary sweep.
_action_set_AMR - very last secondary sweep, i.e., after we have the final solution.
_action_set_postprocess_solution - same as for item above.

:: Guards around linear combination of estimates

We rely on the action set LinearCombination as it is initialised in the superclass. So the only thing we have to do is to ensure that the linear combination over the estimates is computed if and only if this is required. For the separate sweeps, we compute the linear combinations if the cell holds data, i.e., is on the finest level, and if it is the primary of the two sweeps which realise a RK step, i.e., the one where we later on project onto the faces.