gusto package

Subpackages

• gusto.complex_proxy package
  • Submodules
  • gusto.complex_proxy.common module
    • ComplexConstant()
    • ComplexConstantImpl
    • Part
      • Part.Imag
      • Part.Real
  • gusto.complex_proxy.mixed module
  • gusto.complex_proxy.mixed_impl module
    • BilinearForm()
    • ComplexConstant()
    • DirichletBC()
    • FiniteElement()
    • FunctionSpace()
    • LinearForm()
    • Part
      • Part.Imag
      • Part.Real
    • derivative()
    • get_imag()
    • get_real()
    • set_imag()
    • set_real()
    • split()
    • subfunctions()
  • gusto.complex_proxy.vector module
  • gusto.complex_proxy.vector_impl module
    • BilinearForm()
    • ComplexConstant()
    • DirichletBC()
    • FiniteElement()
    • FunctionSpace()
    • LinearForm()
    • Part
      • Part.Imag
      • Part.Real
    • derivative()
    • get_imag()
    • get_real()
    • set_imag()
    • set_real()
    • split()
    • subfunctions()
  • Module contents
• gusto.core package
  • Submodules
  • gusto.core.configuration module
    • Configuration
    • ConservativeEmbeddedDGOptions
      • ConservativeEmbeddedDGOptions.orig_rho_space
      • ConservativeEmbeddedDGOptions.project_back_method
      • ConservativeEmbeddedDGOptions.rho_name
    • ConservativeRecoveryOptions
      • ConservativeRecoveryOptions.orig_rho_space
      • ConservativeRecoveryOptions.project_high_method
      • ConservativeRecoveryOptions.project_low_method
      • ConservativeRecoveryOptions.rho_name
    • EmbeddedDGOptions
      • EmbeddedDGOptions.embedding_space
      • EmbeddedDGOptions.name
      • EmbeddedDGOptions.project_back_method
    • IntegrateByParts
      • IntegrateByParts.NEVER
      • IntegrateByParts.ONCE
      • IntegrateByParts.TWICE
    • MixedFSOptions
      • MixedFSOptions.name
      • MixedFSOptions.suboptions
    • OutputParameters
      • OutputParameters.checkpoint
      • OutputParameters.checkpoint_method
      • OutputParameters.checkpoint_pickup_filename
      • OutputParameters.chkptfreq
      • OutputParameters.diagfreq
      • OutputParameters.dirname
      • OutputParameters.dump_diagnostics
      • OutputParameters.dump_nc
      • OutputParameters.dump_vtus
      • OutputParameters.dumpfreq
      • OutputParameters.dumplist
      • OutputParameters.dumplist_latlon
      • OutputParameters.log_courant
      • OutputParameters.pddumpfreq
      • OutputParameters.point_data
      • OutputParameters.project_fields
      • OutputParameters.tolerance
    • RecoveryOptions
      • RecoveryOptions.boundary_method
      • RecoveryOptions.broken_method
      • RecoveryOptions.embedding_space
      • RecoveryOptions.injection_method
      • RecoveryOptions.name
      • RecoveryOptions.project_high_method
      • RecoveryOptions.project_low_method
      • RecoveryOptions.recovered_space
    • SUPGOptions
      • SUPGOptions.default
      • SUPGOptions.ibp
      • SUPGOptions.name
      • SUPGOptions.suboptions
      • SUPGOptions.tau
    • SubcyclingOptions
      • SubcyclingOptions.check_options()
      • SubcyclingOptions.fixed_subcycles
      • SubcyclingOptions.max_subcycles
      • SubcyclingOptions.subcycle_by_courant
    • TransportEquationType
      • TransportEquationType.advective
      • TransportEquationType.circulation
      • TransportEquationType.conservative
      • TransportEquationType.no_transport
      • TransportEquationType.tracer_conservative
      • TransportEquationType.vector_invariant
  • gusto.core.conservative_projection module
    • ConservativeProjector
      • ConservativeProjector.project()
  • gusto.core.coord_transforms module
    • great_arc_angle()
    • lonlatr_components_from_xyz()
    • lonlatr_from_xyz()
    • periodic_distance()
    • pole_rotation()
    • rodrigues_rotation()
    • rotated_lonlatr_coords()
    • rotated_lonlatr_vectors()
    • xyz_from_lonlatr()
    • xyz_vector_from_lonlatr()
  • gusto.core.coordinates module
    • Coordinates
      • Coordinates.get_column_data()
      • Coordinates.register_space()
      • Coordinates.set_field_from_column_data()
  • gusto.core.domain module
    • Domain
      • Domain.set_height_above_surface()
    • construct_domain_metadata()
  • gusto.core.equation_configuration module
    • BoundaryLayerParameters
      • BoundaryLayerParameters.coeff_drag_0
      • BoundaryLayerParameters.coeff_drag_1
      • BoundaryLayerParameters.coeff_drag_2
      • BoundaryLayerParameters.coeff_evap
      • BoundaryLayerParameters.coeff_heat
      • BoundaryLayerParameters.height_surface_layer
      • BoundaryLayerParameters.mu
    • BoussinesqParameters
      • BoussinesqParameters.N
      • BoussinesqParameters.Omega
      • BoussinesqParameters.cs
      • BoussinesqParameters.g
    • CompressibleParameters
      • CompressibleParameters.L_v0
      • CompressibleParameters.N
      • CompressibleParameters.Omega
      • CompressibleParameters.R_d
      • CompressibleParameters.R_v
      • CompressibleParameters.T_0
      • CompressibleParameters.c_pl
      • CompressibleParameters.c_pv
      • CompressibleParameters.c_vv
      • CompressibleParameters.cp
      • CompressibleParameters.cv
      • CompressibleParameters.g
      • CompressibleParameters.kappa
      • CompressibleParameters.p_0
      • CompressibleParameters.w_sat1
      • CompressibleParameters.w_sat2
      • CompressibleParameters.w_sat3
      • CompressibleParameters.w_sat4
    • DiffusionParameters
      • DiffusionParameters.kappa
      • DiffusionParameters.mu
    • ShallowWaterParameters
      • ShallowWaterParameters.H
      • ShallowWaterParameters.Omega
      • ShallowWaterParameters.beta2
      • ShallowWaterParameters.g
      • ShallowWaterParameters.nu
      • ShallowWaterParameters.q0
    • SpongeLayerParameters
      • SpongeLayerParameters.H
      • SpongeLayerParameters.mubar
      • SpongeLayerParameters.z_level
  • gusto.core.fields module
    • PrescribedFields
    • StateFields
      • StateFields.field_type()
    • TimeLevelFields
      • TimeLevelFields.add_fields()
      • TimeLevelFields.initialise()
      • TimeLevelFields.update()
  • gusto.core.function_spaces module
    • Spaces
      • Spaces.add_space()
      • Spaces.build_compatible_spaces()
      • Spaces.build_dg1_equispaced()
      • Spaces.create_space()
    • check_degree_args()
  • gusto.core.io module
    • IO
      • IO.create_nc_dump()
      • IO.dump()
      • IO.log_courant()
      • IO.log_parameters()
      • IO.pick_up_from_checkpoint()
      • IO.setup_diagnostics()
      • IO.setup_dump()
      • IO.setup_log_courant()
      • IO.write_nc_dump()
    • TimeData
      • TimeData.initial_steps
      • TimeData.last_ref_update_time
      • TimeData.step
      • TimeData.t
    • pick_up_mesh()
  • gusto.core.kernels module
    • ClipZero
      • ClipZero.apply()
    • LimitMidpoints
      • LimitMidpoints.apply()
    • MaxKernel
      • MaxKernel.apply()
    • MinKernel
      • MinKernel.apply()
  • gusto.core.labels module
    • DynamicsLabel
      • DynamicsLabel.default_value
      • DynamicsLabel.label
      • DynamicsLabel.validator
      • DynamicsLabel.value
    • PhysicsLabel
      • PhysicsLabel.default_value
      • PhysicsLabel.label
      • PhysicsLabel.validator
      • PhysicsLabel.value
  • gusto.core.logging module
    • LoggingError
    • set_log_handler()
  • gusto.core.meshes module
    • GeneralCubedSphereMesh()
    • GeneralIcosahedralSphereMesh()
    • get_flat_latlon_mesh()
  • Module contents
