Peano
Loading...
Searching...
No Matches
exahype2.solvers.rkdg.rusanov.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking Class Reference

RKDG solver with global adaptive time step. More...

Inheritance diagram for exahype2.solvers.rkdg.rusanov.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking:
Collaboration diagram for exahype2.solvers.rkdg.rusanov.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking:

Public Member Functions

 __init__ (self, name, rk_order, polynomials, unknowns, auxiliary_variables, min_cell_h, max_cell_h, time_step_relaxation, flux=PDETerms.User_Defined_Implementation, eigenvalues=PDETerms.User_Defined_Implementation, ncp=PDETerms.None_Implementation, point_source=PDETerms.None_Implementation, boundary_conditions=PDETerms.User_Defined_Implementation, refinement_criterion=PDETerms.Empty_Implementation, initial_conditions=PDETerms.User_Defined_Implementation, source_term=PDETerms.None_Implementation, plot_grid_properties=False, pde_terms_without_state=False)
 Construct RKDG solver with adaptive global time step and enclave tasking.
 
 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.
 
 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.rkdg.SeparateSweepsWithEnclaveTasking.SeparateSweepsWithEnclaveTasking
 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)
 Call superclass routine and then reconfigure the update cell call.
 
 add_implementation_files_to_project (self, namespace, output, dimensions, subdirectory="")
 The ExaHyPE project will call this operation when it sets up the overall environment.
 
 add_actions_to_perform_time_step (self, step)
 Add enclave aspect to time stepping.
 
 add_entries_to_text_replacement_dictionary (self, d)
 
 switch_storage_scheme (self, Storage cell_data_storage, Storage face_data_storage)
 By default, we hold all data on the call stacks.
 
- 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_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.
 
 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)
 
 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.
 

Protected Attributes

 _time_step_relaxation
 
 _compute_eigenvalue
 
 _kernel_namespace
 
 _volumetric_compute_kernel_call
 
 _volumetric_compute_kernel_call_stateless
 
 _Riemann_compute_kernel_call
 
 _fused_volumetric_compute_kernel_call_stateless_cpu
 
 _fused_volumetric_compute_kernel_call_stateless_gpu
 
 _add_solver_contributions_call
 
 _multiply_with_inverted_mass_matrix_call
 
 _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.rkdg.SeparateSweepsWithEnclaveTasking.SeparateSweepsWithEnclaveTasking
 _solver_template_file_class_name
 
 _pde_terms_without_state
 
 _fused_volumetric_compute_kernel_call_stateless_cpu
 
 _fused_volumetric_compute_kernel_call_stateless_gpu
 
 _fused_Riemann_compute_kernel_call_stateless_cpu
 
 _fused_Riemann_compute_kernel_call_stateless_gpu
 
 _action_set_merge_enclave_task_outcome
 
 _name
 
- Protected Attributes inherited from exahype2.solvers.rkdg.SeparateSweeps.SeparateSweeps
 _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.SeparateSweepsWithEnclaveTasking.SeparateSweepsWithEnclaveTasking
 enclave_task_priority
 
 make_copy_of_enclave_task_data
 
- Data Fields inherited from exahype2.solvers.rkdg.RungeKuttaDG.RungeKuttaDG
 plot_description
 
 select_dofs_to_print
 
- Protected Member Functions inherited from exahype2.solvers.rkdg.SeparateSweepsWithEnclaveTasking.SeparateSweepsWithEnclaveTasking
 _volumetric_solver_enclave_task_name (self)
 
- 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

RKDG solver with global adaptive time step.

Please consult GlobalAdaptiveTimeStep for more documentation. This version is basically the same with the "only" exception being that we employ enclave tasking here.

Definition at line 23 of file GlobalAdaptiveTimeStepWithEnclaveTasking.py.

Constructor & Destructor Documentation

◆ __init__()

exahype2.solvers.rkdg.rusanov.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking.__init__ ( self,
name,
rk_order,
polynomials,
unknowns,
auxiliary_variables,
min_cell_h,
max_cell_h,
time_step_relaxation,
flux = PDETerms.User_Defined_Implementation,
eigenvalues = PDETerms.User_Defined_Implementation,
ncp = PDETerms.None_Implementation,
point_source = PDETerms.None_Implementation,
boundary_conditions = PDETerms.User_Defined_Implementation,
refinement_criterion = PDETerms.Empty_Implementation,
initial_conditions = PDETerms.User_Defined_Implementation,
source_term = PDETerms.None_Implementation,
plot_grid_properties = False,
pde_terms_without_state = False )

