Peano

swift2.Project.Project.__init__	(	self,
		namespace,
		project_name,
		directory = ".",
		executable = "swift2" )

Definition at line 46 of file Project.py.

swift2.Project.Project.__compute_global_max_h ( self )

private

Run over all species specified and find out what their maximum (coarsest) h is.

This value is then used to constrain the mesh adaptivity: The mesh should never be coarser than this, but also the initial mesh should meet this global maximum h.

The outcome is stored in self._global_max_h.

Definition at line 134 of file Project.py.

Referenced by swift2.Project.Project.generate_Peano4_project().

Here is the caller graph for this function:

swift2.Project.Project.__compute_global_min_h ( self )

private

Run over all species specified and find out what their minimum (finest) h is.

This value is then used to constrain the mesh adaptivity: The mesh should never be coarser than this, but also the initial mesh should meet this global maximum h.

The outcome is stored in self._global_min_h.

Definition at line 151 of file Project.py.

Referenced by swift2.Project.Project.generate_Peano4_project().

Here is the caller graph for this function:

swift2.Project.Project.__configure_makefile ( self )

private

Definition at line 381 of file Project.py.

Referenced by exahype2.Project.Project.generate_Peano4_project(), swift2.Project.Project.generate_Peano4_project(), and api.Project.Project.generate_Peano4_project().

Here is the caller graph for this function:

swift2.Project.Project.__export_constants ( self )

private

We export SWIFT's constants.

Besides the constants from SWIFT, I also export some parameters from Peano onto the SWIFT constants file. Therefore, it is important that you parse the configure output before we export the constants.

Definition at line 168 of file Project.py.

References exahype2.kerneldsl.SyntaxTree.Subscript._dimensions, exahype2.kerneldsl.SyntaxTree.Matrix._dimensions, exahype2.kerneldsl.SyntaxTree.TSimpleMemref._dimensions, exahype2.kerneldsl.SyntaxTree.TDataBlock._dimensions, exahype2.kerneldsl.SyntaxTree.MemoryAllocation._dimensions, exahype2.kerneldsl.SyntaxTree.MemoryDeallocation._dimensions, exahype2.Project.Project._dimensions, peano4.visualisation.output.Visualiser.PatchFileData._dimensions, peano4.visualisation.output.Visualiser.Visualiser._dimensions, swift2.Project.Project._dimensions, convert::input::PeanoTextPatchFileReader._dimensions, api.Project.Project._dimensions, solvers.api.ContinuousGalerkinDiscretisationGaussLobattoWithBlockJacobi.ContinuousGalerkinDiscretisationGaussLobattoWithBlockJacobi._dimensions, solvers.api.DiscontinuousGalerkinDiscretisationPointWiseRiemannSolver.DiscontinuousGalerkinDiscretisationPointWiseRiemannSolver._dimensions, tarch::plotter::griddata::blockstructured::PeanoHDF5PatchFileWriter._dimensions, tarch::plotter::griddata::blockstructured::PeanoTextPatchFileWriter._dimensions, scenarios.acoustic_planar_waves.AcousticPlanarWaves._dimensions, scenarios.advection_linear.AdvectionLinear._dimensions, scenarios.elastic_planar_waves.ElasticPlanarWaves._dimensions, scenarios.euler_gaussian_bell.EulerGaussianBell._dimensions, scenarios.euler_isotropic_vortex.EulerIsotropicVortex._dimensions, scenarios.scenario.Scenario._dimensions, scenarios.swe_radial_dam_break.SWERadialDamBreak._dimensions, scenarios.swe_resting_lake.SWERestingLake._dimensions, exahype2.Project.Project._domain_offset, swift2.Project.Project._domain_offset, api.Project.Project._domain_offset, api.Tree.Tree._domain_offset, exahype2.Project.Project._domain_size, swift2.Project.Project._domain_size, api.Project.Project._domain_size, api.Tree.Tree._domain_size, scenarios.acoustic_planar_waves.AcousticPlanarWaves._domain_size, scenarios.elastic_planar_waves.ElasticPlanarWaves._domain_size, scenarios.euler_gaussian_bell.EulerGaussianBell._domain_size, scenarios.euler_isotropic_vortex.EulerIsotropicVortex._domain_size, scenarios.scenario.Scenario._domain_size, scenarios.swe_radial_dam_break.SWERadialDamBreak._domain_size, scenarios.swe_resting_lake.SWERestingLake._domain_size, exahype2.Project.Project._first_plot_time_stamp, swift2.Project.Project._first_plot_time_stamp, exahype2.Project.Project._max_terminal_time, swift2.Project.Project._max_terminal_time, exahype2.Project.Project._min_terminal_time, swift2.Project.Project._min_terminal_time, exahype2.Project.Project._project, peano4.solversteps.Steps.Steps._project, swift2.Project.Project._project, api.Project.Project._project, exahype2.Project.Project._time_in_between_plots, and swift2.Project.Project._time_in_between_plots.

