Inheritance diagram for coupling.StaticCoupling.StaticCoupling:

Collaboration diagram for coupling.StaticCoupling.StaticCoupling:

Public Member Functions
def	__init__ (self, name, regularSolver, limitingSolver, limiting_criterion_implementation=PDETerms.User_Defined_Implementation)

def	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. More...

def	create_action_sets (self)

def	create_readme_descriptor (self, domain_offset, domain_size)

def	get_user_action_set_includes (self)

def	get_user_solver_includes (self)

def	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. More...

def	get_name_of_global_instance (self)

def	__str__ (self)

def	add_to_Peano4_datamodel (self, datamodel)

def	add_use_data_statements_to_Peano4_solver_step (self, step)

def	add_actions_to_init_grid (self, step)

def	add_actions_to_create_grid (self, step, evaluate_refinement_criterion)

def	add_actions_to_plot_solution (self, step, output_path)

def	add_actions_to_perform_time_step (self, step)

def	set_plot_description (self, description)

def	add_implementation_files_to_project (self, namespace, output, dimensions, subdirectory="")
	The ExaHyPE2 project will call this operation when it sets up the overall environment. More...

def	add_entries_to_text_replacement_dictionary (self, d)

Data Fields
	user_action_set_includes

	user_solver_includes

	plot_description

Private Member Functions
def	_store_cell_data_default_guard (self)

def	_provide_cell_data_to_compute_kernels_default_guard (self)

def	_provide_face_data_to_compute_kernels_default_guard (self)

def	_load_cell_data_default_guard (self)

def	_store_face_data_default_guard (self)

def	_load_face_data_default_guard (self)

def	_store_boundary_data_default_guard (self)

def	_clear_face_data_default_guard (self)

def	_interpolate_face_data_default_guard (self)

def	_restrict_face_data_default_guard (self)

def	_unknown_identifier (self)

def	_get_default_includes (self)

def	_generate_kernels (self, namespace, output, subdirectory, dimensions)

def	_init_dictionary_with_default_parameters (self, d)

Private Attributes
	_name

	_regular_solver

	_limiter_solver

	_solver_user_declarations

	_solver_user_definitions

	_start_time_step_implementation

	_finish_time_step_implementation

	_print_time_step_implementation

	_constructor_implementation

	_physical_admissibility_criterion

	_cell_label

	_face_label

	_action_set_check_troubledness

	_action_set_copy_face_data

Detailed Description

Definition at line 19 of file StaticCoupling.py.

Constructor & Destructor Documentation

◆ init()

def 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()

def coupling.StaticCoupling.StaticCoupling.__str__ ( self )

Definition at line 317 of file StaticCoupling.py.

References coupling.StaticCoupling.StaticCoupling._name.

◆ _clear_face_data_default_guard()

def coupling.StaticCoupling.StaticCoupling._clear_face_data_default_guard ( self )

private

Definition at line 272 of file StaticCoupling.py.

References coupling.StaticCoupling.StaticCoupling._name, and coupling.StaticCoupling.StaticCoupling.get_name_of_global_instance().

Here is the call graph for this function:

◆ _generate_kernels()

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

private

Definition at line 351 of file StaticCoupling.py.

References coupling.StaticCoupling.StaticCoupling._init_dictionary_with_default_parameters(), coupling.StaticCoupling.StaticCoupling._limiter_solver, coupling.StaticCoupling.StaticCoupling._name, coupling.StaticCoupling.StaticCoupling._regular_solver, and coupling.StaticCoupling.StaticCoupling.add_entries_to_text_replacement_dictionary().

Referenced by coupling.StaticCoupling.StaticCoupling.add_implementation_files_to_project().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _get_default_includes()

def coupling.StaticCoupling.StaticCoupling._get_default_includes ( self )

private

Definition at line 300 of file StaticCoupling.py.

◆ _init_dictionary_with_default_parameters()

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

private

Definition at line 437 of file StaticCoupling.py.

Referenced by coupling.StaticCoupling.StaticCoupling._generate_kernels(), and coupling.StaticCoupling.StaticCoupling.add_implementation_files_to_project().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _interpolate_face_data_default_guard()

def coupling.StaticCoupling.StaticCoupling._interpolate_face_data_default_guard ( self )

private

Definition at line 282 of file StaticCoupling.py.

References coupling.StaticCoupling.StaticCoupling._name, and coupling.StaticCoupling.StaticCoupling.get_name_of_global_instance().

Here is the call graph for this function:

◆ _load_cell_data_default_guard()

def coupling.StaticCoupling.StaticCoupling._load_cell_data_default_guard ( self )

private

Definition at line 221 of file StaticCoupling.py.

References coupling.StaticCoupling.StaticCoupling._name, and coupling.StaticCoupling.StaticCoupling.get_name_of_global_instance().

Here is the call graph for this function:

◆ _load_face_data_default_guard()

def coupling.StaticCoupling.StaticCoupling._load_face_data_default_guard ( self )

private

Definition at line 246 of file StaticCoupling.py.

