scenarios.scenario.Scenario Class Reference

Inheritance diagram for scenarios.scenario.Scenario:

Public Member Functions
	initial_conditions (self)
	boundary_conditions (self)
	refinement_criterion (self)
	analytical_solution (self)
	set_global_simulation_parameters (self, project)

Static Protected Attributes
	_equation = None
int	_dimensions = 2
float	_end_time = 1.0
float	_plot_dt = 0.1
float	_offset = 0.0
float	_domain_size = 1.0
bool	_periodic_bc = False

Detailed Description

Definition at line 6 of file scenario.py.

Member Function Documentation

analytical_solution()

scenarios.scenario.Scenario.analytical_solution

(

self

)

Reimplemented in scenarios.acoustic_planar_waves.AcousticPlanarWaves, scenarios.elastic_planar_waves.ElasticPlanarWaves, scenarios.euler_gaussian_bell.EulerGaussianBell, scenarios.euler_isotropic_vortex.EulerIsotropicVortex, and scenarios.swe_resting_lake.SWERestingLake.

Definition at line 28 of file scenario.py.

boundary_conditions()

scenarios.scenario.Scenario.boundary_conditions

(

self

)

Reimplemented in scenarios.advection_linear.AdvectionLinear, and scenarios.swe_radial_dam_break.SWERadialDamBreak.

Definition at line 18 of file scenario.py.

References scenarios.acoustic_planar_waves.AcousticPlanarWaves._periodic_bc, scenarios.advection_linear.AdvectionLinear._periodic_bc, scenarios.elastic_planar_waves.ElasticPlanarWaves._periodic_bc, scenarios.euler_gaussian_bell.EulerGaussianBell._periodic_bc, scenarios.euler_isotropic_vortex.EulerIsotropicVortex._periodic_bc, scenarios.scenario.Scenario._periodic_bc, scenarios.swe_radial_dam_break.SWERadialDamBreak._periodic_bc, and scenarios.swe_resting_lake.SWERestingLake._periodic_bc.

initial_conditions()

scenarios.scenario.Scenario.initial_conditions

(

self

)

Reimplemented in scenarios.acoustic_planar_waves.AcousticPlanarWaves, scenarios.advection_linear.AdvectionLinear, scenarios.elastic_planar_waves.ElasticPlanarWaves, scenarios.euler_gaussian_bell.EulerGaussianBell, scenarios.euler_isotropic_vortex.EulerIsotropicVortex, scenarios.swe_radial_dam_break.SWERadialDamBreak, and scenarios.swe_resting_lake.SWERestingLake.

Definition at line 15 of file scenario.py.

refinement_criterion()

scenarios.scenario.Scenario.refinement_criterion

(

self

)

Definition at line 25 of file scenario.py.

set_global_simulation_parameters()

scenarios.scenario.Scenario.set_global_simulation_parameters	(		self,
			project )

Definition at line 31 of file scenario.py.

References 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_size, swift2.Project.Project._domain_size, api.Project.Project._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, scenarios.acoustic_planar_waves.AcousticPlanarWaves._end_time, scenarios.elastic_planar_waves.ElasticPlanarWaves._end_time, scenarios.euler_gaussian_bell.EulerGaussianBell._end_time, scenarios.euler_isotropic_vortex.EulerIsotropicVortex._end_time, scenarios.scenario.Scenario._end_time, scenarios.swe_radial_dam_break.SWERadialDamBreak._end_time, scenarios.swe_resting_lake.SWERestingLake._end_time, peano4::grid::GridControlEvent._offset, scenarios.acoustic_planar_waves.AcousticPlanarWaves._offset, scenarios.elastic_planar_waves.ElasticPlanarWaves._offset, scenarios.euler_gaussian_bell.EulerGaussianBell._offset, scenarios.euler_isotropic_vortex.EulerIsotropicVortex._offset, scenarios.scenario.Scenario._offset, scenarios.swe_radial_dam_break.SWERadialDamBreak._offset, scenarios.swe_resting_lake.SWERestingLake._offset, scenarios.acoustic_planar_waves.AcousticPlanarWaves._periodic_bc, scenarios.advection_linear.AdvectionLinear._periodic_bc, scenarios.elastic_planar_waves.ElasticPlanarWaves._periodic_bc, scenarios.euler_gaussian_bell.EulerGaussianBell._periodic_bc, scenarios.euler_isotropic_vortex.EulerIsotropicVortex._periodic_bc, scenarios.scenario.Scenario._periodic_bc, scenarios.swe_radial_dam_break.SWERadialDamBreak._periodic_bc, scenarios.swe_resting_lake.SWERestingLake._periodic_bc, scenarios.acoustic_planar_waves.AcousticPlanarWaves._plot_dt, scenarios.advection_linear.AdvectionLinear._plot_dt, scenarios.elastic_planar_waves.ElasticPlanarWaves._plot_dt, scenarios.euler_gaussian_bell.EulerGaussianBell._plot_dt, scenarios.euler_isotropic_vortex.EulerIsotropicVortex._plot_dt, scenarios.scenario.Scenario._plot_dt, scenarios.swe_radial_dam_break.SWERadialDamBreak._plot_dt, and scenarios.swe_resting_lake.SWERestingLake._plot_dt.

Field Documentation

_dimensions

int scenarios.scenario.Scenario._dimensions = 2

staticprotected

Definition at line 8 of file scenario.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(), scenarios.elastic_planar_waves.ElasticPlanarWaves.initial_conditions(), 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().

_domain_size

float scenarios.scenario.Scenario._domain_size = 1.0

staticprotected

Definition at line 12 of file scenario.py.

Referenced by exahype2.Project.Project.__export_constants(), swift2.Project.Project.__export_constants(), api.Project.Project.__export_constants(), api.Project.Project.__init__(), 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().

_end_time

float scenarios.scenario.Scenario._end_time = 1.0

staticprotected

Definition at line 9 of file scenario.py.

Referenced by scenarios.scenario.Scenario.set_global_simulation_parameters().

_equation

scenarios.scenario.Scenario._equation = None

staticprotected

Definition at line 7 of file scenario.py.

_offset

float scenarios.scenario.Scenario._offset = 0.0

staticprotected

Definition at line 11 of file scenario.py.

Referenced by scenarios.scenario.Scenario.set_global_simulation_parameters().

_periodic_bc

bool scenarios.scenario.Scenario._periodic_bc = False

staticprotected

Definition at line 13 of file scenario.py.

Referenced by scenarios.scenario.Scenario.boundary_conditions(), and scenarios.scenario.Scenario.set_global_simulation_parameters().

_plot_dt

float scenarios.scenario.Scenario._plot_dt = 0.1

staticprotected

Definition at line 10 of file scenario.py.

Referenced by scenarios.scenario.Scenario.set_global_simulation_parameters().

---

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

• tests/exahype2/aderdg/scenarios/scenario.py