Inheritance diagram for coupling.StaticCoupling.StaticCoupling:

Collaboration diagram for coupling.StaticCoupling.StaticCoupling:

Public Member Functions
	__init__ (self, name, regularSolver, limitingSolver, limiting_criterion_implementation=PDETerms.User_Defined_Implementation)
	create_data_structures (self)
	This will serve as a face marker to communicate with neighbouring cells whether a given cell is troubled, is neighbouring a troubled cell, or is fine.
	create_action_sets (self)
	create_readme_descriptor (self, domain_offset, domain_size)
	get_user_action_set_includes (self)
	get_user_solver_includes (self)
	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.
	get_name_of_global_instance (self)
	__str__ (self)
	add_to_Peano4_datamodel (self, datamodel)
	add_use_data_statements_to_Peano4_solver_step (self, step)
	add_actions_to_init_grid (self, step)
	add_actions_to_create_grid (self, step, evaluate_refinement_criterion)
	add_actions_to_plot_solution (self, step, output_path)
	add_actions_to_perform_time_step (self, step)
	set_plot_description (self, description)
	add_implementation_files_to_project (self, namespace, output, dimensions, subdirectory="")
	The ExaHyPE2 project will call this operation when it sets up the overall environment.
	add_entries_to_text_replacement_dictionary (self, d)

Data Fields
str	user_action_set_includes = ""
str	user_solver_includes = ""
	plot_description = description

Protected Member Functions
	_store_cell_data_default_guard (self)
	_provide_cell_data_to_compute_kernels_default_guard (self)
	_provide_face_data_to_compute_kernels_default_guard (self)
	_load_cell_data_default_guard (self)
	_store_face_data_default_guard (self)
	_load_face_data_default_guard (self)
	_store_boundary_data_default_guard (self)
	_clear_face_data_default_guard (self)
	_interpolate_face_data_default_guard (self)
	_restrict_face_data_default_guard (self)
	_unknown_identifier (self)
	_get_default_includes (self)
	_generate_kernels (self, namespace, output, subdirectory, dimensions)
	_init_dictionary_with_default_parameters (self, d)

Protected Attributes
	_name = name
	_regular_solver = regularSolver
	_limiter_solver = limitingSolver
str	_solver_user_declarations = ""
str	_solver_user_definitions = ""
str	_start_time_step_implementation = ""
str	_finish_time_step_implementation = ""
str	_print_time_step_implementation = ""
str	_constructor_implementation = ""
	_physical_admissibility_criterion = limiting_criterion_implementation
	_cell_label = exahype2.grid.create_cell_label(self._name)
	_face_label = exahype2.grid.create_face_label(self._name)
	_action_set_check_troubledness
	_action_set_copy_face_data

Detailed Description

Definition at line 19 of file StaticCoupling.py.

Constructor & Destructor Documentation

◆ init()

coupling.StaticCoupling.StaticCoupling.__init__	(	self,
		name,
		regularSolver,
		limitingSolver,
		limiting_criterion_implementation = PDETerms.User_Defined_Implementation )

Definition at line 21 of file StaticCoupling.py.

Member Function Documentation

◆ str()

coupling.StaticCoupling.StaticCoupling.__str__ ( self )

Definition at line 317 of file StaticCoupling.py.

◆ _clear_face_data_default_guard()

coupling.StaticCoupling.StaticCoupling._clear_face_data_default_guard ( self )

protected

Definition at line 272 of file StaticCoupling.py.

◆ _generate_kernels()

coupling.StaticCoupling.StaticCoupling._generate_kernels	(	self,
		namespace,
		output,
		subdirectory,
		dimensions )

protected

Definition at line 351 of file StaticCoupling.py.

◆ _get_default_includes()

coupling.StaticCoupling.StaticCoupling._get_default_includes ( self )

protected

Definition at line 300 of file StaticCoupling.py.

◆ _init_dictionary_with_default_parameters()

coupling.StaticCoupling.StaticCoupling._init_dictionary_with_default_parameters	(		self,
			d )

protected

Definition at line 437 of file StaticCoupling.py.