References coupling.StaticCoupling.StaticCoupling._name, and coupling.StaticCoupling.StaticCoupling.get_name_of_global_instance().

Here is the call graph for this function:

◆ _provide_cell_data_to_compute_kernels_default_guard()

def coupling.StaticCoupling.StaticCoupling._provide_cell_data_to_compute_kernels_default_guard ( self )

private

Definition at line 201 of file StaticCoupling.py.

References coupling.StaticCoupling.StaticCoupling._name, and coupling.StaticCoupling.StaticCoupling.get_name_of_global_instance().

Here is the call graph for this function:

◆ _provide_face_data_to_compute_kernels_default_guard()

def coupling.StaticCoupling.StaticCoupling._provide_face_data_to_compute_kernels_default_guard ( self )

private

Definition at line 211 of file StaticCoupling.py.

References coupling.StaticCoupling.StaticCoupling._name, and coupling.StaticCoupling.StaticCoupling.get_name_of_global_instance().

Here is the call graph for this function:

◆ _restrict_face_data_default_guard()

def coupling.StaticCoupling.StaticCoupling._restrict_face_data_default_guard ( self )

private

Definition at line 291 of file StaticCoupling.py.

◆ _store_boundary_data_default_guard()

def coupling.StaticCoupling.StaticCoupling._store_boundary_data_default_guard ( self )

private

Definition at line 261 of file StaticCoupling.py.

References coupling.StaticCoupling.StaticCoupling._name, SBH.Limiter._store_face_data_default_guard(), coupling.StaticCoupling.StaticCoupling._store_face_data_default_guard(), and coupling.StaticCoupling.StaticCoupling.get_name_of_global_instance().

Here is the call graph for this function:

◆ _store_cell_data_default_guard()

def coupling.StaticCoupling.StaticCoupling._store_cell_data_default_guard ( self )

private

Definition at line 191 of file StaticCoupling.py.

References coupling.StaticCoupling.StaticCoupling._name, and coupling.StaticCoupling.StaticCoupling.get_name_of_global_instance().

Here is the call graph for this function:

◆ _store_face_data_default_guard()

def coupling.StaticCoupling.StaticCoupling._store_face_data_default_guard ( self )

private

Definition at line 236 of file StaticCoupling.py.

References coupling.StaticCoupling.StaticCoupling._name, and coupling.StaticCoupling.StaticCoupling.get_name_of_global_instance().

Referenced by coupling.StaticCoupling.StaticCoupling._store_boundary_data_default_guard().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _unknown_identifier()

def coupling.StaticCoupling.StaticCoupling._unknown_identifier ( self )

private

Definition at line 294 of file StaticCoupling.py.

References coupling.StaticCoupling.StaticCoupling._name.

Referenced by coupling.StaticCoupling.StaticCoupling._init_dictionary_with_default_parameters().

Here is the caller graph for this function:

◆ add_actions_to_create_grid()

def 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()

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

Definition at line 333 of file StaticCoupling.py.

References coupling.StaticCoupling.StaticCoupling._action_set_check_troubledness.

◆ add_actions_to_perform_time_step()

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

Definition at line 344 of file StaticCoupling.py.

References coupling.StaticCoupling.StaticCoupling._action_set_copy_face_data.

◆ add_actions_to_plot_solution()

def 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()

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

Definition at line 430 of file StaticCoupling.py.

Referenced by coupling.StaticCoupling.StaticCoupling._generate_kernels().

Here is the caller graph for this function:

◆ add_implementation_files_to_project()

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

References coupling.StaticCoupling.StaticCoupling._generate_kernels(), coupling.StaticCoupling.StaticCoupling._init_dictionary_with_default_parameters(), and coupling.StaticCoupling.StaticCoupling._name.

Here is the call graph for this function:

◆ add_to_Peano4_datamodel()

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

Definition at line 325 of file StaticCoupling.py.

References coupling.StaticCoupling.StaticCoupling._cell_label, and coupling.StaticCoupling.StaticCoupling._face_label.

◆ add_use_data_statements_to_Peano4_solver_step()

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

Definition at line 329 of file StaticCoupling.py.

References coupling.StaticCoupling.StaticCoupling._cell_label, and coupling.StaticCoupling.StaticCoupling._face_label.

◆ add_user_action_set_includes()

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

References coupling.StaticCoupling.StaticCoupling.user_action_set_includes.

Referenced by CCZ4Solver.AbstractCCZ4Solver._add_standard_includes().

Here is the caller graph for this function:

◆ create_action_sets()

def 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()

def 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()

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

Definition at line 172 of file StaticCoupling.py.

◆ get_name_of_global_instance()

def coupling.StaticCoupling.StaticCoupling.get_name_of_global_instance ( self )

Definition at line 297 of file StaticCoupling.py.

References coupling.StaticCoupling.StaticCoupling._name.

Here is the caller graph for this function:

◆ get_user_action_set_includes()

def coupling.StaticCoupling.StaticCoupling.get_user_action_set_includes ( self )

Definition at line 177 of file StaticCoupling.py.

