Peano
Loading...
Searching...
No Matches
scenarios.scenario.Scenario Class Reference
Inheritance diagram for scenarios.scenario.Scenario:
Inheritance graph
[legend]

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, and _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 api.Project.Project._dimensions, convert::input::PeanoTextPatchFileReader._dimensions, exahype2.kerneldsl.SyntaxTree.MemoryAllocation._dimensions, exahype2.kerneldsl.SyntaxTree.MemoryDeallocation._dimensions, exahype2.kerneldsl.SyntaxTree.TDataBlock._dimensions, exahype2.Project.Project._dimensions, peano4.visualisation.output.Visualiser.PatchFileData._dimensions, peano4.visualisation.output.Visualiser.Visualiser._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, _dimensions, solvers.api.ContinuousGalerkinDiscretisationGaussLobattoWithBlockJacobi.ContinuousGalerkinDiscretisationGaussLobattoWithBlockJacobi._dimensions, solvers.api.DiscontinuousGalerkinDiscretisationPointWiseRiemannSolver.DiscontinuousGalerkinDiscretisationPointWiseRiemannSolver._dimensions, swift2.Project.Project._dimensions, tarch::plotter::griddata::blockstructured::PeanoHDF5PatchFileWriter._dimensions, tarch::plotter::griddata::blockstructured::PeanoTextPatchFileWriter._dimensions, api.Project.Project._domain_size, api.Tree.Tree._domain_size, exahype2.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, _domain_size, swift2.Project.Project._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, _end_time, exahype2.kerneldsl.SyntaxTree.DataBlock._offset, exahype2.kerneldsl.SyntaxTree.DataBlockBinaryOperation._offset, exahype2.kerneldsl.SyntaxTree.DataBlockComparison._offset, exahype2.kerneldsl.SyntaxTree.DataBlockUnaryOperation._offset, 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, _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, _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, and _plot_dt.

Field Documentation

◆ _dimensions

int scenarios.scenario.Scenario._dimensions = 2
staticprotected

Definition at line 8 of file scenario.py.

Referenced by 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 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 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 set_global_simulation_parameters().

◆ _periodic_bc

bool scenarios.scenario.Scenario._periodic_bc = False
staticprotected

Definition at line 13 of file scenario.py.

Referenced by boundary_conditions(), and 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 set_global_simulation_parameters().

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