Referenced by api.Project.Project.__configure_makefile(), exahype2.Project.Project.generate_Peano4_project(), and swift2.Project.Project.generate_Peano4_project().

Here is the caller graph for this function:

swift2.Project.Project.__generate_global_state_files ( self )

private

Definition at line 440 of file Project.py.

References exahype2.Project.Project._load_balancer_arguments, swift2.Project.Project._load_balancer_arguments, api.Project.Project._load_balancer_arguments, exahype2.Project.Project._load_balancer_name, swift2.Project.Project._load_balancer_name, api.Project.Project._load_balancer_name, swift2.Project.Project._particle_species, exahype2.Project.Project._project, peano4.solversteps.Steps.Steps._project, swift2.Project.Project._project, and api.Project.Project._project.

Referenced by swift2.Project.Project.generate_Peano4_project().

Here is the caller graph for this function:

swift2.Project.Project.__real_max_mesh_size ( self )

private

Return the max mesh size that the code really will use.

See the explanation in the generated Readme.md file or in real_mesh_size why this value is smaller than the real mesh size.

Definition at line 357 of file Project.py.

References swift2.Project.Project._global_max_h, and swift2.Project.Project.real_mesh_size().

Here is the call graph for this function:

swift2.Project.Project.__real_min_mesh_size ( self )

private

Return the min mesh size that the code really will use.

See the explanation in the generated Readme.md file or in real_mesh_size why this value is smaller than the real mesh size.

Definition at line 369 of file Project.py.

References swift2.Project.Project._global_min_h, and swift2.Project.Project.real_mesh_size().

Here is the call graph for this function:

swift2.Project.Project.add_particle_species	(		self,
		Particle	particle )

Add a new particle species (type) to the project.

You get the container back in which the particles are handled on the rank. Use this one where another action set requires a particle set.

Definition at line 465 of file Project.py.

References swift2.Project.Project._particle_species, and swift2.Project.Project._particle_species_set.

swift2.Project.Project.generate_Peano4_project	(		self,
			verbose = False )

Build the Peano4 project.

The main job of this routine is to add all the action sets et al that you require to run this ExaHyPE2 application.

This routine generates a Peano project, i.e. the domain-specific ExaHyPE view is translated into a Peano model. Once you have called this routine, any changes to the ExaHyPE 2 configuration do not propagate into the Peano setup anymore. If you alter the ExaHyPE setup, you have to call generate_Peano4_project() again to get a new snapshot/version of the Peano setup.

Initial grid

The initial grid will be a regular one, spanned through

action_set_create_regular_grid = peano4.toolbox.CreateRegularGrid(...)

peano4.toolbox.CreateRegularGrid.CreateRegularGrid

Definition CreateRegularGrid.py:7

According to the documentation of peano4.toolbox.CreateRegularGrid, the action set will produce a mesh that is just finer than the mesh width passed, so we meet the max mesh width, but do not create a mesh that is significantly finer.

As we insert particles in SPH, we have therefore to make this initial resolution three times coarser than what we allow, as we only insert particles into the finest mesh.

Task graph compiler

The core contribution of the generation is the task graph compiler which really is a mapping of algorithm steps per particle species onto grid sweeps. The actual mapping is outsourced into the function represented by self.task_graph_compiler. This way, users can switch the translator's behaviour. This function returns a sequence of mesh traversals. On top of that, we have the default traversals to create a grid, to plot it, to initialise the setup, and to clean up after we're done.

Once we have our three default steps plus a sequence of algorithmic steps per time step, we run through the following steps:

Create a particle set around each species and add it to the project as global variable. This is the global container administering these guys.
Tell each algorithmic step to use this particle set. An exception could be the grid creation. At this point, we don't have particles yet. We add the data structure nevertheless. It ensures that we have all the data in place, and it we also then can be sure that everything is properly initialised. The actual particle set will be empty at this point of the simulation.
Ensure that plotting and initialisation use the update particle-grid association properly. The plot has to update it, as previous steps might have started a resort yet might not have finished it.
Add all the algorithmic steps, including the default ones, to the project.

Particle initialisation and proper sorting

The particle initialisation might end up with an invalid association of particles to vertices. The graph compiler might make the first step of a time step sequence sort if and only if the last one has altered the particles' position. Consequently, we might end up with an initialisation which yields an inconsistent data association. We therefore make it sort the particles, but we need another grid sweep to finalise this sort in case we have to do some global rearrangements. This is our rationale why we realise the initialisation in two steps.

Definition at line 479 of file Project.py.

Here is the call graph for this function:

swift2.Project.Project.main_file_template ( self )

Definition at line 975 of file Project.py.

swift2.Project.Project.real_mesh_size	(		self,
			target_h )

Translate a mesh size into its real Peano mesh size.

Peano uses three-partitioning. That is, it will neve be able to match given refinement instructions exactly. All it can do is to approximate them.

Returns: Tuple of mesh size and mesh levels

Definition at line 338 of file Project.py.

References exahype2.Project.Project._domain_size, swift2.Project.Project._domain_size, api.Project.Project._domain_size, api.Tree.Tree._domain_size, scenarios.acoustic_planar_waves.AcousticPlanarWaves._domain_size, scenarios.elastic_planar_waves.ElasticPlanarWaves._domain_size, scenarios.euler_gaussian_bell.EulerGaussianBell._domain_size, scenarios.euler_isotropic_vortex.EulerIsotropicVortex._domain_size, scenarios.scenario.Scenario._domain_size, scenarios.swe_radial_dam_break.SWERadialDamBreak._domain_size, and scenarios.swe_resting_lake.SWERestingLake._domain_size.

Referenced by swift2.Project.Project.__real_max_mesh_size(), and swift2.Project.Project.__real_min_mesh_size().

Here is the caller graph for this function:

swift2.Project.Project.set_global_simulation_parameters	(	self,
		dimensions,
		offset,
		domain_size,
		min_end_time,
		max_end_time,
		first_plot_time_stamp,
		time_in_between_plots,
		periodic_BC = [False, False, False],
		plotter_precision = 5,
		initial_grid_coarse = False )

offset and size should be lists with dimensions double entries.

first_plot_time_stamp: Float Is irrelevant if time_in_between_plots equals zero

time_in_between_plots: Float Set to zero if you don't want to have any plots

max_end_time: Float If you set it zero (or actually any value msmaller than min_end_time), then the code will run until the cell that lags behind the most hits the min time. If you specify a valid max time however, you can stop the sim as soon as the most advanced cell exceeds this threshold.

initial_grid_coarse: Bool If true, make the initial grid coarse, i.e. according to max cell size, which is specified via max_h in the added particle species. Otherwise, make initial grid fine, i.e. according to the particle species' min_h.

Definition at line 385 of file Project.py.

swift2.Project.Project.set_load_balancing	(	self,
		load_balancer_name,
		load_balancer_arguments )

load_balancer_name: string Should be full-qualified name of the load balancer.

By default, I recommend to pass "toolbox::loadbalancing::strategies::SpreadOutHierarchically", but you might be well-advices to study different classes within the namespace toolbox::loadbalancing.

load_balancer_arguments: string If your load balancing requires parameters, add them here. It is a string that will be copied into the C++ class instantiation. Please add the brackets yourself, i.e. "(3,4,5)" is fine, but "3,4,5" is not. The only exception is the empty parameter list. Here, you can/should simply add the empty string.

Definition at line 84 of file Project.py.

References exahype2.Project.Project._load_balancer_arguments, swift2.Project.Project._load_balancer_arguments, api.Project.Project._load_balancer_arguments, exahype2.Project.Project._load_balancer_name, swift2.Project.Project._load_balancer_name, and api.Project.Project._load_balancer_name.

swift2.Project.Project.set_output_path	(		self,
			path )

Definition at line 435 of file Project.py.

References exahype2.Project.Project._output_path, swift2.Project.Project._output_path, and api.Project.Project._output_path.