Member Function Documentation

◆ set_implementation()

exahype2.solvers.rkdg.rusanov.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking.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.

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.

Please note that not all options are supported by all solvers.

This routine should be the very last invoked by the constructor.

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

Definition at line 97 of file GlobalAdaptiveTimeStepWithEnclaveTasking.py.

References exahype2.solvers.fv.AdaptiveSubcyclingTimeSteppingCodeSnippets.AdaptiveSubcyclingTimeSteppingCodeSnippets._time_step_relaxation, exahype2.solvers.fv.AdaptiveTimeSteppingCodeSnippets.AdaptiveTimeSteppingCodeSnippets._time_step_relaxation, exahype2.solvers.fv.LocalTimeSteppingCodeSnippets.LocalTimeSteppingCodeSnippets._time_step_relaxation, exahype2.solvers.fv.musclhancock.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep._time_step_relaxation, exahype2.solvers.fv.riemann.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep._time_step_relaxation, exahype2.solvers.fv.riemann.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking._time_step_relaxation, exahype2.solvers.fv.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep._time_step_relaxation, exahype2.solvers.fv.rusanov.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking._time_step_relaxation, exahype2.solvers.fv.rusanov.LocalTimeStepWithEnclaveTasking.LocalTimeStepWithEnclaveTasking._time_step_relaxation, exahype2.solvers.fv.rusanov.SubcyclingAdaptiveTimeStepWithEnclaveTasking.SubcyclingAdaptiveTimeStepWithEnclaveTasking._time_step_relaxation, exahype2.solvers.rkdg.AdaptiveTimeSteppingCodeSnippets.AdaptiveTimeSteppingCodeSnippets._time_step_relaxation, exahype2.solvers.rkdg.OptimisticAdaptiveTimeSteppingCodeSnippets.OptimisticAdaptiveTimeSteppingCodeSnippets._time_step_relaxation, exahype2.solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep._time_step_relaxation, exahype2.solvers.rkdg.rusanov.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking._time_step_relaxation, exahype2.solvers.rkfd.AdaptiveTimeSteppingCodeSnippets.AdaptiveTimeSteppingCodeSnippets._time_step_relaxation, exahype2.solvers.rkfd.fd4.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep._time_step_relaxation, exahype2.solvers.rkfd.fd4.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking._time_step_relaxation, and exahype2.solvers.rkdg.rusanov.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking.set_implementation().

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__(), CCZ4Solver.CCZ4Solver_RKDG_GlobalAdaptiveTimeStep.__init__(), and exahype2.solvers.rkdg.rusanov.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking.set_implementation().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ user_action_set_includes()

Field Documentation

◆ _abstract_solver_user_declarations

◆ _abstract_solver_user_definitions

◆ _add_solver_contributions_call

exahype2.solvers.rkdg.rusanov.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking._add_solver_contributions_call
protected

◆ _compute_eigenvalue

◆ _compute_new_time_step_size

◆ _compute_time_step_size

◆ _constructor_implementation

◆ _finish_time_step_implementation

◆ _fused_volumetric_compute_kernel_call_stateless_cpu

exahype2.solvers.rkdg.rusanov.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking._fused_volumetric_compute_kernel_call_stateless_cpu
protected

◆ _fused_volumetric_compute_kernel_call_stateless_gpu

exahype2.solvers.rkdg.rusanov.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking._fused_volumetric_compute_kernel_call_stateless_gpu
protected

◆ _kernel_namespace

◆ _multiply_with_inverted_mass_matrix_call

exahype2.solvers.rkdg.rusanov.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking._multiply_with_inverted_mass_matrix_call
protected

◆ _Riemann_compute_kernel_call

exahype2.solvers.rkdg.rusanov.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking._Riemann_compute_kernel_call
protected

◆ _solver_user_declarations

◆ _solver_user_definitions

◆ _start_time_step_implementation

◆ _time_step_relaxation

◆ _volumetric_compute_kernel_call

exahype2.solvers.rkdg.rusanov.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking._volumetric_compute_kernel_call
protected

◆ _volumetric_compute_kernel_call_stateless

exahype2.solvers.rkdg.rusanov.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking._volumetric_compute_kernel_call_stateless
protected

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