solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep Class Reference

RKDG solver with Rusanov Riemann solver employing global adaptive time stepping. More...

Inheritance diagram for solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep:

Collaboration diagram for solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep:

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

Protected Attributes
	_time_step_relaxation
	_compute_eigenvalue
	_kernel_namespace
	_volumetric_compute_kernel_call
	_volumetric_compute_kernel_call_stateless
	_Riemann_compute_kernel_call
	_add_solver_contributions_call
	_multiply_with_inverted_mass_matrix_call
	_unknowns
	_auxiliary_variables
	_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

Detailed Description

RKDG solver with Rusanov Riemann solver employing global adaptive time stepping.

Please consult GlobalFixedTimeStep for details. This version is very similar with the big difference being that we add the evaluation and global reduction of the maximum eigenvalue and then adopt the time step size accordingly.

Definition at line 26 of file GlobalAdaptiveTimeStep.py.

Constructor & Destructor Documentation

__init__()

solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep.__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.

Definition at line 37 of file GlobalAdaptiveTimeStep.py.

References solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep.__init__().

Referenced by solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep.__init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

set_implementation()

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

Definition at line 99 of file GlobalAdaptiveTimeStep.py.

References solvers.aderdg.ADERDG.ADERDG._basis, solvers.rkdg.RungeKuttaDG.RungeKuttaDG._basis, solvers.fv.FV.FV._kernel_namespace, solvers.rkdg.RungeKuttaDG.RungeKuttaDG._kernel_namespace, solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep._kernel_namespace, solvers.rkdg.rusanov.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking._kernel_namespace, solvers.rkdg.rusanov.GlobalFixedTimeStep.GlobalFixedTimeStep._kernel_namespace, and solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep.set_implementation().

Referenced by CCZ4Solver.CCZ4Solver_FV_GlobalAdaptiveTimeStep.__init__(), CCZ4Solver.CCZ4Solver_FV_MUSCL_GlobalAdaptiveTimeStep.__init__(), CCZ4Solver.CCZ4Solver_FV_GlobalAdaptiveTimeStepWithEnclaveTasking.__init__(), CCZ4Solver.CCZ4Solver_FV_MUSCL_GlobalAdaptiveTimeStepWithEnclaveTasking.__init__(), CCZ4Solver.CCZ4Solver_FD4_GlobalAdaptiveTimeStepWithEnclaveTasking.__init__(), CCZ4Solver.CCZ4Solver_FD4_GlobalAdaptiveTimeStep.__init__(), CCZ4Solver.CCZ4Solver_RKDG_GlobalAdaptiveTimeStepWithEnclaveTasking.__init__(), CCZ4Solver.CCZ4Solver_RKDG_GlobalAdaptiveTimeStep.__init__(), and solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep.set_implementation().

Here is the call graph for this function:

Here is the caller graph for this function:

user_action_set_includes()

solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep.user_action_set_includes

(

self

)

Definition at line 165 of file GlobalAdaptiveTimeStep.py.

Referenced by solvers.fv.EnclaveTasking.EnclaveTasking.add_implementation_files_to_project(), solvers.rkdg.SeparateSweepsWithEnclaveTasking.SeparateSweepsWithEnclaveTasking.add_implementation_files_to_project(), solvers.aderdg.ADERDG.ADERDG.add_user_action_set_includes(), solvers.aderdg.ADERDG.ADERDG.get_user_action_set_includes(), and solvers.aderdg.ADERDG.ADERDG.set_implementation().

Here is the caller graph for this function:

Field Documentation

_abstract_solver_user_declarations

solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep._abstract_solver_user_declarations

protected

Definition at line 148 of file GlobalAdaptiveTimeStep.py.

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

_abstract_solver_user_definitions

solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep._abstract_solver_user_definitions

protected

Definition at line 150 of file GlobalAdaptiveTimeStep.py.

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

_add_solver_contributions_call

solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep._add_solver_contributions_call

protected

Definition at line 83 of file GlobalAdaptiveTimeStep.py.

Referenced by solvers.rkdg.RungeKuttaDG.RungeKuttaDG._init_dictionary_with_default_parameters().

_auxiliary_variables

solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep._auxiliary_variables

protected

Definition at line 138 of file GlobalAdaptiveTimeStep.py.

Referenced by solvers.rkdg.RungeKuttaDG.RungeKuttaDG.__str__(), exahype2.api.Solver.Solver.__str__(), solvers.aderdg.ADERDG.ADERDG._init_dictionary_with_default_parameters(), solvers.fv.FV.FV._init_dictionary_with_default_parameters(), solvers.rkdg.RungeKuttaDG.RungeKuttaDG._init_dictionary_with_default_parameters(), SSInfall.SSInfallSolver.add_mass_cal_rhointer(), ccz4.CCZ4Solver.add_Psi4W(), solvers.aderdg.ADERDG.ADERDG.auxiliary_variables(), solvers.fv.FV.FV.auxiliary_variables(), solvers.rkdg.RungeKuttaDG.RungeKuttaDG.auxiliary_variables(), exahype2.api.Solver.Solver.auxiliary_variables(), solvers.fv.FV.FV.auxiliary_variables(), solvers.rkdg.RungeKuttaDG.RungeKuttaDG.auxiliary_variables(), and exahype2.api.Solver.Solver.variable_names_per_entry().

_compute_eigenvalue

solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep._compute_eigenvalue

protected

Definition at line 75 of file GlobalAdaptiveTimeStep.py.

Referenced by solvers.fv.FV.FV._init_dictionary_with_default_parameters(), and solvers.rkdg.RungeKuttaDG.RungeKuttaDG._init_dictionary_with_default_parameters().

_compute_new_time_step_size

solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep._compute_new_time_step_size

protected

Definition at line 157 of file GlobalAdaptiveTimeStep.py.

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

_compute_time_step_size

solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep._compute_time_step_size

protected

Definition at line 156 of file GlobalAdaptiveTimeStep.py.

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

_constructor_implementation

solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep._constructor_implementation

protected

Definition at line 161 of file GlobalAdaptiveTimeStep.py.

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

_finish_time_step_implementation

solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep._finish_time_step_implementation

protected

Definition at line 160 of file GlobalAdaptiveTimeStep.py.

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

_kernel_namespace

solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep._kernel_namespace

protected

Definition at line 77 of file GlobalAdaptiveTimeStep.py.

Referenced by solvers.fv.FV.FV._init_dictionary_with_default_parameters(), solvers.rkdg.RungeKuttaDG.RungeKuttaDG._init_dictionary_with_default_parameters(), solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep.set_implementation(), and solvers.rkdg.rusanov.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking.set_implementation().

_multiply_with_inverted_mass_matrix_call

solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep._multiply_with_inverted_mass_matrix_call

protected

Definition at line 84 of file GlobalAdaptiveTimeStep.py.

Referenced by solvers.rkdg.RungeKuttaDG.RungeKuttaDG._init_dictionary_with_default_parameters().

_Riemann_compute_kernel_call

solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep._Riemann_compute_kernel_call

protected

Definition at line 81 of file GlobalAdaptiveTimeStep.py.

Referenced by solvers.rkdg.RungeKuttaDG.RungeKuttaDG._init_dictionary_with_default_parameters().

_solver_user_declarations

solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep._solver_user_declarations

protected

Definition at line 153 of file GlobalAdaptiveTimeStep.py.

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

_solver_user_definitions

solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep._solver_user_definitions

protected

Definition at line 154 of file GlobalAdaptiveTimeStep.py.

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

_start_time_step_implementation

solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep._start_time_step_implementation

protected

Definition at line 159 of file GlobalAdaptiveTimeStep.py.

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

_time_step_relaxation

solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep._time_step_relaxation

protected

Definition at line 74 of file GlobalAdaptiveTimeStep.py.

Referenced by solvers.fv.AdaptiveSubcyclingTimeSteppingCodeSnippets.AdaptiveSubcyclingTimeSteppingCodeSnippets.create_finish_time_step_implementation(), solvers.fv.AdaptiveTimeSteppingCodeSnippets.AdaptiveTimeSteppingCodeSnippets.create_finish_time_step_implementation(), solvers.rkdg.AdaptiveTimeSteppingCodeSnippets.AdaptiveTimeSteppingCodeSnippets.create_finish_time_step_implementation(), and solvers.rkdg.OptimisticAdaptiveTimeSteppingCodeSnippets.OptimisticAdaptiveTimeSteppingCodeSnippets.create_finish_time_step_implementation().

_unknowns

solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep._unknowns

protected

Definition at line 137 of file GlobalAdaptiveTimeStep.py.

Referenced by solvers.rkdg.RungeKuttaDG.RungeKuttaDG.__str__(), exahype2.api.Solver.Solver.__str__(), solvers.aderdg.ADERDG.ADERDG._init_dictionary_with_default_parameters(), solvers.fv.FV.FV._init_dictionary_with_default_parameters(), solvers.rkdg.RungeKuttaDG.RungeKuttaDG._init_dictionary_with_default_parameters(), api.solvers.CollocatedLowOrderDiscretisation.CollocatedLowOrderDiscretisation.add_to_plot(), tarch.plotter.api.output.Visualiser.PatchFileData.apply_renderer_to_data(), tarch.plotter.api.output.Visualiser.PatchFileData.copy_data_from_parser_object(), api.solvers.CollocatedLowOrderDiscretisation.CollocatedLowOrderDiscretisation.number_of_matrix_entries_per_vertex(), solvers.aderdg.ADERDG.ADERDG.unknowns(), solvers.fv.FV.FV.unknowns(), solvers.rkdg.RungeKuttaDG.RungeKuttaDG.unknowns(), exahype2.api.Solver.Solver.unknowns(), solvers.fv.FV.FV.unknowns(), solvers.rkdg.RungeKuttaDG.RungeKuttaDG.unknowns(), and exahype2.api.Solver.Solver.variable_names_per_entry().

_volumetric_compute_kernel_call

solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep._volumetric_compute_kernel_call

protected

Definition at line 79 of file GlobalAdaptiveTimeStep.py.

Referenced by solvers.rkdg.RungeKuttaDG.RungeKuttaDG._init_dictionary_with_default_parameters().

_volumetric_compute_kernel_call_stateless

solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep._volumetric_compute_kernel_call_stateless

protected

Definition at line 80 of file GlobalAdaptiveTimeStep.py.

Referenced by solvers.rkdg.RungeKuttaDG.RungeKuttaDG._init_dictionary_with_default_parameters().

---

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

• python/exahype2/solvers/rkdg/rusanov/GlobalAdaptiveTimeStep.py