Configuration

TIE-GCM settings are controlled by a namelist file. The path to this file is the first argument to the executable. When using TIE-GCM PDAF, the executable takes a second argument: the path to another namelist file that controls the assimilation setup. The namelist parameters are explained in the following:

Table of contents

Output
calibration
constraints
1. CONSTRAINTS%QUASI_NEUTRAL_IONOSPHERE [expert, experimental]
parameters
filter
state
ensemble
observations
logger
1. LOGGER%VERBOSE_LEVEL

Output

In addition to the history files, TIE-GCM PDAF has its own writer, which is controlled by this group.

OUTPUT%RESULT_FILE_NAME_TAG

Name of the NetCDF file(s). “.nc” is added automatically.

Type: string

Default: "results"

Example: OUTPUT%RESULT_FILE_NAME_TAG="test"

OUTPUT%SAVED_FIELDS

List of state variables that are included in the result file. The state variables are specified by the short names. Currently, all prognostic state variables, mass density ('DEN'), and mass fraction of molecular Nitrogen ('N') are supported. To include further state variables quantity_info.F90 has to be modified.

List of all fields that can be written

short name	long name	units
TN	NEUTRAL TEMPERATURE	K
UN	NEUTRAL ZONAL WIND (+EAST)	cm/s
VN	NEUTRAL MERIDIONAL WIND (+NORTH)	cm/s
O2	MOLECULAR OXYGEN	mmr
O1	ATOMIC OXYGEN	mmr
HE	HELIUM	mmr
OP	O+ ION	cm-3
N2D	metastable excited nitrogen atoms N(2D)	mmr
N4S	excited nitrogen atoms N(4S)	mmr
NO	NITRIC OXIDE	mmr
AR	ARGON (AR)	MMR
TI	ION TEMPERATURE	K
TE	ELECTRON TEMPERATURE	K
NE	ELECTRON DENSITY	cm-3
OMEGA	VERTICAL MOTION	s-1
O2P	O2+ ION	cm-3
Z	GEOPOTENTIAL HEIGHT	cm
POTEN	ELECTRIC POTENTIAL	volts
TN_NM	NEUTRAL TEMPERATURE (TIME N-1)	K
UN_NM	NEUTRAL ZONAL WIND (TIME N-1)	cm/s
VN_NM	NEUTRAL MERIDIONAL WIND (TIME N-1)	cm/s
O2_NM	MOLECULAR OXYGEN (TIME N-1)	mmr
O1_NM	ATOMIC OXYGEN (TIME N-1)	mmr
HE_NM	HELIUM (TIME N-1)	mmr
OP_NM	OP (TIME N-1)	cm-3
N2D_NM	N2D (TIME N-1)	mmr
N4S_NM	excited nitrogen atoms N(4S) (TIME N-1)	mmr
NO_NM	NO (TIME N-1)	mmr
AR_NM	ARGON (TIME N-1)	MMR
MBAR	MEAN MOLECULAR WEIGHT
BARM	MEAN MOLECULAR WEIGHT
XNMBAR	p0e(-z)/kTmbar
XNMBARI	p0e(-z)/kTbarm
SCHT	SCALE HEIGHT AT MIDPOINTS	cm
SCHTI	SCALE HEIGHT AT INTERFACES	cm
VC	COS(PHI)*VN
TN_G	NEUTRAL TEMPERATURE gradient	K 1/s
UN_G	NEUTRAL ZONAL WIND (+EAST) gradient	cm/s 1/s
VN_G	NEUTRAL MERIDIONAL WIND (+NORTH) gradient	cm/s 1/s
O2_G	MOLECULAR OXYGEN gradient	mmr 1/s
O1_G	ATOMIC OXYGEN gradient	mmr 1/s
HE_G	HELIUM gradient	mmr 1/s
OP_G	O+ ION gradient	cm-3 1/s
N2D_G	metastable excited nitrogen atoms N(2D) gradient	mmr 1/s
N4S_G	excited nitrogen atoms N(4S) gradient	mmr 1/s
NO_G	NITRIC OXIDE gradient	mmr 1/s
AR_G	ARGON (AR) gradient	MMR 1/s
DEN	neutral mass density	g/cm3
DEN_NM	neutral mass density	g/cm3
ZG	geometric height at interfaces	cm
ZGMID	geometric height at midpoints	cm
N2	molecular nitrogen	mmr