swift2.Project.Project.set_Peano4_installation	(	self,
		src_path,
		mode = peano4.output.CompileMode.Release )

src_path: string Path (relative or absolute) to the src directory of Peano.

This path should hold both the headers (in subdirectories) and all the static libraries.

mode: peano4.output.CompileMode

Definition at line 110 of file Project.py.

References exahype2.Project.Project._build_mode, swift2.Project.Project._build_mode, api.Project.Project._build_mode, exahype2.Project.Project._Peano_src_directory, swift2.Project.Project._Peano_src_directory, and api.Project.Project._Peano_src_directory.

swift2.Project.Project.set_realisation	(	self,
		parallelisation = Parallelisation_DomainDecomposition,
		storage = Storage_Scattered,
		sorting = Sorting_MultiscaleSort,
		kernel_optimisation = KernelOptimisation_NoOptimisation )

Specify the realisation of the project: Select.

which parallelisation method to use (domain-decomposition, task-graph, multisweep-task-graph)
which storage strategy to use (scattered, continuous-per-vertex, global-continuous)
which particle sorting strategy to use (multiscale-sort, bucket-sort)
which kernel optimisation to use (no-optimisation, vectorise-all, vectorise-distance-checks-preamble)

Available options for all these are kept in ./ProjectRealisation.py.

Only call this function after adding particle species to the project via self.add_particle_species().

Definition at line 714 of file Project.py.

References swift2.Project.Project._particle_species, swift2.Project.Project._particle_species_set, swift2.Project.Project.algorithm_steps_task_graph_compiler, and swift2.Project.Project.initialisation_steps_task_graph_compiler.

swift2.Project.Project._build_mode

protected

Definition at line 60 of file Project.py.

Referenced by api.Project.Project.__configure_makefile(), api.Project.Project.__init__(), exahype2.Project.Project.generate_Peano4_project(), swift2.Project.Project.generate_Peano4_project(), exahype2.Project.Project.set_Peano4_installation(), swift2.Project.Project.set_Peano4_installation(), and api.Project.Project.set_Peano4_installation().

swift2.Project.Project._dimensions

protected

Definition at line 51 of file Project.py.

Referenced by exahype2.Project.Project.__configure_makefile(), swift2.Project.Project.__configure_makefile(), api.Project.Project.__configure_makefile(), exahype2.Project.Project.__export_constants(), swift2.Project.Project.__export_constants(), api.Project.Project.__export_constants(), api.Project.Project.__init__(), solvers.api.ContinuousGalerkinDiscretisationGaussLobattoWithBlockJacobi.ContinuousGalerkinDiscretisationGaussLobattoWithBlockJacobi._construct_narrow_to_interior_matrix(), scenarios.elastic_planar_waves.ElasticPlanarWaves.analytical_solution(), peano4.visualisation.output.Visualiser.PatchFileData.apply_renderer_to_data(), exahype2.Project.Project.generate_Peano4_project(), exahype2.kerneldsl.SyntaxTree.TSimpleMemref.get_dimensions(), exahype2.kerneldsl.SyntaxTree.Matrix.index(), scenarios.elastic_planar_waves.ElasticPlanarWaves.initial_conditions(), exahype2.kerneldsl.SyntaxTree.TDataBlock.is_nested_memref(), exahype2.kerneldsl.SyntaxTree.TSimpleMemref.print_mlir(), exahype2.kerneldsl.SyntaxTree.TDataBlock.print_mlir(), swift2.Project.Project.set_global_simulation_parameters(), api.Project.Project.set_global_simulation_parameters(), api.Project.Project.set_global_simulation_parameters(), exahype2.Project.Project.set_global_simulation_parameters(), and scenarios.scenario.Scenario.set_global_simulation_parameters().

swift2.Project.Project._domain_offset

protected

Definition at line 49 of file Project.py.

Referenced by exahype2.Project.Project.__export_constants(), swift2.Project.Project.__export_constants(), api.Project.Project.__export_constants(), api.Project.Project.__init__(), api.Tree.Tree.__str__(), api.Project.Project.generate_Peano4_project(), swift2.Project.Project.set_global_simulation_parameters(), api.Project.Project.set_global_simulation_parameters(), api.Project.Project.set_global_simulation_parameters(), and exahype2.Project.Project.set_global_simulation_parameters().

swift2.Project.Project._domain_size

