The `.ini` file

.. toctree::
   :maxdepth: 2
   :caption: Contents:

File structure

The .ini is consists of blocks like

 [master]
 npx=2
 npy=4

 [advec]
 swadvec=2
 cflmax=1.0

The name [advec] refers for instance to the Advec class that uses the settings. This class is found in the source file with the corresponding name (advec.cxx). Below the block name are the options consisting of names and values separated by =.

Advection `[advec]`

The Advec class computes the advection tendencies using the chosen scheme. Note that the odd ordered schemes (e.g. 2i5) have hyperdiffusion included that results in a smooth solution. For `2i62, the interpolations are 6th order accurate in the horizontal, and 2nd order in the vertical.

Variables on the fluxlimit_list are guaranteed to be monotonically advected.

The order of the advection scheme has to match the order of the spatial discretization, as set by [grid] swspatialorder.

For more details about the 2nd order accurate schemes, see: dx.doi.org/10.1175/1520-0493(2002)130%3C2088:TSMFEM%3E2.0.CO;2.

Name	Default	Description and options
`swadvec`	`swspatialorder`	Advection scheme `0`: Disabled `2`: 2nd-order `2i4`: 2nd-order with 4th-order interpolations `2i5`: 2nd-order with 5th-order interpolations `2i62`: 2nd-order with 6th/2nd-order interpolation `4`: 4th-order (DNS, high accuracy) `4m`: 2nd-order (DNS, energy conserving)
`cflmax`	`1.0`	Max. CFL for adaptive time stepping
`fluxlimit_list`	`Empty list`	Use flux limiter for scalars (2i5 and 2i62 only)

Aerosol `[aerosol]`

Description: TO-DO Mirjam.

Name	Default	Description and options
`swaerosol`	`false`	Switch for aerosols in radiation
`swtimedep`	`false`	Switch for time dependent aerosols

Boundary conditions `[boundary]`

The Boundary class computes the boundary conditions. It has a derived class Boundary_surface that extends the base class in case the surface model is enabled, and Boundary_surface_lsm which further extends Boundary_surface with an interactive land surface scheme (HTESSEL based).

Name	Default	Description and options
`swboundary`	`None`	Boundary discretization `default`: Resolved boundaries `surface`: MOST-based surface model `surface_lsm`: MOST-based surface model with HTESSEL LSM `surface_bulk`: Surface model with prescribed drag coefficients
`mbcbot`	`None`	Bottom boundary type for momentum variables `no-slip`: Dirichlet BC with `u = v = 0` `free-slip`: Neumann BC with `dudz = dvdz = 0` `ustar`: Fixed ustar at bottom
`mbctop`	`None`	Top boundary type for momentum variables `no-slip`: Dirichlet BC with `u = v = 0` `free-slip`: Neumann BC with `dudz = dvdz = 0`
`sbcbot`	`None`	Bottom boundary type for scalar variables. Types can be specified per scalar (`sbot[thl]=flux`) `dirichlet`: Dirichlet BC `neumann`: Neumann BC `flux`: Flux BC
`sbctop`	`None`	Top boundary type for scalar variables. Types can be specified per scalar (`stop[qt]=neumann`) `dirichlet`: Dirichlet BC `neumann`: Neumann BC `flux`: Flux BC
`ubot`	`0`	Bottom boundary value for east-west velocity (m s-1)
`utop`	`0`	Top boundary value for east-west velocity (m s-1)
`vbot`	`0`	Bottom boundary value for north-south velocity (m s-1)
`vtop`	`0`	Top boundary value for north-south velocity (m s-1)
`sbot`	`None`	Bottom boundary value for scalar variables Values can be specified per scalar: `sbot[thl]=0.1`.
`stop`	`None`	Top boundary value for scalar variables Values can be specified per scalar: `stop[qt]=0`.
`sbot_2d_list`	`Empty list`	Comma-separate list of scalars that provide a binary file (`sbot_thl_in.0000000`) with 2D slice
`z0m`	`None`	Roughness length of momentum (m)
`z0h`	`None`	Roughness length of heat (m)
`swconstantz0`	`true`	Switch for spatially homogeneous z0m/z0h `true`: Homogeneous z0m/z0h, from `.ini` file `false`: Heterogeneous z0m/z0h from `z0m.0000000`/`z0h.0000000`
`swcharnock`	`false`	Switch for Charnock parameterization (`boundary_surface` only)
`alpha_m`	`None`	Parameter Charnock parameterization
`alpha_ch`	`None`	Parameter Charnock parameterization
`alpha_h`	`None`	Parameter Charnock parameterization
`ustar`	`None`	Value of the fixed friction velocity (m s-1)
`bulk_cm`	`None`	Drag coefficient for momentum (-)
`bulk_cs`	`None`	Drag coefficient for scalar (-)
`swtimedep`	`false`	Switch for time varying surface BCs
`timedeplist`	`Empty list`	List of scalars with time varying BCs
`swtimedep_sbot_2d`	`false`	Switch for time varying 2D surface BCs
`sbot_2d_loadtime`	`None`	Frequency of 2D surface BC input
`scalar_outflow`	`Empty list`	List of scalars with non-periodic lateral BCs
`flow_direction`	`None`	Flow direction used for `scalar_outflow` at each lateral edge `inflow`: Inflow (Dirichlet BC) `outflow`: Outflow (Neumann BC)
`swtimedep_outflow`	`false`	Switch for time varying scalar outflow

For swboundary=surface_lsm, the [land_surface] group contains some additional settings:

Name	Default	Description and options
`swhomogeneous`	`true`	Use spatially homogeneous land-surface properties
`swfreedrainage`	`true`	Free drainage BC at bottom of soil column
`swwater`	`false`	Switch for allowing open water
`swtilestats`	`false`	Output individual tile statistics
`swtilestats_column`	`false`	Output individual tile column statistics
`emis_sfc`	`None`	Surface emissivity
`ktot`	`None`	Number of vertical soil grid points

For swhomogeneous=true, the following surface and vegetation properties need to be specified in the [land_surface] group:

Name	Default	Description and options
`gD`	`None`	gD coefficient in VDP reduction canopy resistance (?)
`c_veg`	`None`	Sub-grid vegetation fraction (0-1)
`lai`	`None`	Leaf area index (m2 m-2)
`rs_veg_min`	`None`	Minium canopy resistance (s m-1)
`rs_soil_min`	`None`	Minium soil resistance (s m-1)
`lambda_stable`	`None`	Skin conductivity stable conditions (W m-2 K-1)
`lambda_unstable`	`None`	Skin conductivity unstable conditions (W m-2 K-1)
`cs_veg`	`None`	Heat capacity skin layer (J K-1)

Budget statistics `[budget]`

The Budget class contains the computation of the statistics of the budgets of the second order moments. It contains the entire Reynolds-stress tensor, the variances of the buoyancy variable, and the budget of the buoyancy flux. The switch swbudget can only be set to 4 if [grid] has swspatialorder=4.

Name	Default	Description and options
`swbudget`	`0`	Switch for the budget statistics `2`: Budget statistics with second-order accuracy `4`: Budget statistics with fourth-order accuracy

Buffer layer `[buffer]`

The Buffer class contains the implementation of the buffer layer in the top of the domain that prevents the reflection of gravity waves back into the domain. The strength of the buffering is defined per layer as \sigma ( (z - z_\textrm{start}) / ( z_\textrm{size} - z_\textrm{start}) )^\beta. A logical choice for sigma is (2 \pi) / N, where N is the Brunt-Vaisala frequency in the sponge layer.

Name	Default	Description and options
`swbuffer`	`false`	Switch for the buffer layer
`swupdate`	`false`	Switch whether to update the buffer with actual mean profiles
`zstart`	`None`	Height in domain at which the buffer layer starts (m)
`sigma`	`None`	Damping frequency of buffer layer (rad s-1)
`beta`	`2`	Exponent of strength reduction function (-)

Column `[column]`

The Column class contains the settings for single column output. Columns are only created for each specific (x,y) pair. So specifying coordinates[x]=100,200, coordinates[y]=300,400 will create columns for x,y=(100,300) and x,y=(200,400), but not the cross-combinations like e.g. x,y=(100,400).

Name	Default	Description and options
`swcolumn`	`false`	Switch for column statistics
`sampletime`	`None`	Time between consecutive samples (s)
`coordinates[x]`	`Empty list`	List with x-coordinates column (m)
`coordinates[y]`	`Empty list`	List with y-coordinates column (m)

Cross sections `[cross]`

The Cross class contains the settings for the cross sections.

Name	Default	Description and options
`swcross`	`0.`	Switch for cross sections
`sampletime`	None	Time between consecutive samples (s)
`crosslist`	None	List of cross sections to be made
`xy`	None	List of z-levels for xy-cross sections
`xz`	None	List of y-levels for xz-cross sections
`yz`	None	List of x-levels for yz-cross sections

The table below shows an overview of potential cross sections and the class that provides them. If a wildcard * is used, variables can be filled in according to the description.

Always available:

Name	Description and options
`*_path`	Density-weighted vertical integral of any prognostic or diagnostic variable
`*_bot`	Bottom boundary value of any prognostic variable
`*_top`	Top boundary value of any prognostic variable
`*_fluxbot`	Bottom boundary flux of any prognostic variable
`*_fluxtop`	Top boundary flux of any prognostic variable
`*_lngrad`	Logarithm of the length of the gradient vector for any prognostic variable

Available if swboundary != default:

Name	Description and options
`ustar`	Friction velocity (m s-1)
`obuk`	Obukhov length (m)

Availabe if [ib] has swib=1:

Name	Description and options
`*_fluxbot_ib`	Bottom boundary flux of any prognostic variable at DEM surface

Availabe if swmicro in (nsw6, 2mom_warm):

Name	Description and options
`rr_bot`	Surface rain rate (kg s-1)

Availabe if swmicro==nsw6:

Name	Description and options
`rg_bot`	Surface graupel rate (kg s-1)
`rs_bot`	Surface snow rate (kg s-1)

Availabe if swradiation in (rrtmgp, rrtmgp_rt):

Name	Description and options
`sw_flux_dn`	Downwelling shortwave radiation flux (W m-2)
`sw_flux_up`	Upwelling shortwave radiation flux (W m-2)
`sw_flux_dn_dir`	Downwelling direct shortwave radiation flux (W m-2)
`lw_flux_dn`	Downwelling longwave radiation flux (W m-2)
`lw_flux_up`	Upwelling longwave radiation flux (W m-2)

Available if swradiation == rrtmgp_rt:

Name	Description and options
`sw_flux_sfc_dir_rt`	Surface downwellling direct shortwave radiation flux (W m-2)
`sw_flux_sfc_dif_rt`	Surface downwellling diffuse shortwave radiation flux (W m-2)
`sw_flux_sfc_up_rt`	Surface upwelling shortwave radiation flux (W m-2)
`sw_flux_tod_dn_rt`	Top of domain downwellling shortwave radiation flux (W m-2)
`sw_flux_tod_up_rt`	Top of domain upwelling shortwave radiation flux (W m-2)

Available if swradiation in (rrtmgp, rrtmgp_rt) and swclearskystats=true:

Name	Description and options
`sw_flux_dn_clear`	Clear-sky downwelling shortwave radiation flux (W m-2)
`sw_flux_up_clear`	Clear-sky upwelling shortwave radiation flux (W m-2)
`sw_flux_dn_dir_clear`	Clear-sky downwelling direct shortwave radiation flux (W m-2)
`lw_flux_dn_clear`	Clear-sky downwelling longwave radiation flux (W m-2)
`lw_flux_up_clear`	Clear-sky upwelling longwave radiation flux (W m-2)

Availabe if swthermo == thermo_moist:

Name	Description and options
`ql`	Cloud liquid water (kg kg-1)
`qi`	Cloud ice (kg kg-1)
`qlqi`	Cloud liquid water + ice (kg kg-1)
`ql_base`	Cloud base height (m)
`ql_top`	Cloud top height (m)
`ql_path`	Density-weighted vertical integral of cloud liquid water (kg m-2)
`qi_path`	Density-weighted vertical integral of cloud ice (kg m-2)
`qlqi_base`	Cloud (water+ice) base height (m)
`qlqi_top`	Cloud (water+ice) top height (m)
`qlqi_path`	Density-weighted vertical integral of cloud water+ice (kg m-2)
`qsat_path`	Density-weighted vertical integral of saturated specific humidity (kg m-2)
`w500hpa`	Vertical velocity at the 500 hPa level (m s-1)

Decay `[decay]`

Imposes an expontial decay on prognostic variables of choice. It also defines a statistical mask for areas where a decaying field is a certain number of standard deviations above the mean.

Name	Default	Description and options
`swdecay`	`0`	Decay type: `0`: No decay `exponential`: Exponential decay Set per scalar, e.g. `decay[s1]=0`, `decay[s2]=exponential`
`timescale`	`None`	Exponential decay rate (s)
`nstd_couvreux`	`1`	Number of standard deviations above the horizontal mean for conditional sampling

Diffusion `[diff]`

The Diff class computes the tendencies related to molecular, and in case of LES, of eddy diffusion. The order of the diffusion scheme has to match the order of the spatial discretization, as set by [grid] swspatialorder.

Name	Default	Description and options
`swdiff`	`0`	Switch for diffusion type `0`: Disabled `2`: 2nd-order DNS `4`: 4th-order DNS `smag2`: 2nd-order Smagorinsky for LES `tke2`: 2nd-order Deardorff TKE scheme for LES
`dnmax`	`0.4`	Max. diffusion number for adaptive time stepping

For swdiff=smag2, the following settings are available:

Name	Default	Description and options
`cs`	`0.23`	Smagorinsky constant
`tPr`	`1/3`	Turbulent Prandtl number
`swmason`	`true`	Switch for Mason wall damping

For swdiff=tke2, the following settings are available:

Name	Default	Description and options
`ap`	`0.4`	Contant TKE scheme (TO-DO)
`cf`	`2.5`	Contant TKE scheme (TO-DO)
`ce1`	`0.19`	Contant TKE scheme (TO-DO)
`ce2`	`0.51`	Contant TKE scheme (TO-DO)
`cm`	`0.12`	Contant TKE scheme (TO-DO)
`ch1`	`1`	Contant TKE scheme (TO-DO)
`ch2`	`2`	Contant TKE scheme (TO-DO)
`cn`	`0.76`	Contant TKE scheme (TO-DO)
`swmason`	`true`	Switch for Mason wall damping

Dump of 3D fields `[dump]`

The Dump class contains the settings for 3D field dumps.

Name	Default	Description and options
`swdump`	`false`	Switch for 3D field dumps
`swdoubledump`	`false`	Switch for dump at two consecutive model iterations
`sampletime`	`None`	Time between consecutive samples (s)
`dumplist`	`Empty list`	List of 3D dumps to be made

dumplist can contain any prognostic or diagnostic field. In addition, swthermo=thermo_moist can provide:

Name	Description and options
`ql`	Cloud liquid water (kg kg-1)
`qi`	Cloud ice (kg kg-1)
`T`	Absolute temperature (K)

Fields `[fields]`

The Fields class initializes and contains the 3D fields that are passed around in the model. This class generates passive scalars, which are prognostic variables that are not initialized by other classes. It is also responsible for the generation of the random perturbation in the init.

Name	Default	Description and options
`slist`	`Empty list`	List of passive scalars to be initialized
`visc`	`None`	Kinematic viscosity (m2 s-1)
`svisc`	`None`	Diffusivity of scalars (m2 s-1)
`rndseed`	`0`	Seed of random number generator (-)
`rndamp`	`0`	Amplitude of perturbations. Value can be specified per prognostic variable, for instance `rndamp[s] = 0.1`
`rndz`	`0`	Height until which perturbations applied (m)
`rndexp`	`0`	Decay of perturbation amplitude with height
`vortexnpair`	`0`	Number of pairs of counter rotating vortices (-)
`vortexamp`	`0`	Maximum vortex velocity (m s-1)
`vortexaxis`	`y`	Orientation of axis vortices `x`: Rotation of vortices in xz-plane `y`: Rotation of vortices in yz-plane

Large-scale forcings `[force]`

The Force class calculates the tendencies for all forms of large-scale forcings.

Name	Default	Description and options
`swlspres`	`0`	Switch for large-scale pressure force `geo`: Fixed pressure gradient in x-direction `dpdx`: Rotation of vortices in yz-plane `uflux`: ixed volume flux through domain
`fc`	`None`	Coriolis parameter (s-1) (if `swlspres=geo`)
`dpdx`	`None`	Fixed pressure gradient in x (Pa m-1) (if `swlspres=dpdx`)
`uflux`	`None`	Fixed volume-mean velocity (m s-1) (if `swlspres=uflux`)
`swtimedep_geo`	`false`	Switch for time dependent geostrophic wind
`swls`	`false`	Switch for large-scale advective tendencies
`lslist`	`Empty list`	List of variables for which advective tendencies are given
`swtimedep_ls`	`false`	Switch for time-dependent advective tendencies
`timedeplist_ls`	`Empty list`	List of scalars with time-dependent advective tendencies
`swwls`	`0`	Switch for large-scale subsidence (scalars) `local`: Advect local field `mean`: Advect horizontally mean field
`swwls_mom`	`false`	Switch for large-scale subsidence (momentum)
`swtimedep_wls`	`false`	Switch for time dependent subsidence
`swnudge`	`false`	Switch for nudging
`nudgelist`	`Empty list`	List of variables to which nudging is applied
`scalednudgelist`	`Empty list`	List of variables to which a nudging scale is applied
`swtimedep_nudge`	`false`	Switch for time-dependent nudging
`timedeplist_nudge`	`Empty list`	List of variables with time-dependent nudging

Grid `[grid]`

The Grid class contains the grid configuration.

Name	Default	Description and options
`itot`	`None`	Numbers of grid points in x (-)
`jtot`	`None`	Numbers of grid points in y (-)
`ktot`	`None`	Numbers of grid points in z (-)
`xsize`	`None`	Size of the domain in x (m)
`ysize`	`None`	Size of the domain in y (m)
`zsize`	`None`	Size of the domain in z (m)
`swspatialorder`	`None`	Spatial order of the finite differences (-) `2`: Second-order grid `4`: Fourth-order grid
`lat`	`0`	Latitude of the domain center (degrees)
`lon`	`0`	Longitude of the domain center (degrees)
`utrans`	`0`	Galilean translation velocity in x (m s-1)
`vtrans`	`0`	Galilean translation velocity in y (m s-1)
`swtimedep`	`0`	Switch for time dependent lat/lon

Immersed boundary `[IB]`

Name	Default	Description and options
`sw_immersed_boundary`	`false`	Switch for immersed boundaries
`n_idw_points`	`None`	Number of IDW interpolation points
`sbot`	`None`	Bottom boundary value for scalar variables Values can be specified per scalar: `sbot[thl]=0.1`.
`sbcbot`	`None`	Bottom boundary type for scalar variables. Types can be specified per scalar (`sbot[thl]=flux`) `dirichlet`: Dirichlet BC `neumann`: Neumann BC `flux`: Flux BC
`sbot_spatial`	`Empty list`	List of scalars with a spatially varying bottom boundary conditions

Limiter `[limiter]`

The limiter enforces a lower value of 0.0 for the prognostic fields listed in limitlist.

Name	Default	Description and options
`limitlist`	`Empty list`	List of scalars for which a lower value of 0.0 is enforced

Master `[master]`

The master class contains the configuration settings for parallel runs.

Name	Default	Description and options
`npx`	`1`	Numbers of processes in x (-)
`npy`	`1`	Numbers of processes in y (-)
`wallclocklimit`	`1e8`	Maximum run duration in wall clock time (h)

Microphysics `[micro]`

Name	Default	Description and options
`swmicro`	`0`	Microphysics scheme `0`: Disabled `2mom_warm`: Double moment warm (Seifert & Beheng) `nsw6`: Single moment ice (Tomita)
`Nc0`	`None`	The cloud water droplet number concentration (m-3)
`Ni0`	`None`	The cloud ice number concentration (m-3)
`cflmax`	`1.2`	The CFL criterion limiter for sedimentation
`swmicrobudget`	`false`	Output microphysics tendencies in statistics (2mom_warm only)

Pressure `[pres]`

Name	Default	Description and options
`swpres`	`swspatialorder`	Pressure solver `2`: 2nd order accurate `4`: rth order accurate
`sw_fft_per_slice`	`false`	Force GPU solver to use XY slices

Radiation `[radiation]`

Name	Default	Description and options
`swradiation`	`0`	Radiative transfer scheme `0`: Disabled `rrtmgp`: RTE-RRTMGP `rrtmgp_rt`: RTE-RRTMGP with shortwave ray tracer (GPU only) `gcss`: GCSS parameterized radiation `prescribed`: Prescribed surface radiation

For rrtmgp and rrtmgp_rt, the following settings are available:

Name	Default	Description and options
`dt_rad`	`None`	Time interval at which radiation is solved
`swshortwave`	`true`	Switch to solve shortwave radiation
`swlongwave`	`true`	Switch to solve longwave radiation
`sfc_alb_dir`	`None`	Surface albedo direct radiation
`sfc_alb_dif`	`None`	Surface albedo diffuse radiation
`swdeltacloud`	`false`	Use delta scaling for clouds
`swdeltaaer`	`false`	Use delta scaling for aerosols
`swfixedsza`	`true`	Switch to use a fixed solar zenith angle
`sza`	`None`	Solar zenith angle (if `swfixedsza=true`)
`tsi_scaling`	`-999?`	Scaling factor TOD incoming shortwave radiation
`emis_sfc`	`None`	Surface emissivity
`t_sfc`	`None`	Surface temperature (IS THIS STILL USED?)
`swfilterdiffuse`	`false`	3D parameterization Tijhuis et al (2023, ..)
`sigma_filter`	`None`	Standard deviation of filter width (for `swfilterdiffuse=true`)
`swupdatecolumn`	`false`	Switch to update the background column
`timedeplist_gas`	`Empty list`	List of gas profiles which vary in time
`swclearskystats`	`false`	Output clear sky statistics
`swhomogenizesfc_sw`	`false`	Horizontally homogenize the surface shortwave radiation
`swhomogenizesfc_lw`	`false`	Horizontally homogenize the surface longwave radiation
`swhomogenizehr_sw`	`false`	Horizontally homogenize the shortwave heating rates
`swhomogenizehr_lw`	`false`	Horizontally homogenize the longwave heating rates

rrtmgp_rt has the following additional settings:

Name	Default	Description and options
`swalwaysrt`	`true`	`true`: Always use ray tracer `false`: Use 2 stream solver in absence of clouds
`kngrid_i`	`None`	Null-collision grid size in x-direction
`kngrid_j`	`None`	Null-collision grid size in y-direction
`kngrid_k`	`None`	Null-collision grid size in z-direction
`rays_per_pixel`	`None`	Samples per pixel per spectral quadrature point

For gcss the following settings are available:

Name	Default	Description and options
`xka`	`None`	TO-DO
`fr0`	`None`	TO-DO
`fr1`	`None`	TO-DO
`div`	`None`	TO-DO

Finally, prescribed offers the posibility to prescribe the surface radiative fluxes:

Name	Default	Description and options
`swtimedep_prescribed`	`false`	Switch for time dependent prescribed radiative fluxes
`sw_flux_dn`	`None`	Prescribed surface downwelling shortwave radiation (W m-2)
`sw_flux_up`	`None`	Prescribed surface upwelling shortwave radiation (W m-2)
`lw_flux_dn`	`None`	Prescribed surface downwelling longwave radiation (W m-2)
`lw_flux_up`	`None`	Prescribed surface upwelling longwave radiation (W m-2)

Source `[source]`

The source module can introduce point source emissions in the LES/DNS domain. Optionally, the locations and/or strenght can vary in time.

Name	Default	Description and options
`swsource`	`false`	Switch for emission from point sources
`sourcelist`	`Empty list`	List of scalars with point source emission
`source_x0`	`Empty list`	List if x-coordinates point sources (m)
`source_y0`	`Empty list`	List if y-coordinates point sources (m)
`source_z0`	`Empty list`	List if z-coordinates point sources (m)
`sigma_x`	`Empty list`	Stddev. of Gaussian release blob in x (m)
`sigma_y`	`Empty list`	Stddev. of Gaussian release blob in y (m)
`sigma_z`	`Empty list`	Stddev. of Gaussian release blob in z (m)
`line_x`	`Empty list`	TO-DO
`line_y`	`Empty list`	TO-DO
`line_z`	`Empty list`	TO-DO
`strength`	`Empty list`	Source release strength
`swvmr`	`Empty list`	`true`: `strength` is in `kmol s-1` (vmr) `false`: strenght is in ``kg kg s-1 (mmr)
`swtimedep_location`	`false`	Switch for time varying source locations
`swtimedep_strength`	`false`	Switch for time varying source strength
`sw_profile`	`false`	Switch for prescribing vertical emission profile
`profile_index`	`Empty list`	Profile index for each source location

Statistics `[stats]`

The statistics class contains the settings for the statistics output, in particular the time series and the profiles. All statistics can be masked, meaning that only grid points that satisfy a certain condition are included in the statistics. The statistics over the entire domain are written out in a file named <casename>.default.<restarttime>.nc. Conditional statistics are written out in files named <casename>.<maskname>.<restarttime>.nc.

Name	Default	Description and options
`swstats`	`false`	Switch for statistics
`sampletime`	`None`	Time between statistics sampling
`swtendency`	`false`	Enable/Disable budget terms of all prognostic variables
`blacklist`	`Empty list`	List of variables that should not be included in the statistics Can be a regular expression
`whitelist`	`Empty list`	List of variables that should be included in the statistics Can be a regular expression
`masklist`	`Empty list`	List of masks that should be applied over the statistics `ql`: Where `ql > 0` `bplus`: Where buoyancy `b > 0` `bmin`: Where buoyancy``b < 0`` `qlcore`: Where `ql>0` and `b > 0` `qr` : Where `qr > 1e-6` (`2mom_warm`) `wplus`: Where `w > 0` `wmin`: Where `w < 0` `couvreux`: Where the couvreux scalar is `nstd` standard deviations above the horizontal mean `ib`: Where the atmosphere is above the IB
`xymasklist`	`Empty list`	List with xy masks from binary input file

Thermodynamics `[thermo]`

Name	Default	Description and options
`swthermo`	`0`	Thermodynamics switch `0`: Disable thermodynamics `buoy`: Use buoyancy as prognostic variable `dry`: Dry thermodynamics (prognostic th) `moist`: Moist thermodynamics (prognostic thl+qt, diagnostic ql+qi+...

Options for dry and moist:

Name	Default	Description and options
`swbasestate`	`None`	Switch for background base state: `boussinesq`: Boussinesq approximation with rho=1 `anelastic`: Anelastic approximation with varying rho
`pbot`	`None`	Surface pressure
`swtimedep_pbot`	`false`	Switch to enable time varying surface pressure

Options for dry:

Name	Default	Description and options
`thref0`	`None`	Reference potential temperature

Additional options for baroclinic instability in dry:

Name	Default	Description and options
`swbaroclinic`	`false`	Switch for baroclinic instability
`dthetady_ls`	`None`	Large-scale temperature gradient in y-direction (K m-1)

Options for moist:

Name	Default	Description and options
`thvref0`	`None`	Reference virtual potential temperature
`swupdatebasestate`	`true`	Update base state during simulation

Options for buoy:

Name	Default	Description and options
`alpha`	`0`	TO-DO
`N2`	`0`	TO-DO
`swbaroclinic`	`false`	Switch for baroclinic instability
`dbdy_ls`	`None`	Large-scale buoyancy gradient in y-direction

Timeloop `[time]`

Name	Default	Description and options
`starttime`	`None`	Start time of simulation (s)
`endtime`	`None`	End time of simulation (s)
`savetime`	`None`	Interval at which a restart file will be saved (s)
`adaptivestep`	`true`	Adaptive time stepping, based on CFL, Diffusion Number, and other limitations
`dtmax`	`\infty`	Maximum time step (s)
`dt`	`dtmax`	Initial time step (s)
`rkorder`	`3`	Order of the Runge-Kutta scheme `3`: Third order accurate `4`: Fourth order accurate
`outputiter`	`20`	Number of iterations between diagnostic output is written to `<casename>.out`
`iotimeprec`	`0`	Precision of the file timestamp, in `10**iotimeprec` s
`datetime_utc`	`0`	Calendar start time of the simulation. Must be of the format YY-MM-DD HH:MM::SS
`postproctime`	`0`	Time step to use in postprocessing mode

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

the_ini_file.rst

the_ini_file.rst

The `.ini` file

File structure

Advection `[advec]`

Aerosol `[aerosol]`

Boundary conditions `[boundary]`

Budget statistics `[budget]`

Buffer layer `[buffer]`

Column `[column]`

Cross sections `[cross]`

Decay `[decay]`

Diffusion `[diff]`

Dump of 3D fields `[dump]`

Fields `[fields]`

Large-scale forcings `[force]`

Grid `[grid]`

Immersed boundary `[IB]`

Limiter `[limiter]`

Master `[master]`

Microphysics `[micro]`

Pressure `[pres]`

Radiation `[radiation]`

Source `[source]`

Statistics `[stats]`

Thermodynamics `[thermo]`

Timeloop `[time]`

Files

the_ini_file.rst

Latest commit

History

the_ini_file.rst

File metadata and controls

The .ini file

File structure

Advection [advec]

Aerosol [aerosol]

Boundary conditions [boundary]

Budget statistics [budget]

Buffer layer [buffer]

Column [column]

Cross sections [cross]

Decay [decay]

Diffusion [diff]

Dump of 3D fields [dump]

Fields [fields]

Large-scale forcings [force]

Grid [grid]

Immersed boundary [IB]

Limiter [limiter]

Master [master]

Microphysics [micro]

Pressure [pres]

Radiation [radiation]

Source [source]

Statistics [stats]

Thermodynamics [thermo]

Timeloop [time]

The `.ini` file

Advection `[advec]`

Aerosol `[aerosol]`

Boundary conditions `[boundary]`

Budget statistics `[budget]`

Buffer layer `[buffer]`

Column `[column]`

Cross sections `[cross]`

Decay `[decay]`

Diffusion `[diff]`

Dump of 3D fields `[dump]`

Fields `[fields]`

Large-scale forcings `[force]`

Grid `[grid]`

Immersed boundary `[IB]`

Limiter `[limiter]`

Master `[master]`

Microphysics `[micro]`

Pressure `[pres]`

Radiation `[radiation]`

Source `[source]`

Statistics `[stats]`

Thermodynamics `[thermo]`

Timeloop `[time]`