Peano 4
Loading...
Searching...
No Matches
CCZ4Solver.CCZ4Solver_FD4_GlobalAdaptiveTimeStepWithEnclaveTasking Class Reference

CCZ4 solver using fourth-order finite differences and global adaptive time stepping incl enclave tasking. More...

Inheritance diagram for CCZ4Solver.CCZ4Solver_FD4_GlobalAdaptiveTimeStepWithEnclaveTasking:
Collaboration diagram for CCZ4Solver.CCZ4Solver_FD4_GlobalAdaptiveTimeStepWithEnclaveTasking:

Public Member Functions

 __init__ (self, name, patch_size, rk_order, min_meshcell_h, max_meshcell_h, use_heap_storage, pde_terms_without_state, second_order=False)
 Constructor.
 
 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.rkfd.fd4.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking
 set_implementation (self, flux=None, ncp=None, source_term=None, eigenvalues=None, boundary_conditions=None, refinement_criterion=None, initial_conditions=None, memory_location=None, additional_action_set_includes="", additional_user_includes="", KOSigma=None)
 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.rkfd.SeparateSweepsWithEnclaveTasking.SeparateSweepsWithEnclaveTasking
 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.
 
 add_implementation_files_to_project (self, namespace, output, dimensions)
 Add the enclave task for the GPU.
 
 add_actions_to_perform_time_step (self, step)
 Add enclave aspect.
 
 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)
 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)
 Add action sets to plotting grid sweep.
 
 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_to_heap_storage (self, Storage cell_data_storage, Storage face_data_storage)
 By default, we hold all data on the call stacks.
 

Additional Inherited Members

- Data Fields inherited from CCZ4Solver.AbstractCCZ4Solver
 integer_constants
 
 double_constants
 
 Default_Time_Step_Size_Relaxation
 
- Data Fields inherited from exahype2.solvers.rkfd.SeparateSweepsWithEnclaveTasking.SeparateSweepsWithEnclaveTasking
 enclave_task_priority
 
- Data Fields inherited from exahype2.solvers.rkfd.CellCenteredFiniteDifferences.CellCenteredFiniteDifferences
 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.rkfd.SeparateSweepsWithEnclaveTasking.SeparateSweepsWithEnclaveTasking
 _enclave_task_name (self)
 
- 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().
 
- Protected Attributes inherited from exahype2.solvers.rkfd.fd4.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking
 _time_step_relaxation
 
 _compute_eigenvalue
 
 _KO_Sigma
 
 _compute_kernel_call
 
 _flux_implementation
 
 _ncp_implementation
 
 _source_term_implementation
 
 _fused_compute_kernel_call_cpu
 
 _fused_compute_kernel_call_gpu
 
 _abstract_solver_user_declarations
 
 _abstract_solver_user_definitions
 
 _compute_time_step_size
 
 _compute_new_time_step_size
 
 _solver_user_declarations
 
 _solver_user_definitions
 
 _start_time_step_implementation
 
 _finish_time_step_implementation
 
 _constructor_implementation
 
- Protected Attributes inherited from exahype2.solvers.rkfd.SeparateSweepsWithEnclaveTasking.SeparateSweepsWithEnclaveTasking
 _name
 
 _rk_order
 
 _primary_sweeps_of_Runge_Kutta_step_on_cell
 
 _secondary_sweeps_of_Runge_Kutta_step_on_cell
 
 _last_secondary_sweep_of_Runge_Kutta_step_on_cell
 
 _primary_sweeps_of_Runge_Kutta_step_on_face
 
 _secondary_sweeps_of_Runge_Kutta_step_on_face
 
 _primary_sweep_guard
 
 _primary_sweep_or_plot_guard
 
 _secondary_sweep_guard
 
 _secondary_sweep_or_initialisation_guard
 
 _solver_template_file_class_name
 
 _fused_compute_kernel_call_cpu
 
 _fused_compute_kernel_call_gpu
 
 _pde_terms_without_state
 
 _fused_volumetric_kernel_call_cpu
 
 _fused_volumetric_kernel_call_gpu
 
 _action_set_merge_enclave_task_outcome
 
 _action_set_update_cell
 