• gusto.diagnostics package
  • Submodules
  • gusto.diagnostics.compressible_euler_diagnostics module
    • BruntVaisalaFrequencySquared
      • BruntVaisalaFrequencySquared.name
      • BruntVaisalaFrequencySquared.setup()
    • CompressibleKineticEnergy
      • CompressibleKineticEnergy.name
      • CompressibleKineticEnergy.setup()
    • DewpointTemperature
      • DewpointTemperature.implicit_expr()
      • DewpointTemperature.name
      • DewpointTemperature.set_first_guess()
    • DynamicEntropy
      • DynamicEntropy.name
      • DynamicEntropy.setup()
    • Entropy
    • Exner
      • Exner.name
      • Exner.setup()
    • Exner_Vt
      • Exner_Vt.name
      • Exner_Vt.setup()
    • HydrostaticImbalance
      • HydrostaticImbalance.compute()
      • HydrostaticImbalance.name
      • HydrostaticImbalance.setup()
    • InternalEnergy
      • InternalEnergy.name
      • InternalEnergy.setup()
    • PhysicalEntropy
      • PhysicalEntropy.name
      • PhysicalEntropy.setup()
    • PotentialEnergy
      • PotentialEnergy.name
      • PotentialEnergy.setup()
    • Precipitation
      • Precipitation.compute()
      • Precipitation.name
      • Precipitation.setup()
    • Pressure
      • Pressure.name
      • Pressure.setup()
    • RelativeHumidity
      • RelativeHumidity.name
      • RelativeHumidity.setup()
    • RichardsonNumber
      • RichardsonNumber.name
      • RichardsonNumber.setup()
    • Temperature
      • Temperature.name
      • Temperature.setup()
    • ThermodynamicKineticEnergy
      • ThermodynamicKineticEnergy.name
      • ThermodynamicKineticEnergy.setup()
    • Theta_d
      • Theta_d.name
      • Theta_d.setup()
    • Theta_e
      • Theta_e.name
      • Theta_e.setup()
    • WetBulbTemperature
      • WetBulbTemperature.implicit_expr()
      • WetBulbTemperature.name
      • WetBulbTemperature.set_first_guess()
  • gusto.diagnostics.diagnostics module
    • CourantNumber
      • CourantNumber.compute()
      • CourantNumber.name
      • CourantNumber.setup()
    • CumulativeSum
      • CumulativeSum.compute()
      • CumulativeSum.name
      • CumulativeSum.setup()
    • DiagnosticField
      • DiagnosticField.compute()
      • DiagnosticField.name
      • DiagnosticField.setup()
    • Diagnostics
      • Diagnostics.available_diagnostics
      • Diagnostics.l2()
      • Diagnostics.max()
      • Diagnostics.min()
      • Diagnostics.register()
      • Diagnostics.rms()
      • Diagnostics.total()
    • Difference
      • Difference.name
      • Difference.setup()
    • Divergence
      • Divergence.name
      • Divergence.setup()
    • Energy
      • Energy.kinetic()
    • Gradient
      • Gradient.name
      • Gradient.setup()
    • IterativeDiagnosticField
      • IterativeDiagnosticField.compute()
      • IterativeDiagnosticField.implicit_expr
      • IterativeDiagnosticField.set_first_guess
      • IterativeDiagnosticField.setup()
    • KineticEnergy
      • KineticEnergy.name
      • KineticEnergy.setup()
    • MeridionalComponent
      • MeridionalComponent.name
      • MeridionalComponent.setup()
    • Perturbation
      • Perturbation.name
      • Perturbation.setup()
    • RadialComponent
      • RadialComponent.name
      • RadialComponent.setup()
    • SteadyStateError
      • SteadyStateError.compute()
      • SteadyStateError.name
      • SteadyStateError.setup()
    • Sum
      • Sum.name
      • Sum.setup()
    • TracerDensity
      • TracerDensity.name
      • TracerDensity.setup()
    • XComponent
      • XComponent.name
      • XComponent.setup()
    • YComponent
      • YComponent.name
      • YComponent.setup()
    • ZComponent
      • ZComponent.name
      • ZComponent.setup()
    • ZonalComponent
      • ZonalComponent.name
      • ZonalComponent.setup()
  • gusto.diagnostics.shallow_water_diagnostics module
    • AbsoluteVorticity
      • AbsoluteVorticity.name
      • AbsoluteVorticity.setup()
    • PartitionedCloud
      • PartitionedCloud.compute()
      • PartitionedCloud.name
      • PartitionedCloud.setup()
    • PartitionedVapour
      • PartitionedVapour.compute()
      • PartitionedVapour.name
      • PartitionedVapour.setup()
    • PotentialVorticity
      • PotentialVorticity.name
      • PotentialVorticity.setup()
    • RelativeVorticity
      • RelativeVorticity.name
      • RelativeVorticity.setup()
    • ShallowWaterKineticEnergy
      • ShallowWaterKineticEnergy.name
      • ShallowWaterKineticEnergy.setup()
    • ShallowWaterPotentialEnergy
      • ShallowWaterPotentialEnergy.name
      • ShallowWaterPotentialEnergy.setup()
    • ShallowWaterPotentialEnstrophy
      • ShallowWaterPotentialEnstrophy.name
      • ShallowWaterPotentialEnstrophy.setup()
  • Module contents