References coupling.StaticCoupling.StaticCoupling.user_action_set_includes.

◆ get_user_solver_includes()

def coupling.StaticCoupling.StaticCoupling.get_user_solver_includes ( self )

Definition at line 180 of file StaticCoupling.py.

References coupling.StaticCoupling.StaticCoupling.user_solver_includes.

Referenced by coupling.StaticCoupling.StaticCoupling._init_dictionary_with_default_parameters().

Here is the caller graph for this function:

◆ set_plot_description()

def 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

private

Definition at line 113 of file StaticCoupling.py.

Referenced by coupling.StaticCoupling.StaticCoupling.add_actions_to_init_grid().

◆ _action_set_copy_face_data

coupling.StaticCoupling.StaticCoupling._action_set_copy_face_data

private

Definition at line 123 of file StaticCoupling.py.

Referenced by coupling.StaticCoupling.StaticCoupling.add_actions_to_perform_time_step().

◆ _cell_label

coupling.StaticCoupling.StaticCoupling._cell_label

private

Definition at line 87 of file StaticCoupling.py.

Referenced by coupling.StaticCoupling.StaticCoupling.add_to_Peano4_datamodel(), and coupling.StaticCoupling.StaticCoupling.add_use_data_statements_to_Peano4_solver_step().

◆ _constructor_implementation

coupling.StaticCoupling.StaticCoupling._constructor_implementation

private

Definition at line 56 of file StaticCoupling.py.

Referenced by coupling.StaticCoupling.StaticCoupling._init_dictionary_with_default_parameters().

◆ _face_label

coupling.StaticCoupling.StaticCoupling._face_label

private

Definition at line 88 of file StaticCoupling.py.

Referenced by coupling.StaticCoupling.StaticCoupling.add_to_Peano4_datamodel(), and coupling.StaticCoupling.StaticCoupling.add_use_data_statements_to_Peano4_solver_step().

◆ _finish_time_step_implementation

coupling.StaticCoupling.StaticCoupling._finish_time_step_implementation

private

Definition at line 53 of file StaticCoupling.py.

Referenced by coupling.StaticCoupling.StaticCoupling._init_dictionary_with_default_parameters().

◆ _limiter_solver

coupling.StaticCoupling.StaticCoupling._limiter_solver

private

Definition at line 35 of file StaticCoupling.py.

Referenced by coupling.StaticCoupling.StaticCoupling._generate_kernels(), and coupling.StaticCoupling.StaticCoupling._init_dictionary_with_default_parameters().

◆ _name

coupling.StaticCoupling.StaticCoupling._name

private

Definition at line 31 of file StaticCoupling.py.

◆ _physical_admissibility_criterion

coupling.StaticCoupling.StaticCoupling._physical_admissibility_criterion

private

Definition at line 58 of file StaticCoupling.py.

Referenced by coupling.StaticCoupling.StaticCoupling._init_dictionary_with_default_parameters().

◆ _print_time_step_implementation

coupling.StaticCoupling.StaticCoupling._print_time_step_implementation

private

Definition at line 54 of file StaticCoupling.py.

Referenced by coupling.StaticCoupling.StaticCoupling._init_dictionary_with_default_parameters().

◆ _regular_solver

coupling.StaticCoupling.StaticCoupling._regular_solver

private

Definition at line 34 of file StaticCoupling.py.

Referenced by coupling.StaticCoupling.StaticCoupling._generate_kernels(), and coupling.StaticCoupling.StaticCoupling._init_dictionary_with_default_parameters().

◆ _solver_user_declarations

coupling.StaticCoupling.StaticCoupling._solver_user_declarations

private

Definition at line 41 of file StaticCoupling.py.

Referenced by coupling.StaticCoupling.StaticCoupling._init_dictionary_with_default_parameters().

◆ _solver_user_definitions

coupling.StaticCoupling.StaticCoupling._solver_user_definitions

private

Definition at line 42 of file StaticCoupling.py.

Referenced by coupling.StaticCoupling.StaticCoupling._init_dictionary_with_default_parameters().

◆ _start_time_step_implementation

coupling.StaticCoupling.StaticCoupling._start_time_step_implementation

private

Definition at line 52 of file StaticCoupling.py.

Referenced by coupling.StaticCoupling.StaticCoupling._init_dictionary_with_default_parameters().

◆ plot_description

coupling.StaticCoupling.StaticCoupling.plot_description

Definition at line 349 of file StaticCoupling.py.

◆ user_action_set_includes

coupling.StaticCoupling.StaticCoupling.user_action_set_includes

Definition at line 44 of file StaticCoupling.py.

Referenced by coupling.StaticCoupling.StaticCoupling.add_user_action_set_includes(), and coupling.StaticCoupling.StaticCoupling.get_user_action_set_includes().

◆ user_solver_includes

coupling.StaticCoupling.StaticCoupling.user_solver_includes

Definition at line 45 of file StaticCoupling.py.

Referenced by coupling.StaticCoupling.StaticCoupling.get_user_solver_includes().

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

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

Public Member Functions

Data Fields

Private Member Functions

Private 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()