◆ _interpolate_face_data_default_guard()

coupling.StaticCoupling.StaticCoupling._interpolate_face_data_default_guard ( self )

protected

Definition at line 282 of file StaticCoupling.py.

◆ _load_cell_data_default_guard()

coupling.StaticCoupling.StaticCoupling._load_cell_data_default_guard ( self )

protected

Definition at line 221 of file StaticCoupling.py.

◆ _load_face_data_default_guard()

coupling.StaticCoupling.StaticCoupling._load_face_data_default_guard ( self )

protected

Definition at line 246 of file StaticCoupling.py.

◆ _provide_cell_data_to_compute_kernels_default_guard()

coupling.StaticCoupling.StaticCoupling._provide_cell_data_to_compute_kernels_default_guard ( self )

protected

Definition at line 201 of file StaticCoupling.py.

◆ _provide_face_data_to_compute_kernels_default_guard()

coupling.StaticCoupling.StaticCoupling._provide_face_data_to_compute_kernels_default_guard ( self )

protected

Definition at line 211 of file StaticCoupling.py.

◆ _restrict_face_data_default_guard()

coupling.StaticCoupling.StaticCoupling._restrict_face_data_default_guard ( self )

protected

Definition at line 291 of file StaticCoupling.py.

◆ _store_boundary_data_default_guard()

coupling.StaticCoupling.StaticCoupling._store_boundary_data_default_guard ( self )

protected

Definition at line 261 of file StaticCoupling.py.

◆ _store_cell_data_default_guard()

coupling.StaticCoupling.StaticCoupling._store_cell_data_default_guard ( self )

protected

Definition at line 191 of file StaticCoupling.py.

◆ _store_face_data_default_guard()

coupling.StaticCoupling.StaticCoupling._store_face_data_default_guard ( self )

protected

Definition at line 236 of file StaticCoupling.py.

◆ _unknown_identifier()

coupling.StaticCoupling.StaticCoupling._unknown_identifier ( self )

protected

Definition at line 294 of file StaticCoupling.py.

◆ add_actions_to_create_grid()

coupling.StaticCoupling.StaticCoupling.add_actions_to_create_grid	(	self,
		step,
		evaluate_refinement_criterion )

Definition at line 337 of file StaticCoupling.py.

◆ add_actions_to_init_grid()

coupling.StaticCoupling.StaticCoupling.add_actions_to_init_grid	(		self,
			step )

Definition at line 333 of file StaticCoupling.py.

◆ add_actions_to_perform_time_step()

coupling.StaticCoupling.StaticCoupling.add_actions_to_perform_time_step	(		self,
			step )

Definition at line 344 of file StaticCoupling.py.

◆ add_actions_to_plot_solution()

coupling.StaticCoupling.StaticCoupling.add_actions_to_plot_solution	(	self,
		step,
		output_path )

Definition at line 340 of file StaticCoupling.py.

◆ add_entries_to_text_replacement_dictionary()

coupling.StaticCoupling.StaticCoupling.add_entries_to_text_replacement_dictionary	(		self,
			d )

Definition at line 430 of file StaticCoupling.py.

◆ add_implementation_files_to_project()

coupling.StaticCoupling.StaticCoupling.add_implementation_files_to_project	(	self,
		namespace,
		output,
		dimensions,
		subdirectory = "" )

The ExaHyPE2 project will call this operation when it sets up the overall environment.

This routine is typically not invoked by a user.

output: peano4.output.Output

Definition at line 380 of file StaticCoupling.py.

◆ add_to_Peano4_datamodel()

coupling.StaticCoupling.StaticCoupling.add_to_Peano4_datamodel	(		self,
			datamodel )

Definition at line 325 of file StaticCoupling.py.

◆ add_use_data_statements_to_Peano4_solver_step()

coupling.StaticCoupling.StaticCoupling.add_use_data_statements_to_Peano4_solver_step	(		self,
			step )

Definition at line 329 of file StaticCoupling.py.

◆ add_user_action_set_includes()

coupling.StaticCoupling.StaticCoupling.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.