• gusto.equations package
  • Submodules
  • gusto.equations.active_tracers module
    • ActiveTracer
    • CloudWater
    • Phases
      • Phases.gas
      • Phases.liquid
      • Phases.plasma
      • Phases.solid
    • Rain
    • TracerVariableType
      • TracerVariableType.density
      • TracerVariableType.mixing_ratio
      • TracerVariableType.specific_humidity
    • WaterVapour
  • gusto.equations.advection_diffusion_equations module
    • AdvectionDiffusionEquation
  • gusto.equations.boussinesq_equations module
    • BoussinesqEquations
    • LinearBoussinesqEquations
  • gusto.equations.common_forms module
    • advection_equation_circulation_form()
    • advection_form()
    • advection_form_1d()
    • continuity_form()
    • continuity_form_1d()
    • diffusion_form()
    • diffusion_form_1d()
    • kinetic_energy_form()
    • linear_advection_form()
    • linear_continuity_form()
    • split_continuity_form()
    • tracer_conservative_form()
    • vector_invariant_form()
  • gusto.equations.compressible_euler_equations module
    • CompressibleEulerEquations
    • HydrostaticCompressibleEulerEquations
      • HydrostaticCompressibleEulerEquations.hydrostatic_projection()
  • gusto.equations.diffusion_equations module
    • DiffusionEquation
  • gusto.equations.prognostic_equations module
    • PrognosticEquation
      • PrognosticEquation.label_terms()
    • PrognosticEquationSet
      • PrognosticEquationSet.add_tracers_to_prognostics()
      • PrognosticEquationSet.generate_linear_terms()
      • PrognosticEquationSet.generate_mass_terms()
      • PrognosticEquationSet.generate_tracer_transport_terms()
      • PrognosticEquationSet.get_active_tracer()
      • PrognosticEquationSet.linearise_equation_set()
      • PrognosticEquationSet.set_no_normal_flow_bcs()
  • gusto.equations.shallow_water_equations module
    • LinearShallowWaterEquations
    • LinearShallowWaterEquations_1d
    • LinearThermalShallowWaterEquations
    • ShallowWaterEquations
    • ShallowWaterEquations_1d
    • ThermalShallowWaterEquations
      • ThermalShallowWaterEquations.compute_saturation()
  • gusto.equations.thermodynamics module
    • Lv()
    • RH()
    • T()
    • dexner_drho()
    • dexner_dtheta()
    • e_sat()
    • exner_pressure()
    • internal_energy()
    • p()
    • r_sat()
    • r_v()
    • rho()
    • theta()
    • theta_e()
  • gusto.equations.transport_equations module
    • AdvectionEquation
    • ContinuityEquation
    • CoupledTransportEquation
  • Module contents