protected

Definition at line 50 of file Project.py.

Referenced by exahype2.Project.Project.__export_constants(), swift2.Project.Project.__export_constants(), api.Project.Project.__export_constants(), api.Project.Project.__init__(), api.Tree.Tree.__str__(), api.Project.Project.generate_Peano4_project(), swift2.Project.Project.real_mesh_size(), swift2.Project.Project.set_global_simulation_parameters(), api.Project.Project.set_global_simulation_parameters(), api.Project.Project.set_global_simulation_parameters(), exahype2.Project.Project.set_global_simulation_parameters(), and scenarios.scenario.Scenario.set_global_simulation_parameters().

swift2.Project.Project._executable_name

protected

Definition at line 61 of file Project.py.

Referenced by exahype2.Project.Project.__configure_makefile(), swift2.Project.Project.__configure_makefile(), api.Project.Project.__configure_makefile(), api.Project.Project.__init__(), peano4.output.Readme.Readme.generate(), and peano4.output.Readme.Readme.set_executable_name().

swift2.Project.Project._first_plot_time_stamp

protected

Definition at line 55 of file Project.py.

Referenced by exahype2.Project.Project.__export_constants(), swift2.Project.Project.__export_constants(), swift2.Project.Project.set_global_simulation_parameters(), and exahype2.Project.Project.set_global_simulation_parameters().

swift2.Project.Project._global_max_h

protected

Definition at line 145 of file Project.py.

Referenced by swift2.Project.Project.__real_max_mesh_size(), and swift2.Project.Project.generate_Peano4_project().

swift2.Project.Project._global_min_h

protected

Definition at line 162 of file Project.py.

Referenced by swift2.Project.Project.__real_min_mesh_size(), and swift2.Project.Project.generate_Peano4_project().

swift2.Project.Project._load_balancer_arguments

protected

Definition at line 58 of file Project.py.

Referenced by swift2.Project.Project.__generate_global_state_files(), api.Project.Project.__init__(), swift2.Project.Project.set_load_balancing(), api.Project.Project.set_load_balancing(), and exahype2.Project.Project.set_load_balancing().

swift2.Project.Project._load_balancer_name

protected

Definition at line 57 of file Project.py.

Referenced by swift2.Project.Project.__generate_global_state_files(), api.Project.Project.__init__(), swift2.Project.Project.set_load_balancing(), api.Project.Project.set_load_balancing(), and exahype2.Project.Project.set_load_balancing().

swift2.Project.Project._make_initial_grid_coarse

protected

Definition at line 54 of file Project.py.

Referenced by swift2.Project.Project.generate_Peano4_project(), and swift2.Project.Project.set_global_simulation_parameters().

swift2.Project.Project._max_terminal_time

protected

Definition at line 53 of file Project.py.

Referenced by exahype2.Project.Project.__export_constants(), swift2.Project.Project.__export_constants(), swift2.Project.Project.set_global_simulation_parameters(), and exahype2.Project.Project.set_global_simulation_parameters().

swift2.Project.Project._min_terminal_time

protected

Definition at line 52 of file Project.py.

Referenced by exahype2.Project.Project.__export_constants(), swift2.Project.Project.__export_constants(), swift2.Project.Project.set_global_simulation_parameters(), and exahype2.Project.Project.set_global_simulation_parameters().

swift2.Project.Project._output_path

protected

Definition at line 63 of file Project.py.

Referenced by api.Project.Project.__init__(), exahype2.Project.Project.generate_Peano4_project(), exahype2.Project.Project.set_output_path(), swift2.Project.Project.set_output_path(), and api.Project.Project.set_output_path().

swift2.Project.Project._particle_species

protected

Definition at line 65 of file Project.py.

Referenced by swift2.Project.Project.__generate_global_state_files(), swift2.Project.Project.add_particle_species(), and swift2.Project.Project.set_realisation().

swift2.Project.Project._particle_species_set

protected

Definition at line 66 of file Project.py.

Referenced by swift2.Project.Project.add_particle_species(), swift2.Project.Project.generate_Peano4_project(), and swift2.Project.Project.set_realisation().

swift2.Project.Project._Peano_src_directory

protected

Definition at line 59 of file Project.py.