Definition at line 183 of file StaticCoupling.py.

Referenced by CCZ4Solver.AbstractCCZ4Solver._add_standard_includes().

Here is the caller graph for this function:

◆ create_action_sets()

coupling.StaticCoupling.StaticCoupling.create_action_sets ( self )

Definition at line 111 of file StaticCoupling.py.

Referenced by mgccz4.MGCCZ4Solver.add_derivative_calculation(), and ccz4.CCZ4Solver.add_Psi4W().

Here is the caller graph for this function:

◆ create_data_structures()

coupling.StaticCoupling.StaticCoupling.create_data_structures ( self )

This will serve as a face marker to communicate with neighbouring cells whether a given cell is troubled, is neighbouring a troubled cell, or is fine.

Cells that are troubled or neighbouring a troubled cell must rollback their solution to the previous one and perform one timestep using a more robust FV scheme. Therefore these and their neighbours must convert the DG representation of their previous solution to an FV representation and project it to their faces so that these can be exchanged with their neighbours.

Definition at line 75 of file StaticCoupling.py.

Referenced by mgccz4.MGCCZ4Solver.add_derivative_calculation(), and ccz4.CCZ4Solver.add_Psi4W().

Here is the caller graph for this function:

◆ create_readme_descriptor()

coupling.StaticCoupling.StaticCoupling.create_readme_descriptor	(	self,
		domain_offset,
		domain_size )

Definition at line 172 of file StaticCoupling.py.

◆ get_name_of_global_instance()

coupling.StaticCoupling.StaticCoupling.get_name_of_global_instance ( self )

Definition at line 297 of file StaticCoupling.py.

◆ get_user_action_set_includes()

coupling.StaticCoupling.StaticCoupling.get_user_action_set_includes ( self )

Definition at line 177 of file StaticCoupling.py.

◆ get_user_solver_includes()

coupling.StaticCoupling.StaticCoupling.get_user_solver_includes ( self )

Definition at line 180 of file StaticCoupling.py.

◆ set_plot_description()

coupling.StaticCoupling.StaticCoupling.set_plot_description	(		self,
			description )

Definition at line 348 of file StaticCoupling.py.

Field Documentation

◆ _action_set_check_troubledness

coupling.StaticCoupling.StaticCoupling._action_set_check_troubledness

protected

Initial value:

=  VerifyTroubledness(self, use_PAC=True,
            guard = ("not marker.willBeRefined() and not marker.hasBeenRefined() and" +
                " repositories::" + self.get_name_of_global_instance() + ".getSolverState()==" + self._name + "::SolverState::GridInitialisation"
        ))

Definition at line 113 of file StaticCoupling.py.

◆ _action_set_copy_face_data

coupling.StaticCoupling.StaticCoupling._action_set_copy_face_data

protected

Initial value:

=  SolveRiemannProblem(self,
          guard = ("not marker.willBeRefined() and not marker.hasBeenRefined()"
              + " and repositories::" + self.get_name_of_global_instance() + ".getSolverState()==" + self._name + "::SolverState::TimeStepping"
              # + " and fineGridCell" + self._name + "CellLabel.getTroubled_Marker()==celldata::" + self._name + "CellLabel::Troubled_Marker::REGULAR"
              + " and " + "repositories::" + self.get_name_of_global_instance() + ".isFirstGridSweepOfTimeStep()"),
        )

Definition at line 123 of file StaticCoupling.py.

◆ _cell_label

coupling.StaticCoupling.StaticCoupling._cell_label = exahype2.grid.create_cell_label(self._name)

protected

Definition at line 87 of file StaticCoupling.py.

◆ _constructor_implementation

str coupling.StaticCoupling.StaticCoupling._constructor_implementation = ""

protected

Definition at line 56 of file StaticCoupling.py.

◆ _face_label

coupling.StaticCoupling.StaticCoupling._face_label = exahype2.grid.create_face_label(self._name)

protected

Definition at line 88 of file StaticCoupling.py.

◆ _finish_time_step_implementation

str coupling.StaticCoupling.StaticCoupling._finish_time_step_implementation = ""