Type: string array

Default: empty

Example: OUTPUT%RESULT_FILE_NAME_TAG='DEN', 'O1', 'O2', 'HE', 'TN', 'NE',

OUTPUT%SAVE_STATE

If true, in addition to the quantities specified in OUTPUT%SAVED_FIELDS, all state vector quantities at time step i are also written.

Type: logical

Default: .false.

Example: OUTPUT%SAVE_STATE=.true.

OUTPUT%SAVE_STATE_NM

If true, in addition to the quantities specified in OUTPUT%SAVED_FIELDS, all quantities of the state vector at time step i-1 are also written.

Type: logical

Default: .false.

Example: OUTPUT%SAVE_STATE_NM=.true.

OUTPUT%SAVE_OBS

If true, in addition to the quantities specified in OUTPUT%SAVED_FIELDS, all observed quantities are also written.

Type: logical

Default: .true.

Example: OUTPUT%SAVE_OBS=.true.

OUTPUT%SAVE_MEMBERS

Write all ensemble members to the file. This may result in very large files.

Type: logical

Default: .false.

Example: OUTPUT%SAVE_MEMBERS=.true.

OUTPUT%SYNC_EVERY

Syncing the nc files is a costly operation. This parameter controls how many time steps after a writing operation the file is synced. If the model crashes before the data is synchronized, it is lost.

Type: integer

Default: 10

Example: OUTPUT%SYNC_EVERY=100

OUTPUT%OUTPUT_STRATEGY [expert]

1: single writer - single file (recommended)

2: multiple writers - multiple files

Type: integer

Default: 1

Example: OUTPUT%OUTPUT_STRATEGY=1

OUTPUT%MAX_MOMENT

Determines which (central) statistical moments are computed

1: mean

2: mean, standard deviation

3: mean, standard deviation, skewness

4: mean, standard deviation, skewness, excess kurtosis

Type: integer

Default: 2

Example: OUTPUT%MAX_MOMENT=3

OUTPUT%SUPRESS_TIEGCM_OUTPUT

This option suppresses the generation of TIE-GCM internal history files.

Type: logical

Default: .true.

Example: OUTPUT%SUPRESS_TIEGCM_OUTPUT=.true.

You cannot restart the model without the TIE-GCM internal files

OUTPUT%USE_DOUBLE_PRECISION

If true, use 8-byte floating-point numbers; else, use 4-byte floating-point numbers.

Type: logical

Default: .true.

Example: OUTPUT%USE_DOUBLE_PRECISION=.true.

OUTPUT%WRITE_EVERY_SEC

Determines how frequently data is written. The duration in seconds is converted to the number of model steps. If negative, every time step is saved (not recommended).

Type: integer

Default: -1

Example: OUTPUT%WRITE_EVERY_SEC=60

OUTPUT%FORCE_WRITE_ON_UPDATE

Write every analysis regardless of writing frequency determined in OUTPUT%WRITE_EVERY_SEC

Type: logical

Default: .true.

Example: OUTPUT%FORCE_WRITE_ON_UPDATE=.true.

OUTPUT%LOCK_NC_TIME

If true, all variables in the NetCDF file have the same temporal dimension. With this setting, it is not possible to write variables with different temporal resolutions.

Type: logical

Default: .true.

Example: OUTPUT%LOCK_NC_TIME=.true.

OUTPUT%SAVE_UNCONSTRAINED_ANALYSIS [expert]

Write the results of the analysis step before applying the constraints. The constrained quantities are written regardless of this option.

Type: logical

Default: .false.

Example: OUTPUT%SAVE_UNCONSTRAINED_ANALYSIS=.true.

OUTPUT%SAVE_N_STEPS_AFTER_UPDATE [expert]

Write the n subsequent model steps after each analysis step. This option is intended for debugging not for production runs.

Type: integer

Default: 0

Example: OUTPUT%SAVE_N_STEPS_AFTER_UPDATE=5