• gusto.initialisation package
  • Submodules
  • gusto.initialisation.hydrostatic_initialisation module
    • boussinesq_hydrostatic_balance()
    • compressible_hydrostatic_balance()
    • saturated_hydrostatic_balance()
    • unsaturated_hydrostatic_balance()
  • gusto.initialisation.numerical_integrator module
    • NumericalIntegral
      • NumericalIntegral.evaluate_at()
      • NumericalIntegral.tabulate()
  • Module contents
• gusto.physics package
  • Submodules
  • gusto.physics.boundary_and_turbulence module
    • BoundaryLayerMixing
      • BoundaryLayerMixing.evaluate()
    • StaticAdjustment
      • StaticAdjustment.evaluate()
    • SuppressVerticalWind
      • SuppressVerticalWind.evaluate()
    • SurfaceFluxes
      • SurfaceFluxes.evaluate()
    • WindDrag
      • WindDrag.evaluate()
  • gusto.physics.chemistry module
    • TerminatorToy
      • TerminatorToy.evaluate()
  • gusto.physics.held_suarez_forcing module
    • RayleighFriction
      • RayleighFriction.evaluate()
    • Relaxation
      • Relaxation.evaluate()
  • gusto.physics.microphysics module
    • AdvectedMoments
      • AdvectedMoments.M0
      • AdvectedMoments.M3
    • Coalescence
      • Coalescence.evaluate()
    • EvaporationOfRain
      • EvaporationOfRain.evaluate()
    • Fallout
      • Fallout.evaluate()
    • SaturationAdjustment
      • SaturationAdjustment.evaluate()
  • gusto.physics.physics_parametrisation module
    • PhysicsParametrisation
      • PhysicsParametrisation.evaluate()
    • SourceSink
      • SourceSink.evaluate()
  • gusto.physics.shallow_water_microphysics module
    • InstantRain
      • InstantRain.evaluate()
    • SWSaturationAdjustment
      • SWSaturationAdjustment.evaluate()
  • Module contents