protected

Definition at line 53 of file StaticCoupling.py.

◆ _limiter_solver

coupling.StaticCoupling.StaticCoupling._limiter_solver = limitingSolver

protected

Definition at line 35 of file StaticCoupling.py.

◆ _name

coupling.StaticCoupling.StaticCoupling._name = name

protected

Definition at line 31 of file StaticCoupling.py.

Referenced by CCZ4Solver.CCZ4Solver_FD4_SecondOrderFormulation_GlobalAdaptiveTimeStepWithEnclaveTasking.add_tracer().

◆ _physical_admissibility_criterion

coupling.StaticCoupling.StaticCoupling._physical_admissibility_criterion = limiting_criterion_implementation

protected

Definition at line 58 of file StaticCoupling.py.

◆ _print_time_step_implementation

str coupling.StaticCoupling.StaticCoupling._print_time_step_implementation = ""

protected

Definition at line 54 of file StaticCoupling.py.

◆ _regular_solver

coupling.StaticCoupling.StaticCoupling._regular_solver = regularSolver

protected

Definition at line 34 of file StaticCoupling.py.

◆ _solver_user_declarations

str coupling.StaticCoupling.StaticCoupling._solver_user_declarations = ""

protected

Definition at line 41 of file StaticCoupling.py.

◆ _solver_user_definitions

str coupling.StaticCoupling.StaticCoupling._solver_user_definitions = ""

protected

Definition at line 42 of file StaticCoupling.py.

◆ _start_time_step_implementation

str coupling.StaticCoupling.StaticCoupling._start_time_step_implementation = ""

protected

Definition at line 52 of file StaticCoupling.py.

◆ plot_description

coupling.StaticCoupling.StaticCoupling.plot_description = description

Definition at line 349 of file StaticCoupling.py.

◆ user_action_set_includes

str coupling.StaticCoupling.StaticCoupling.user_action_set_includes = ""

Definition at line 44 of file StaticCoupling.py.

◆ user_solver_includes

str coupling.StaticCoupling.StaticCoupling.user_solver_includes = ""

Definition at line 45 of file StaticCoupling.py.

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

tests/exahype2/aderdg-coupling/coupling/StaticCoupling.py

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __str__()

◆ _clear_face_data_default_guard()

◆ _generate_kernels()

◆ _get_default_includes()

◆ _init_dictionary_with_default_parameters()

◆ _interpolate_face_data_default_guard()

◆ _load_cell_data_default_guard()

◆ _load_face_data_default_guard()

◆ _provide_cell_data_to_compute_kernels_default_guard()

◆ _provide_face_data_to_compute_kernels_default_guard()

◆ _restrict_face_data_default_guard()

◆ _store_boundary_data_default_guard()

◆ _store_cell_data_default_guard()

◆ _store_face_data_default_guard()

◆ _unknown_identifier()

◆ add_actions_to_create_grid()

◆ add_actions_to_init_grid()

◆ add_actions_to_perform_time_step()

◆ add_actions_to_plot_solution()

◆ add_entries_to_text_replacement_dictionary()

◆ add_implementation_files_to_project()

◆ add_to_Peano4_datamodel()

◆ add_use_data_statements_to_Peano4_solver_step()

◆ add_user_action_set_includes()

◆ create_action_sets()

◆ create_data_structures()

◆ create_readme_descriptor()

◆ get_name_of_global_instance()

◆ get_user_action_set_includes()

◆ get_user_solver_includes()

◆ set_plot_description()

Field Documentation

◆ _action_set_check_troubledness

◆ _action_set_copy_face_data

◆ _cell_label

◆ _constructor_implementation

◆ _face_label

◆ _finish_time_step_implementation

◆ _limiter_solver

◆ _name

◆ _physical_admissibility_criterion

◆ _print_time_step_implementation

◆ _regular_solver

◆ _solver_user_declarations

◆ _solver_user_definitions

◆ _start_time_step_implementation

◆ plot_description

◆ user_action_set_includes

◆ user_solver_includes

◆ init()

◆ str()