src.dycore.discretisation.time_update#

Functions

data_init(ud)

Helper function to initialise the elem and node grids, corresponding to the cell and node grids, from a given user iniital data file.

do(Sol, flux, mpv, t, tout, ud, elem, node, ...)

For more details, refer to the write-up Time-stepping.

src.dycore.discretisation.time_update.data_init(ud)#

Helper function to initialise the elem and node grids, corresponding to the cell and node grids, from a given user iniital data file.

Parameters#

udinputs.user_data.UserDataInit

Data container for the initial conditions.

Returns#

elemdiscretization.kgrid.ElemSpaceDiscr

Cells grid.

nodediscretization.kgrid.NodeSpaceDiscr

Nodes grid.

src.dycore.discretisation.time_update.do(Sol, flux, mpv, t, tout, ud, elem, node, steps, th, bld=None, writer=None, debug=False)#

For more details, refer to the write-up Time-stepping.

Does a time-step for the atmospheric solver.

Parameters#

Solmanagement.variable.Vars

Solution data container.

fluxmanagement.variable.States

Data container for the fluxes.

mpvphysics.low_mach.mpv.MPV

Variables relating to the elliptic solver.

tfloat

Current time

toutfloat

Next output time

udinputs.user_data.UserDataInit

Data container for the initial conditions

elemdiscretization.kgrid.ElemSpaceDiscr

Cells grid.

nodediscretization.kgrid.NodeSpaceDiscr

Nodes grid.

stepint

Current step.

thphysics.gas_dynamics.thermodynamic.init

Thermodynamic variables of the system

blddata_assimilation.blending.Blend()

Blending class used to initalise interface blending methods.

writermanagement.io.io, optional

default == None. If given, output after each time-step will be written in the hdf5 format.

debugboolean, optional
default == False. If True, then writer will output Sol:
  1. before flux calculation

  2. before advection routine

  3. after advection routine

  4. after explicit solver

  5. after implicit solver

during both the half-step for the prediction of advective flux and the full-step.

Returns#

list

A list of [Sol,flux,mpv,[window_step,step]] data containers at time tout.