Peano

Searching...

No Matches

Inheritance diagram for exahype2.solvers.rkfd.fd4.GlobalFixedTimeStep.GlobalFixedTimeStep:

[legend]

Collaboration diagram for exahype2.solvers.rkfd.fd4.GlobalFixedTimeStep.GlobalFixedTimeStep:

[legend]

Public Member Functions
	__init__ (self, name, patch_size, rk_order, unknowns, auxiliary_variables, min_meshcell_h, max_meshcell_h, normalised_time_step_size, flux=PDETerms.User_Defined_Implementation, ncp=PDETerms.None_Implementation, eigenvalues=PDETerms.None_Implementation, boundary_conditions=PDETerms.User_Defined_Implementation, refinement_criterion=PDETerms.Empty_Implementation, initial_conditions=PDETerms.User_Defined_Implementation, plot_grid_properties=False, KOSigma=8.0)
	Construct the solver.

	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.

Public Member Functions inherited from exahype2.solvers.rkfd.SeparateSweeps.SeparateSweeps
	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.

	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
	_normalised_time_step_size

	_KO_Sigma

	_compute_kernel_call

	_flux_implementation

	_ncp_implementation

	_source_term_implementation

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

	_solver_template_file_class_name

	_flux_implementation

	_ncp_implementation

	_eigenvalues_implementation

	_source_term_implementation

	_name

	_action_set_update_cell

	_reconstruction_stages

	_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

	_reconstruction_kernel_call

	_primary_variables_indices

	_auxiliary_variables_indices

	_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

Definition at line 25 of file GlobalFixedTimeStep.py.

Constructor & Destructor Documentation

◆ init()

exahype2.solvers.rkfd.fd4.GlobalFixedTimeStep.GlobalFixedTimeStep.__init__	(	self,
		name,
		patch_size,
		rk_order,
		unknowns,
		auxiliary_variables,
		min_meshcell_h,
		max_meshcell_h,
		normalised_time_step_size,
		flux = PDETerms.User_Defined_Implementation,
		ncp = PDETerms.None_Implementation,
		eigenvalues = PDETerms.None_Implementation,
		boundary_conditions = PDETerms.User_Defined_Implementation,
		refinement_criterion = PDETerms.Empty_Implementation,
		initial_conditions = PDETerms.User_Defined_Implementation,
		plot_grid_properties = False,
		KOSigma = 8.0 )

Construct the solver.

eigenvalues: C++ source code or from PDETerms or None By default is None_Implementation, as we don't need eigenvalues as long as we work with fixed time step sizes. You can change it manually. Still, the fixed time stepping won't use the eigenvalues but you might have code that has it and that you don't want to change.

normalised_time_step_size: Float This is the normalised time step size w.r.t. the coarsest admissible h value and the polynomial order. If the code employs AMR on top of it and refines further, it will automatically downscale the time step size accordingly. So hand in a valid time step size w.r.t. to max_meshcell_h. The actual polynomial order enters the chosen time step size as an additional \( p^{-2} \) scaling, and we expect the user to incorporate such a factor into the passed normalised value.

Reimplemented from exahype2.solvers.rkfd.SeparateSweeps.SeparateSweeps.

Definition at line 26 of file GlobalFixedTimeStep.py.

References exahype2.solvers.rkfd.fd4.GlobalFixedTimeStep.GlobalFixedTimeStep.__init__().

Referenced by exahype2.solvers.rkfd.fd4.GlobalFixedTimeStep.GlobalFixedTimeStep.__init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ set_implementation()

exahype2.solvers.rkfd.fd4.GlobalFixedTimeStep.GlobalFixedTimeStep.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.

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.rkfd.SeparateSweeps.SeparateSweeps.

Definition at line 82 of file GlobalFixedTimeStep.py.

References exahype2.solvers.rkfd.fd4.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep._KO_Sigma, exahype2.solvers.rkfd.fd4.GlobalAdaptiveTimeStepInExaGRyPE.GlobalAdaptiveTimeStepInExaGRyPE._KO_Sigma, exahype2.solvers.rkfd.fd4.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking._KO_Sigma, exahype2.solvers.rkfd.fd4.GlobalFixedTimeStep.GlobalFixedTimeStep._KO_Sigma, and exahype2.solvers.rkfd.fd4.GlobalFixedTimeStep.GlobalFixedTimeStep.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.rkfd.fd4.GlobalFixedTimeStep.GlobalFixedTimeStep.set_implementation().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ _abstract_solver_user_declarations

exahype2.solvers.rkfd.fd4.GlobalFixedTimeStep.GlobalFixedTimeStep._abstract_solver_user_declarations

protected

Definition at line 119 of file GlobalFixedTimeStep.py.

Referenced by exahype2.solvers.aderdg.ADERDG.ADERDG._init_dictionary_with_default_parameters(), exahype2.solvers.fv.FV.FV._init_dictionary_with_default_parameters(), exahype2.solvers.rkdg.RungeKuttaDG.RungeKuttaDG._init_dictionary_with_default_parameters(), and exahype2.solvers.rkfd.CellCenteredFiniteDifferences.CellCenteredFiniteDifferences._init_dictionary_with_default_parameters().