• gusto.recovery package
  • Submodules
  • gusto.recovery.averaging module
    • Averager
      • Averager.project()
  • gusto.recovery.recovery module
    • BoundaryMethod
      • BoundaryMethod.extruded
      • BoundaryMethod.hcurl
      • BoundaryMethod.taylor
    • BoundaryRecoverer
      • BoundaryRecoverer.apply()
    • Recoverer
      • Recoverer.project()
  • gusto.recovery.recovery_kernels module
    • AverageKernel
      • AverageKernel.apply()
    • AverageWeightings
      • AverageWeightings.apply()
    • BoundaryGaussianElimination
      • BoundaryGaussianElimination.apply()
    • BoundaryRecoveryExtruded
      • BoundaryRecoveryExtruded.apply()
    • BoundaryRecoveryHCurl
      • BoundaryRecoveryHCurl.apply()
  • gusto.recovery.recovery_options module
    • RecoverySpaces
  • gusto.recovery.reversible_recovery module
    • ConservativeRecoverer
      • ConservativeRecoverer.project()
    • ReversibleRecoverer
      • ReversibleRecoverer.project()
  • Module contents
• gusto.rexi package
  • Submodules
  • gusto.rexi.rexi module
    • Rexi
      • Rexi.solve()
  • gusto.rexi.rexi_coefficients module
    • RexiCoefficients()
    • RexiParameters
      • RexiParameters.L
      • RexiParameters.M
      • RexiParameters.a
      • RexiParameters.h
      • RexiParameters.mu
      • RexiParameters.reduce_to_half
    • b_coefficients()
  • Module contents
• gusto.solvers package
  • Submodules
  • gusto.solvers.linear_solvers module
    • BoussinesqSolver
      • BoussinesqSolver.solve()
      • BoussinesqSolver.solver_parameters
      • BoussinesqSolver.update_reference_profiles()
    • CompressibleSolver
      • CompressibleSolver.solve()
      • CompressibleSolver.solver_parameters
      • CompressibleSolver.update_reference_profiles()
    • LinearTimesteppingSolver
      • LinearTimesteppingSolver.solve()
      • LinearTimesteppingSolver.solver_parameters
      • LinearTimesteppingSolver.update_reference_profiles()
    • MoistConvectiveSWSolver
      • MoistConvectiveSWSolver.solve()
      • MoistConvectiveSWSolver.solver_parameters
      • MoistConvectiveSWSolver.update_reference_profiles()
    • ThermalSWSolver
      • ThermalSWSolver.solve()
      • ThermalSWSolver.solver_parameters
      • ThermalSWSolver.update_reference_profiles()
  • gusto.solvers.parameters module
    • mass_parameters()
  • gusto.solvers.preconditioners module
    • VerticalHybridizationPC
      • VerticalHybridizationPC.apply()
      • VerticalHybridizationPC.applyTranspose()
      • VerticalHybridizationPC.initialize()
      • VerticalHybridizationPC.update()
      • VerticalHybridizationPC.view()
  • Module contents