- Protected Attributes inherited from exahype2.solvers.rkfd.SeparateSweeps.SeparateSweeps
 _rk_order
 
 _solver_template_file_class_name
 
 _flux_implementation
 
 _ncp_implementation
 
 _eigenvalues_implementation
 
 _source_term_implementation
 
 _name
 
 _action_set_update_cell
 
 _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
 
 _cell_data_storage
 
 _face_data_storage
 
 _baseline_action_set_descend_invocation_order
 
 _patch
 
 _patch_estimates
 
 _patch_overlap_old
 
 _patch_overlap_new
 
 _patch_overlap_update
 
 _cell_label
 
 _face_label
 
 _action_set_compute_final_linear_combination
 
 _action_set_update_face_label
 
 _action_set_update_cell_label
 
 _action_set_update_cell
 
- Static Protected Attributes inherited from CCZ4Solver.AbstractCCZ4Solver
dict _FO_formulation_unknowns
 
dict _SO_formulation_unknowns
 

Detailed Description

CCZ4 solver using fourth-order finite differences and global adaptive time stepping incl enclave tasking.

The constructor of this classs is straightforward and realises the standard steps of any numerical implementation of the CCZ4 scheme:

  1. Init the actual numerical scheme. This happens through the constructor of the base class.
  2. Add the header files that we need, i.e. those files which contain the actual CCZ4 implementation.
  3. Add some constants that any CCZ4 C++ code requires.
  4. Set the actual implementation, i.e. link the generic PDE terms to the CCZ4-specific function calls.
  5. Add the CCZ4-specific postprocessing.
  6. Switch to higher-order interpolation and restriction.

Definition at line 737 of file CCZ4Solver.py.

Constructor & Destructor Documentation

◆ __init__()

CCZ4Solver.CCZ4Solver_FD4_GlobalAdaptiveTimeStepWithEnclaveTasking.__init__ ( self,
name,
patch_size,
rk_order,
min_meshcell_h,
max_meshcell_h,
use_heap_storage,
pde_terms_without_state,
second_order = False )

Constructor.

Calibrate the default time step size calibration with 1/16 to take into account that we have a higher-order numerical scheme.

Attributes

use_heap_storage: Boolean By default, we place the patches on the heap but administer them through a smart pointer. You can switch this default and enforce a "proper" storage of the data on the heap. This usually introduces more memory movements, though you might end up with a better memory alignment, i.e. memory closer to the compute kernels.

Reimplemented from CCZ4Solver.AbstractCCZ4Solver.

Reimplemented in SBH.FD4SolverWithLimiter, and SBH.FD4SolverWithoutLimiter.

Definition at line 765 of file CCZ4Solver.py.