◆ _abstract_solver_user_definitions

exahype2.solvers.rkfd.fd4.GlobalFixedTimeStep.GlobalFixedTimeStep._abstract_solver_user_definitions

protected

Definition at line 121 of file GlobalFixedTimeStep.py.

◆ _compute_kernel_call

exahype2.solvers.rkfd.fd4.GlobalFixedTimeStep.GlobalFixedTimeStep._compute_kernel_call

protected

Definition at line 107 of file GlobalFixedTimeStep.py.

Referenced by exahype2.solvers.fv.FV.FV._init_dictionary_with_default_parameters(), and exahype2.solvers.rkfd.CellCenteredFiniteDifferences.CellCenteredFiniteDifferences._init_dictionary_with_default_parameters().

◆ _compute_new_time_step_size

exahype2.solvers.rkfd.fd4.GlobalFixedTimeStep.GlobalFixedTimeStep._compute_new_time_step_size

protected

Definition at line 125 of file GlobalFixedTimeStep.py.

◆ _compute_time_step_size

exahype2.solvers.rkfd.fd4.GlobalFixedTimeStep.GlobalFixedTimeStep._compute_time_step_size

protected

Definition at line 124 of file GlobalFixedTimeStep.py.

◆ _constructor_implementation

exahype2.solvers.rkfd.fd4.GlobalFixedTimeStep.GlobalFixedTimeStep._constructor_implementation

protected

Definition at line 132 of file GlobalFixedTimeStep.py.

◆ _finish_time_step_implementation

exahype2.solvers.rkfd.fd4.GlobalFixedTimeStep.GlobalFixedTimeStep._finish_time_step_implementation

protected

Definition at line 131 of file GlobalFixedTimeStep.py.

◆ _flux_implementation

exahype2.solvers.rkfd.fd4.GlobalFixedTimeStep.GlobalFixedTimeStep._flux_implementation

protected

Definition at line 108 of file GlobalFixedTimeStep.py.

◆ _KO_Sigma

exahype2.solvers.rkfd.fd4.GlobalFixedTimeStep.GlobalFixedTimeStep._KO_Sigma

protected

Definition at line 64 of file GlobalFixedTimeStep.py.

Referenced by ccz4.CCZ4Solver.__init__(), exahype2.solvers.rkfd.fd4.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking.set_implementation(), exahype2.solvers.rkfd.fd4.GlobalFixedTimeStep.GlobalFixedTimeStep.set_implementation(), exahype2.solvers.rkfd.fd4.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep.set_implementation(), and exahype2.solvers.rkfd.fd4.GlobalAdaptiveTimeStepInExaGRyPE.GlobalAdaptiveTimeStepInExaGRyPE.set_implementation().

◆ _ncp_implementation

exahype2.solvers.rkfd.fd4.GlobalFixedTimeStep.GlobalFixedTimeStep._ncp_implementation

protected

Definition at line 109 of file GlobalFixedTimeStep.py.

◆ _normalised_time_step_size

exahype2.solvers.rkfd.fd4.GlobalFixedTimeStep.GlobalFixedTimeStep._normalised_time_step_size

protected

Definition at line 62 of file GlobalFixedTimeStep.py.

◆ _solver_user_declarations

exahype2.solvers.rkfd.fd4.GlobalFixedTimeStep.GlobalFixedTimeStep._solver_user_declarations

protected

Definition at line 127 of file GlobalFixedTimeStep.py.

◆ _solver_user_definitions

exahype2.solvers.rkfd.fd4.GlobalFixedTimeStep.GlobalFixedTimeStep._solver_user_definitions

protected

Definition at line 128 of file GlobalFixedTimeStep.py.

◆ _source_term_implementation

exahype2.solvers.rkfd.fd4.GlobalFixedTimeStep.GlobalFixedTimeStep._source_term_implementation

protected

Definition at line 110 of file GlobalFixedTimeStep.py.

◆ _start_time_step_implementation

exahype2.solvers.rkfd.fd4.GlobalFixedTimeStep.GlobalFixedTimeStep._start_time_step_implementation

protected

Definition at line 130 of file GlobalFixedTimeStep.py.

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

python/exahype2/solvers/rkfd/fd4/GlobalFixedTimeStep.py

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ set_implementation()

Field Documentation

◆ _abstract_solver_user_declarations

◆ _abstract_solver_user_definitions

◆ _compute_kernel_call

◆ _compute_new_time_step_size

◆ _compute_time_step_size

◆ _constructor_implementation

◆ _finish_time_step_implementation

◆ _flux_implementation

◆ _KO_Sigma

◆ _ncp_implementation

◆ _normalised_time_step_size

◆ _solver_user_declarations

◆ _solver_user_definitions

◆ _source_term_implementation

◆ _start_time_step_implementation

◆ init()