OUTPUT%ENFORCE_SYNC_AFTER_UPDATE [expert]

Force syncronization of result file after each analysis step. This option is intended for debugging not for production runs.

Type: logical

Default: .false.

Example: OUTPUT%ENFORCE_SYNC_AFTER_UPDATE=.true.

OUTPUT%DEBUG [expert]

Convenience switch that enables the full diagnostic output needed to investigate a crash or an unexpected analysis increment.

Every option that is actually changed is reported on stdout, so the effective configuration remains visible in the log. Options are only ever switched on, never off.

option	set to
`OUTPUT%SAVE_OBS`	`.true.`
`OUTPUT%SAVE_STATE`	`.true.`
`OUTPUT%SAVE_STATE_NM`	`.true.`
`OUTPUT%SAVE_MEMBERS`	`.true.`
`OUTPUT%FORCE_WRITE_ON_UPDATE`	`.true.`
`OUTPUT%SAVE_UNCONSTRAINED_ANALYSIS`	`.true.`
`OUTPUT%SAVE_N_STEPS_AFTER_UPDATE`	at least `5`
`OUTPUT%ENFORCE_SYNC_AFTER_UPDATE`	`.true.`
`OUTPUT%SYNC_EVERY`	`1`
`LOGGER%VERBOSE_LEVEL`	at least `1`

OUTPUT%SAVE_N_STEPS_AFTER_UPDATE and LOGGER%VERBOSE_LEVEL are only raised if they are currently smaller, so a larger explicit value is preserved. OUTPUT%SYNC_EVERY is the exception: it is always set to 1, since for this option a smaller value means more diagnostic safety, not less.

Intended for debugging only, never for production runs. The impact on runtime and disk usage is severe: every ensemble member is written, the state vector is written for the current and previous time step, and five additional model steps are written after every analysis step. This option removes the throttling of file syncronization entirely.

Type: logical

Default: .false.

Example: OUTPUT%DEBUG=.true.

calibration

CALIBRATION%APPLY

Global switch controlling co-estimation of model parameters. The parameters that should be calibrated are selected in the parameters group.

Type: logical

Default: .false.

Example: CALIBRATION%APPLY=.true.

CALIBRATION%LOCALIZATION_TAPERING

Tapering factor applied in the update step for the co-estimated parameters.

Type: real

Default: 1.0

Example: CALIBRATION%LOCALIZATION_TAPERING=1.0

CALIBRATION%EVERY

Controls how often the parameters are co-estimated. 1 indicates that parameters are co-estimated at every analysis step, 2 indicates they are estimated every second analysis step, and so on.

Type: integer

Default: 1

Example: CALIBRATION%EVERY=10

constraints

After each analysis step, constraints are applied to ensure the state is physically consistent.

CONSTRAINTS%QUASI_NEUTRAL_IONOSPHERE [expert, experimental]

Replaces electron density with the sum of all ions. Not recommended.

Type: logical

Default: .false.

Example: CONSTRAINTS%QUASI_NEUTRAL_IONOSPHERE=.false.

parameters

This section controls various model inputs, not only model parameters. The name PARAMETERS is therefore somewhat misleading, but it is not changed to keep the configuration file compatible.

PARAMETERS%ENSEMBLE_FILE

Default path to NetCDF file containing the model input perturbations for all ensemble members.

Type: string

Default: ""

Example: PARAMETERS%ENSEMBLE_FILE="./perturbations.nc"

PARAMETERS%SKIP_LIST

If specified, the ensemble members in the perturbation file corresponding to the given indices (starting at 1) are excluded. The number of perturbation members saved in the file must be larger than the model ensemble size + the number of excluded perturbation members to use this option.

Type: integer array

Default: 0

Example: PARAMETERS%SKIP_LIST= 5,8,32

parameter setup

Currently, the following model inputs can be controlled:

f107
ctpoten
hspower
tlbc
zlbc
ulbc
vlbc
alfac
alfad
colfac
joulefac
swden
swvel
imfbx
imfby
imfbz
imfbf
igrf_sh
co2u

Each parameter has two settings

HANDLING

Controls how the program handles a parameter:

"none": the parameter is not influenced by the assimilation system
"perturb": Perturb the parameter according to the perturbations in the specified ensemble file.
"calibrate": Co-estimate the parameter
"overwrite": overwrite the parameter by the values (not perturbations) specified inthe ensemble file
"mean": replace the parameter with the ensemble mean specified in the ensemble file

Type: string

Default: "none"

Example: PARAMETERS%F107%HANDLING="perturb"

ENSEMBLE_FILE

Either the path to an ensemble file or “default”. In case of default, the file specified in PARAMETERS%ENSEMBLE_FILE is used.

Type: string

Default: "default"

Example: PARAMETERS%F107%ENSEMBLE_FILE="./some_file"

filter

Controls the Kalman filter

FILTER%OPEN_LOOP

In an open-loop simulation, all ensemble members are propagated and perturbed, but observations are not assimilated. The filter is not applied.

Type: logical

Default: .false.

Example: ` FILTER%OPEN_LOOP=.true.`

FILTER%SPLINE_DEGREE

Controls how the observation operator interpolates the state to the observation space.

1 linear interpolation

2 quadratic B-spline

3 cubic B-spline

4 quartic B-spline

5 quintic B-spline

Type: integer

Default: 3

Example: FILTER%SPLINE_DEGREE=3

FILTER%FIRST_ANALYSIS_STEP_SEC

Specifies how many seconds after initializing the model, the first analysis step is performed

Type: integer

Default: 0

Example: FILTER%FIRST_ANALYSIS_STEP_SEC=60

FILTER%FORECAST_DURATION_SEC

Specifies the duration in seconds between two subsequent analysis steps

Type: integer

Default: 0

Example: FILTER%FORECAST_DURATION_SEC=120

FILTER%FILTERTYPE

Specifies the filter algorithm used by PDAF. Currently, only the following two filters are implemented.

6: global ESTKF

7: localized ESTKF

Type: integer

Default: 6

Example: FILTER%FILTERTYPE=7

FILTER%SUBTYPE [expert]

Specifies the sub type (see PDAF wiki)

Type: integer

Default: 0

Example: FILTER%SUBTYPE=0

FILTER%TYPE_TRANS [expert]

Specifies the type of ensemble transformation matrix (see PDAF wiki)

Type: integer

Default: 0

Example: FILTER%TYPE_TRANS=0

FILTER%TYPE_FORGET [expert]

Specifies the type of forgetting factor (see PDAF wiki)

Type: integer

Default: 0

Example: FILTER%TYPE_FORGET=0

FILTER%TYPE_SQRT [expert]

Specifies the type of transformation matrix square root (see PDAF wiki)

Type: integer

Default: 0

Example: FILTER%TYPE_SQRT=0

FILTER%LOCWEIGHT

Specifies how the distance between observations and states is weighted when using localization

0: unit weight

1: exponential

2: finite function mimicking a Gaussian

Type: integer

Default: 1

Example: FILTER%LOCWEIGHT=0

FILTER%cutoff_radius

Specifies the cutoff radius for localization in zonal, meridional, and vertical directions. Units depend on filter%localization_coord_sys

Type: real array

Default: 0,0,0

Example: FILTER%CUTOFF_RADIUS= 1000E+3,1000E+3,50E+3

FILTER%SUPPORT_RADIUS

Specifies the support radius for localization in zonal, meridional, and vertical directions. Units depend on filter%localization_coord_sys

Type: real array

Default: 0,0,0

Example: FILTER%SUPPORT_RADIUS= 1000E+3,1000E+3,50E+3

FILTER%LOCALIZATION_COORD_SYS

Specifies how the distance between observations and states is measured

1: distance in meters computed using the haversine formula

2: distance in number of grid cells

Type: integer

Default: 1

Example: FILTER%LOCALIZATION_COORD_SYS=1

FILTER%SUB_DOMAIN_SIZE_VERTICAL

vertical extent of sub-domains (number of grid cells)

Type: integer

Default: 3

Example: FILTER%SUB_DOMAIN_SIZE_VERTICAL=1

FILTER%SUB_DOMAIN_SIZE_ZONAL