References CCZ4Solver.AbstractCCZ4Solver._add_standard_includes(), CCZ4Solver.AbstractCCZ4Solver._FO_formulation_unknowns, CCZ4Solver.construct_FD4_eigenvalues(), CCZ4Solver.construct_FD4_ncp(), CCZ4Solver.construct_FD4_postprocessing_kernel(), CCZ4Solver.construct_FD4_source_term(), CCZ4Solver.AbstractCCZ4Solver.Default_Time_Step_Size_Relaxation, ccz4.CCZ4Solver.postprocess_updated_patch, ccz4_archived.CCZ4Solver.postprocess_updated_patch, ccz4_archived_24_01_19.CCZ4Solver.postprocess_updated_patch, performance_testbed.CCZ4Solver.postprocess_updated_patch, exahype2.solvers.fv.FV.FV.postprocess_updated_patch(), exahype2.solvers.rkfd.CellCenteredFiniteDifferences.CellCenteredFiniteDifferences.postprocess_updated_patch(), exahype2.solvers.fv.FV.FV.postprocess_updated_patch(), exahype2.solvers.rkfd.CellCenteredFiniteDifferences.CellCenteredFiniteDifferences.postprocess_updated_patch(), exahype2.solvers.fv.EnclaveTasking.EnclaveTasking.set_implementation(), exahype2.solvers.fv.SingleSweep.SingleSweep.set_implementation(), PointWiseClawPackAdaptiveTimeStepSize.PointWiseClawPackAdaptiveTimeStepSize.set_implementation(), exahype2.solvers.fv.clawpack.GlobalFixedTimeStep.GlobalFixedTimeStep.set_implementation(), exahype2.solvers.rkfd.OneSweepPerRungeKuttaStep.OneSweepPerRungeKuttaStep.set_implementation(), exahype2.solvers.rkfd.SeparateSweeps.SeparateSweeps.set_implementation(), exahype2.solvers.rkdg.rusanov.GlobalFixedTimeStep.GlobalFixedTimeStep.set_implementation(), exahype2.solvers.aderdg.ADERDG.ADERDG.set_implementation(), exahype2.solvers.fv.musclhancock.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep.set_implementation(), exahype2.solvers.fv.musclhancock.GlobalFixedTimeStep.GlobalFixedTimeStep.set_implementation(), exahype2.solvers.fv.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep.set_implementation(), exahype2.solvers.fv.rusanov.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking.set_implementation(), exahype2.solvers.fv.rusanov.GlobalFixedTimeStep.GlobalFixedTimeStep.set_implementation(), exahype2.solvers.fv.rusanov.GlobalFixedTimeStepWithEnclaveTasking.GlobalFixedTimeStepWithEnclaveTasking.set_implementation(), exahype2.solvers.fv.rusanov.LocalTimeStepWithEnclaveTasking.LocalTimeStepWithEnclaveTasking.set_implementation(), exahype2.solvers.fv.rusanov.SubcyclingAdaptiveTimeStepWithEnclaveTasking.SubcyclingAdaptiveTimeStepWithEnclaveTasking.set_implementation(), exahype2.solvers.fv.rusanov.SubcyclingFixedTimeStep.SubcyclingFixedTimeStep.set_implementation(), exahype2.solvers.fv.rusanov.SubcyclingFixedTimeStepWithEnclaveTasking.SubcyclingFixedTimeStepWithEnclaveTasking.set_implementation(), exahype2.solvers.rkdg.RungeKuttaDG.RungeKuttaDG.set_implementation(), exahype2.solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep.set_implementation(), exahype2.solvers.rkdg.rusanov.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking.set_implementation(), exahype2.solvers.rkfd.fd4.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep.set_implementation(), exahype2.solvers.rkfd.fd4.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking.set_implementation(), exahype2.solvers.rkfd.fd4.GlobalFixedTimeStep.GlobalFixedTimeStep.set_implementation(), exahype2.solvers.fv.riemann.UserDefinedRiemann.UserDefinedRiemann.set_implementation(), exahype2.solvers.aderdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep.set_implementation(), exahype2.solvers.aderdg.rusanov.GlobalFixedTimeStep.GlobalFixedTimeStep.set_implementation(), exahype2.solvers.fv.FV.FV.switch_to_heap_storage(), exahype2.solvers.rkdg.RungeKuttaDG.RungeKuttaDG.switch_to_heap_storage(), exahype2.solvers.rkfd.CellCenteredFiniteDifferences.CellCenteredFiniteDifferences.switch_to_heap_storage(), and values.

Here is the call graph for this function:

Member Function Documentation

◆ add_tracer()

CCZ4Solver.CCZ4Solver_FD4_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.

This is a delegate to add_tracer_to_FD4_solver() which passes the object in as first argument.

Consult exahype2.tracer.DumpTracerIntoDatabase for an explanation of some of the arguments. Most of them are simply piped through to this class.

Parameters
projectexahype2.Project
tracer_unknownsInteger You can set this variable to None. In this case, all variables are dumped.

Reimplemented from CCZ4Solver.AbstractCCZ4Solver.

Definition at line 841 of file CCZ4Solver.py.

References CCZ4Solver.add_tracer_to_FD4_solver().

Here is the call graph for this function:

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