• gusto.spatial_methods package
  • Submodules
  • gusto.spatial_methods.augmentation module
    • Augmentation
      • Augmentation.post_apply()
      • Augmentation.pre_apply()
      • Augmentation.update()
    • VorticityTransport
      • VorticityTransport.post_apply()
      • VorticityTransport.pre_apply()
      • VorticityTransport.update()
  • gusto.spatial_methods.diffusion_methods module
    • CGDiffusion
    • InteriorPenaltyDiffusion
  • gusto.spatial_methods.limiters module
    • DG1Limiter
      • DG1Limiter.apply()
    • MixedFSLimiter
      • MixedFSLimiter.apply()
    • NoLimiter
      • NoLimiter.apply()
    • ThetaLimiter
      • ThetaLimiter.apply()
    • ZeroLimiter
      • ZeroLimiter.apply()
  • gusto.spatial_methods.spatial_methods module
    • SpatialMethod
      • SpatialMethod.replace_form()
  • gusto.spatial_methods.transport_methods module
    • DGUpwind
    • DefaultTransport
      • DefaultTransport.replace_form()
  • Module contents
• gusto.time_discretisation package
  • Submodules
  • gusto.time_discretisation.explicit_runge_kutta module
    • ExplicitRungeKutta
      • ExplicitRungeKutta.apply_cycle()
      • ExplicitRungeKutta.res
      • ExplicitRungeKutta.setup()
      • ExplicitRungeKutta.solve_stage()
      • ExplicitRungeKutta.solver
    • ForwardEuler
    • Heun()
    • RK4
    • RungeKuttaFormulation
      • RungeKuttaFormulation.increment
      • RungeKuttaFormulation.linear
      • RungeKuttaFormulation.predictor
    • SSPRK2
    • SSPRK3
    • SSPRK4
  • gusto.time_discretisation.imex_runge_kutta module
    • IMEXRungeKutta
      • IMEXRungeKutta.apply()
      • IMEXRungeKutta.final_res
      • IMEXRungeKutta.final_solver
      • IMEXRungeKutta.res()
      • IMEXRungeKutta.setup()
      • IMEXRungeKutta.solvers
    • IMEX_ARK2
    • IMEX_ARS3
    • IMEX_Euler
    • IMEX_SSP3
    • IMEX_Trap2
  • gusto.time_discretisation.implicit_runge_kutta module
    • ImplicitMidpoint
    • ImplicitRungeKutta
      • ImplicitRungeKutta.apply()
      • ImplicitRungeKutta.final_res
      • ImplicitRungeKutta.final_solver
      • ImplicitRungeKutta.res()
      • ImplicitRungeKutta.setup()
      • ImplicitRungeKutta.solve_stage()
      • ImplicitRungeKutta.solver()
      • ImplicitRungeKutta.solvers
    • QinZhang
  • gusto.time_discretisation.multi_level_schemes module
    • AdamsBashforth
      • AdamsBashforth.apply()
      • AdamsBashforth.nlevels
      • AdamsBashforth.res
      • AdamsBashforth.res0
      • AdamsBashforth.setup()
      • AdamsBashforth.solver
      • AdamsBashforth.solver0
    • AdamsMoulton
      • AdamsMoulton.apply()
      • AdamsMoulton.nlevels
      • AdamsMoulton.res
      • AdamsMoulton.res0
      • AdamsMoulton.setup()
      • AdamsMoulton.solver
      • AdamsMoulton.solver0
    • BDF2
      • BDF2.apply()
      • BDF2.nlevels
      • BDF2.res
      • BDF2.res0
      • BDF2.solver
      • BDF2.solver0
    • Leapfrog
      • Leapfrog.apply()
      • Leapfrog.nlevels
      • Leapfrog.res0
      • Leapfrog.rhs
      • Leapfrog.solver
      • Leapfrog.solver0
  • gusto.time_discretisation.sdc module
    • SDC
      • SDC.apply()
      • SDC.compute_quad()
      • SDC.compute_quad_final()
      • SDC.nlevels
      • SDC.res()
      • SDC.res_fin
      • SDC.res_rhs
      • SDC.setup()
      • SDC.solver_fin
      • SDC.solver_rhs
      • SDC.solvers
  • gusto.time_discretisation.time_discretisation module
    • BackwardEuler
      • BackwardEuler.apply()
      • BackwardEuler.apply_cycle()
      • BackwardEuler.res
      • BackwardEuler.setup()
    • ExplicitTimeDiscretisation
      • ExplicitTimeDiscretisation.apply()
      • ExplicitTimeDiscretisation.apply_cycle()
      • ExplicitTimeDiscretisation.res
      • ExplicitTimeDiscretisation.setup()
      • ExplicitTimeDiscretisation.solver
    • TR_BDF2
      • TR_BDF2.apply()
      • TR_BDF2.res
      • TR_BDF2.res_bdf2
      • TR_BDF2.setup()
      • TR_BDF2.solver_bdf2
      • TR_BDF2.solver_tr
    • ThetaMethod
      • ThetaMethod.apply()
      • ThetaMethod.apply_cycle()
      • ThetaMethod.res
      • ThetaMethod.setup()
    • TimeDiscretisation
      • TimeDiscretisation.apply()
      • TimeDiscretisation.nlevels
      • TimeDiscretisation.res
      • TimeDiscretisation.setup()
      • TimeDiscretisation.solver
      • TimeDiscretisation.update_subcycling()
    • TrapeziumRule
  • gusto.time_discretisation.wrappers module
    • EmbeddedDGWrapper
      • EmbeddedDGWrapper.post_apply()
      • EmbeddedDGWrapper.pre_apply()
      • EmbeddedDGWrapper.setup()
    • MixedFSWrapper
      • MixedFSWrapper.post_apply()
      • MixedFSWrapper.post_update_rho()
      • MixedFSWrapper.pre_apply()
      • MixedFSWrapper.pre_update_rho()
      • MixedFSWrapper.setup()
    • RecoveryWrapper
      • RecoveryWrapper.post_apply()
      • RecoveryWrapper.pre_apply()
      • RecoveryWrapper.setup()
    • SUPGWrapper
      • SUPGWrapper.label_terms()
      • SUPGWrapper.post_apply()
      • SUPGWrapper.pre_apply()
      • SUPGWrapper.setup()
  • Module contents