Referenced by api.Project.Project.__configure_makefile(), api.Project.Project.__init__(), exahype2.Project.Project.generate_Peano4_project(), swift2.Project.Project.generate_Peano4_project(), exahype2.Project.Project.set_Peano4_installation(), swift2.Project.Project.set_Peano4_installation(), and api.Project.Project.set_Peano4_installation().

swift2.Project.Project._periodic_BC

protected

Definition at line 62 of file Project.py.

Referenced by exahype2.Project.Project.__export_constants(), swift2.Project.Project.set_global_simulation_parameters(), and exahype2.Project.Project.set_global_simulation_parameters().

swift2.Project.Project._plotter_precision

protected

Definition at line 211 of file Project.py.

Referenced by exahype2.Project.Project.__export_constants(), api.Project.Project.__export_constants(), swift2.Project.Project.set_global_simulation_parameters(), api.Project.Project.set_global_simulation_parameters(), and exahype2.Project.Project.set_global_simulation_parameters().

swift2.Project.Project._project

protected

Definition at line 47 of file Project.py.

Referenced by exahype2.Project.Project.__configure_makefile(), swift2.Project.Project.__configure_makefile(), api.Project.Project.__configure_makefile(), exahype2.Project.Project.__export_constants(), swift2.Project.Project.__export_constants(), api.Project.Project.__export_constants(), swift2.Project.Project.__generate_global_state_files(), exahype2.Project.Project.__generate_solver_repository(), api.Project.Project.__generate_solver_repository(), api.Project.Project.__init__(), api.Project.Project.add_solver(), api.Project.Project.add_solver(), peano4.solversteps.Steps.Steps.add_step(), exahype2.Project.Project.add_tracer(), exahype2.Project.Project.generate_Peano4_project(), swift2.Project.Project.generate_Peano4_project(), api.Project.Project.generate_Peano4_project(), exahype2.Project.Project.remove_all_solvers(), and exahype2.Project.Project.set_global_simulation_parameters().

swift2.Project.Project._time_in_between_plots

protected

Definition at line 56 of file Project.py.

Referenced by exahype2.Project.Project.__export_constants(), swift2.Project.Project.__export_constants(), swift2.Project.Project.set_global_simulation_parameters(), and exahype2.Project.Project.set_global_simulation_parameters().

swift2.Project.Project.additional_action_sets_per_solver_step

Definition at line 75 of file Project.py.

Referenced by swift2.Project.Project.generate_Peano4_project().

swift2.Project.Project.algorithm_step_cleanup

Definition at line 73 of file Project.py.

Referenced by swift2.Project.Project.generate_Peano4_project().

swift2.Project.Project.algorithm_step_create_grid

Definition at line 68 of file Project.py.

Referenced by api.Project.Project.__init__(), api.Project.Project.add_solver(), api.Project.Project.add_solver(), swift2.Project.Project.generate_Peano4_project(), and api.Project.Project.generate_Peano4_project().

swift2.Project.Project.algorithm_step_initial_conditions

Definition at line 69 of file Project.py.

Referenced by swift2.Project.Project.generate_Peano4_project().

swift2.Project.Project.algorithm_step_plot

Definition at line 72 of file Project.py.

Referenced by api.Project.Project.add_solver(), api.Project.Project.add_solver(), swift2.Project.Project.generate_Peano4_project(), and api.Project.Project.generate_Peano4_project().

swift2.Project.Project.algorithm_steps_task_graph_compiler

Definition at line 78 of file Project.py.

Referenced by swift2.Project.Project.generate_Peano4_project(), and swift2.Project.Project.set_realisation().

swift2.Project.Project.initialisation_steps_task_graph_compiler

Definition at line 79 of file Project.py.

Referenced by swift2.Project.Project.generate_Peano4_project(), and swift2.Project.Project.set_realisation().

str swift2.Project.Project.LibraryAsserts = "_asserts"

static

Definition at line 107 of file Project.py.

str swift2.Project.Project.LibraryDebug = "_debug"

static

Definition at line 104 of file Project.py.

str swift2.Project.Project.LibraryRelease = ""

static

Definition at line 105 of file Project.py.

str swift2.Project.Project.LibraryStats = "_stats"

static

Definition at line 108 of file Project.py.

str swift2.Project.Project.LibraryTrace = "_trace"

static

Definition at line 106 of file Project.py.