zonal extent of sub-domains (number of grid cells)

Type: integer

Default: 3

Example: FILTER%SUB_DOMAIN_SIZE_ZONAL=1

FILTER%SUB_DOMAIN_SIZE_MERIDIONAL

meridional extent of sub-domains (number of grid cells)

Type: integer

Default: 3

Example: FILTER%SUB_DOMAIN_SIZE_MERIDIONAL=1

state

Controls the composition of the state vector

STATE%O2

Add molecular Oxygen mass fraction to the state vector

Type: logical

Default: .false.

Example: STATE%O2=.true.

STATE%O1

Add atomic Oxygen mass fraction to the state vector

Type: logical

Default: .false.

Example: STATE%O1=.true.

STATE%HE

Add atomic Helium mass fraction to the state vector

Type: logical

Default: .false.

Example: STATE%HE=.true.

STATE%TN

Add neutral temperature to the state vector

Type: logical

Default: .false.

Example: STATE%TN=.true.

STATE%NE

Add electron number density to the state vector

Type: logical

Default: .false.

Example: STATE%NE=.true.

STATE%ZONAL_WIND

Add zonal wind velocity to the state vector

Type: logical

Default: .false.

Example: STATE%ZONAL_WIND=.true.

STATE%MERIDIONAL_WIND

Add meridional wind velocity to the state vector

Type: logical

Default: .false.

Example: STATE%MERIDIONAL_WIND=.true.

STATE%ATOMIC_OXYGEN_ION_DENSITY

Add atomic oxygen ion number density to the state vector

Type: logical

Default: .false.

Example: STATE%ATOMIC_OXYGEN_ION_DENSITY=.true.

STATE%MOLECULAR_OXYGEN_ION_DENSITY

Add molecular oxygen ion number density to the state vector

Type: logical

Default: .false.

Example: STATE%MOLECULAR_OXYGEN_ION_DENSITY=.true.

STATE%ATOMIC_ARGON

Add mass fraction of atomic argon to the state vector

Type: logical

Default: .false.

Example: STATE%ATOMIC_ARGON=.true.

STATE%NITRIC_OXIDE

Add mass fraction of nitric oxide to the state vector

Type: logical

Default: .false.

Example: STATE%NITRIC_OXIDE=.true.

STATE%EXCITED_ATOMIC_NITROGEN_4S

Add mass fraction of excited Nitrogen in 4S atomic state to the state vector

Type: logical

Default: .false.

Example: STATE%EXCITED_ATOMIC_NITROGEN_4S=.true.

STATE%EXCITED_ATOMIC_NITROGEN_2D

Add mass fraction of excited Nitrogen in 2D atomic state to the state vector

Type: logical

Default: .false.

Example: STATE%EXCITED_ATOMIC_NITROGEN_2D=.true.

STATE%ELECTRON_TEMPERATURE

Add electron temperature to the state vector

Type: logical

Default: .false.

Example: STATE%ELECTRON_TEMPERATURE=.true.

STATE%ION_TEMPERATURE

Add ion temperature to the state vector

Type: logical

Default: .false.

Example: STATE%ION_TEMPERATURE=.true.

ensemble

ENSEMBLE%ENSEMBLE_SIZE

controls the ensemble size/number of ensemble members

Type: integer

Default: 0

Example: ENSEMBLE%ENSEMBLE_SIZE=96

ENSEMBLE%OVERWRITE_SOURCE

If disabled, the initial state is initialized according to the TIE-GCM input file. When enabled, the state of each member is initialized according to ENSEMBLE%SOURCE_PATH and ENSEMBLE%SOURCE_NAME.

Type: logical

Default: .false.

Example: ENSEMBLE%OVERWRITE_SOURCE=.true.

ENSEMBLE%SOURCE_PATH

Path to the directory containing a TIE-GCM primary history file for each member. The files have to start with ens_xxxx_, where xxxx is the index of the ensemble member, padded with leading zeros. The files can be created by conducting an open-loop simulation. The assimilation system will then automatically generate the history files with the correct naming schema.

Type: string

Default: ""

Example: ENSEMBLE%SOURCE_PATH=/path/to/the/primary/history/files/for/each/member