• gusto.timestepping package
  • Submodules
  • gusto.timestepping.semi_implicit_quasi_newton module
    • SemiImplicitQuasiNewton
      • SemiImplicitQuasiNewton.copy_active_tracers()
      • SemiImplicitQuasiNewton.finish_spinup()
      • SemiImplicitQuasiNewton.run()
      • SemiImplicitQuasiNewton.setup_fields()
      • SemiImplicitQuasiNewton.setup_scheme()
      • SemiImplicitQuasiNewton.start_spinup()
      • SemiImplicitQuasiNewton.timestep()
      • SemiImplicitQuasiNewton.transport_fields()
      • SemiImplicitQuasiNewton.transporting_velocity
      • SemiImplicitQuasiNewton.update_reference_profiles()
  • gusto.timestepping.split_timestepper module
    • SplitPhysicsTimestepper
      • SplitPhysicsTimestepper.setup_scheme()
      • SplitPhysicsTimestepper.timestep()
      • SplitPhysicsTimestepper.transporting_velocity
    • SplitPrescribedTransport
      • SplitPrescribedTransport.run()
      • SplitPrescribedTransport.setup_prescribed_apply()
      • SplitPrescribedTransport.setup_prescribed_expr()
      • SplitPrescribedTransport.setup_scheme()
      • SplitPrescribedTransport.timestep()
      • SplitPrescribedTransport.transporting_velocity
    • SplitTimestepper
      • SplitTimestepper.setup_fields()
      • SplitTimestepper.setup_scheme()
      • SplitTimestepper.timestep()
      • SplitTimestepper.transporting_velocity
  • gusto.timestepping.timestepper module
    • BaseTimestepper
      • BaseTimestepper.get_initial_timesteps()
      • BaseTimestepper.log_field_stats()
      • BaseTimestepper.log_timestep()
      • BaseTimestepper.run()
      • BaseTimestepper.set_initial_timesteps()
      • BaseTimestepper.set_reference_profiles()
      • BaseTimestepper.setup_equation()
      • BaseTimestepper.setup_fields()
      • BaseTimestepper.setup_scheme()
      • BaseTimestepper.setup_transporting_velocity()
      • BaseTimestepper.timestep()
      • BaseTimestepper.transporting_velocity
    • PrescribedTransport
      • PrescribedTransport.run()
      • PrescribedTransport.setup_fields()
      • PrescribedTransport.setup_prescribed_apply()
      • PrescribedTransport.setup_prescribed_expr()
      • PrescribedTransport.timestep()
      • PrescribedTransport.transporting_velocity
    • Timestepper
      • Timestepper.setup_fields()
      • Timestepper.setup_scheme()
      • Timestepper.timestep()
      • Timestepper.transporting_velocity
  • Module contents

Module contents