Public Member Functions
	__init__ (self, namespace, project_name, directory=".", executable="swift2")

	set_load_balancing (self, load_balancer_name, load_balancer_arguments)
	load_balancer_name: string Should be full-qualified name of the load balancer.

	set_Peano4_installation (self, src_path, mode=peano4.output.CompileMode.Release)
	src_path: string Path (relative or absolute) to the src directory of Peano.

	real_mesh_size (self, target_h)
	Translate a mesh size into its real Peano mesh size.

	set_global_simulation_parameters (self, dimensions, offset, domain_size, min_end_time, max_end_time, first_plot_time_stamp, time_in_between_plots, periodic_BC=[False, False, False], plotter_precision=5, initial_grid_coarse=False)
	offset and size should be lists with dimensions double entries.

	set_output_path (self, path)

	add_particle_species (self, Particle particle)
	Add a new particle species (type) to the project.

	generate_Peano4_project (self, verbose=False)
	Build the Peano4 project.

	set_realisation (self, parallelisation=Parallelisation_DomainDecomposition, storage=Storage_Scattered, sorting=Sorting_MultiscaleSort, kernel_optimisation=KernelOptimisation_NoOptimisation)
	Specify the realisation of the project: Select.

	main_file_template (self)

Private Member Functions
	__compute_global_max_h (self)
	Run over all species specified and find out what their maximum (coarsest) h is.

	__compute_global_min_h (self)
	Run over all species specified and find out what their minimum (finest) h is.

	__export_constants (self)
	We export SWIFT's constants.

	__real_max_mesh_size (self)
	Return the max mesh size that the code really will use.

	__real_min_mesh_size (self)
	Return the min mesh size that the code really will use.

	__configure_makefile (self)

	__generate_global_state_files (self)

Data Fields
	algorithm_step_create_grid

	algorithm_step_initial_conditions

	algorithm_step_plot

	algorithm_step_cleanup

	additional_action_sets_per_solver_step

	algorithm_steps_task_graph_compiler

	initialisation_steps_task_graph_compiler

Static Public Attributes
str	LibraryDebug = "_debug"

str	LibraryRelease = ""

str	LibraryTrace = "_trace"

str	LibraryAsserts = "_asserts"

str	LibraryStats = "_stats"

Protected Attributes
	_project

	_domain_offset

	_domain_size

	_dimensions

	_min_terminal_time

	_max_terminal_time

	_make_initial_grid_coarse

	_first_plot_time_stamp

	_time_in_between_plots

	_load_balancer_name

	_load_balancer_arguments

	_Peano_src_directory

	_build_mode

	_executable_name

	_periodic_BC

	_output_path

	_particle_species

	_particle_species_set

	_global_max_h

	_global_min_h

	_plotter_precision

Public Member Functions

Data Fields

Static Public Attributes

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __compute_global_max_h()

◆ __compute_global_min_h()

◆ __configure_makefile()

◆ __export_constants()

◆ __generate_global_state_files()

◆ __real_max_mesh_size()

◆ __real_min_mesh_size()

◆ add_particle_species()

◆ generate_Peano4_project()

Initial grid

Task graph compiler

Particle initialisation and proper sorting

◆ main_file_template()

◆ real_mesh_size()

◆ set_global_simulation_parameters()

◆ set_load_balancing()

◆ set_output_path()

◆ set_Peano4_installation()

◆ set_realisation()

Field Documentation

◆ _build_mode

◆ _dimensions

◆ _domain_offset

◆ _domain_size

◆ _executable_name

◆ _first_plot_time_stamp

◆ _global_max_h

◆ _global_min_h

◆ _load_balancer_arguments

◆ _load_balancer_name

◆ _make_initial_grid_coarse

◆ _max_terminal_time

◆ _min_terminal_time

◆ _output_path

◆ _particle_species

◆ _particle_species_set

◆ _Peano_src_directory

◆ _periodic_BC

◆ _plotter_precision

◆ _project

◆ _time_in_between_plots

◆ additional_action_sets_per_solver_step

◆ algorithm_step_cleanup

◆ algorithm_step_create_grid

◆ algorithm_step_initial_conditions

◆ algorithm_step_plot

◆ algorithm_steps_task_graph_compiler

◆ initialisation_steps_task_graph_compiler

◆ LibraryAsserts

◆ LibraryDebug

◆ LibraryRelease

◆ LibraryStats

◆ LibraryTrace

◆ init()