ENSEMBLE%SOURCE_NAME

The constant part of the history file name after ens_xxxx_ Type: string

Default: ""

Example: ENSEMBLE%SOURCE_NAME=init

observations

OBSERVATION%SATELLITE()

Section to assimilate data along a satellite’s orbit.

Data from multiple satellites can be assimilated simultaneously. Currently, only total mass densities can be assimilated.

OBSERVATION%SATELLITE()%APPLY

assimilate this observation

Type: logical

Default: .false.

Example: OBSERVATION%SATELLITE(1)%APPLY=.true.

OBSERVATION%SATELLITE()%ALWAYS_SAVE

interpolate the model grid to the location of the observation and save it to the result file, even when it is not assimilated. Useful for open-loop simulations.

Type: logical

Default: .false.

Example: OBSERVATION%SATELLITE(1)%ALWAYS_SAVE=.true.

OBSERVATION%SATELLITE()%FILE_FORMAT

Format of the file containing the observations

"igg" https://doi.pangaea.de/10.1594/PANGAEA.931347

"toleos" http://thermosphere.tudelft.nl/page1.html

"toleos_reduced" some toleos files store data with reduced accuracy

'toleos_short' some toleos files store data with less columns

groops https://www.tugraz.at/institute/ifg/downloads/satellite-orbit-products

Type: string

Default: "igg"

Example: OBSERVATION%SATELLITE(1)%FILE_FORMAT="igg"

OBSERVATION%SATELLITE()%FILE

Path to the file containing the observations in the format specified in OBSERVATION%SATELLITE()%FILE_FORMAT. Bash shell wildcards, e.g., * or [], are supported and should be used if the data is distributed across multiple files.

Type: string

Default: ''

Example: OBSERVATION%SATELLITE(1)%FILE="/locatio/of/the/file"

OBSERVATION%SATELLITE()%NAME

name used to save the data in the result file.

Type: string

Default: ''

Example: OBSERVATION%SATELLITE(1)%FILE="satellitename"

OBSERVATION%SATELLITE()%WEIGHT

Currently, it is assumed that the uncertainty is 10% of the value itself. The standard deviation is divided by the weight factor.

Type: real

Default: 1.0

Example: OBSERVATION%SATELLITE(1)%WEIGHT=2.0

OBSERVATION%SATELLITE()%WRITE_EVERY_SEC

Determines how frequently data at the location of the observation is written. The duration in seconds is converted to the number of model steps. If negative, every time step is saved (not recommended).

Type: integer

Default: -1

Example: OBSERVATION%SATELLITE(1)%WRITE_EVERY_SEC=600

OBSERVATION%SATELLITE()%FORCE_WRITE_ON_UPDATE

Write every analysis regardless of writing frequency determined in OBSERVATION%SATELLITE()%WRITE_EVERY_SEC

Type: logical

Default: .true.

Example: OBSERVATION%SATELLITE(1)%FORCE_WRITE_ON_UPDATE=.false.

OBSERVATION%CAL_DEN()

Section to assimilate (calibrated) gridded neutral mass densities, e.g. form an semi-empirical model

OBSERVATION%CAL_DEN()%APPLY

assimilate this observation

Type: logical

Default: .false.

Example: OBSERVATION%CAL_DEN(1)%APPLY=.true.

OBSERVATION%CAL_DEN()%ALWAYS_SAVE

interpolate the model grid to the location of the observation and save it to the result file, even when it is not assimilated. Useful for open-loop simulations.

Type: logical

Default: .false.

Example: OBSERVATION%CAL_DEN(1)%ALWAYS_SAVE=.true.

OBSERVATION%CAL_DEN()%tme_grid_file

path to the NetCDF file containing the calibrated mass densities on a regular grid

Type: string

Default: ''

Example: OBSERVATION%CAL_DEN(1)%tme_grid_file="./file.nc"

OBSERVATION%CAL_DEN()%fields

Name of the fields in the NetCDF file that should be assimilated

Type: string

Default: ''

Example: OBSERVATION%CAL_DEN(1)%fields="DEN"

OBSERVATION%CAL_DEN()%NAME

name used to save the data in the result file.

Type: string

Default: ''

Example: OBSERVATION%CAL_DEN(1)%NAME="cal_msis_champ"

OBSERVATION%CAL_DEN()%SATELLITE

Name of the Satellite used for calibration

Type: string

Default: ''

Example: OBSERVATION%CAL_DEN(1)%SATELLITE="champ"

OBSERVATION%CAL_DEN()%WEIGHT

Currently, it is assumed that the uncertainty is 10% of the value itself. The standard deviation is divided by the weight factor.

Type: real

Default: 1.0

Example: OBSERVATION%CAL_DEN(1)WEIGHT=1.0

OBSERVATION%CAL_DEN()%horz_weight_half_life

If > 0, weights observations by distance to the satellite used for calibration. Weights are computed from an exponential function that halves every horz_weight_half_life. Half-life is provided in degrees.

Type: real

Default: .0

Example: OBSERVATION%CAL_DEN(1)horz_weight_half_life=30

OBSERVATION%CAL_DEN()%vert_weight_half_life

If > 0, weights observations by distance to the satellite used for calibration. Weights are computed from an exponential function that halves every vert_weight_half_life. Half-life is provided in km.

Type: real

Default: .0

Example: OBSERVATION%CAL_DEN(1)vert_weight_half_life=600

OBSERVATION%CAL_DEN()%correlations [experimental]

exp or none. Treats observations as correlated and uses an exponential to fill the off-diagonals of the correlation matrix. Decay is currently hard-coded. Type: string

Default: none

Example: OBSERVATION%CAL_DEN(1)correlations='exp'

OBSERVATION%CAL_DEN()%WRITE_EVERY_SEC

Type: integer

Default: -1

Example: OBSERVATION%CAL_DEN(1)%WRITE_EVERY_SEC=600

OBSERVATION%CAL_DEN()%FORCE_WRITE_ON_UPDATE

Write every analysis regardless of writing frequency determined in OBSERVATION%CAL_DEN(1)%WRITE_EVERY_SEC

Type: logical

Default: .true.

Example: OBSERVATION%CAL_DEN(1)%FORCE_WRITE_ON_UPDATE=.false.

OBSERVATION%TUM_NE()

Section to assimilate 3D electron densities

OBSERVATION%TUM_NE%APPLY

assimilate this observation

Type: logical

Default: .false.

Example: OBSERVATION%TUM_NE%APPLY=.true.

OBSERVATION%TUM_NE%ALWAYS_SAVE

interpolate the model grid to the location of the observation and save it to the result file, even when it is not assimilated. Useful for open-loop simulations.

Type: logical

Default: .false.

Example: OBSERVATION%TUM_NE%ALWAYS_SAVE=.true.

OBSERVATION%TUM_NE%tme_grid_file

path to the NetCDF file containing the 3D electron densities

Type: string

Default: ''

Example: OBSERVATION%TUM_NE%tme_grid_file="./file.nc"

OBSERVATION%TUM_NE%NAME

name used to save the data in the result file.

Type: string

Default: ''

Example: OBSERVATION%TUM_NE%NAME="tumne"

OBSERVATION%TUM_NE%WEIGHT

Currently, it is assumed that the uncertainty is 10% of the value itself. The standard deviation is divided by the weight factor.

Type: real

Default: 1.0

Example: OBSERVATION%TUM_NE%WEIGHT=1.0

OBSERVATION%TUM_NE%WRITE_EVERY_SEC

Type: integer

Default: -1

Example: OBSERVATION%TUM_NE%WRITE_EVERY_SEC=600

OBSERVATION%TUM_NE%FORCE_WRITE_ON_UPDATE

Write every analysis regardless of writing frequency determined in OBSERVATION%TUM_NE%WRITE_EVERY_SEC

Type: logical

Default: .true.

Example: OBSERVATION%TUM_NE%FORCE_WRITE_ON_UPDATE=.false.

logger

LOGGER%VERBOSE_LEVEL

Controls how verbose the output is. Currently, there are only two options: 0 and 1.

Type: integer

Default: 0

Example: LOGGER%VERBOSE_LEVEL=0