mom_oda_driver_mod module reference¶

Interfaces for MOM6 ensembles and data assimilation.

Data Types¶

`oda_cs`	Control structure that contains a transpose of the ocean state across ensemble members.
`ptr_mpp_domain`	A structure with a pointer to a domain2d, to allow for the creation of arrays of pointers.

Functions/Subroutines¶

`init_oda()`	initialize First_guess (prior) and Analysis grid information for all ensemble members
`set_prior_tracer()`	Copy ensemble member tracers to ensemble vector.
`get_posterior_tracer()`	Returns posterior adjustments or full state Note that only those PEs associated with an ensemble member receive data.
`oda()`	Gather observations and sall ODA routines.
`oda_end()`	Finalize DA module.
`init_ocean_ensemble()`	Initialize DA module.
`set_analysis_time()`	Set the next analysis time.
`save_obs_diff()`	Write observation differences to a file.
`apply_oda_tracer_increments()`	Apply increments to tracers.

Detailed Description¶

Interfaces for MOM6 ensembles and data assimilation.

Type Documentation¶

type mom_oda_driver_mod/oda_cs¶

Control structure that contains a transpose of the ocean state across ensemble members.

Type fields

% ocean_prior [type( ocean_control_struct ),pointer] :: ensemble ocean prior states in DA space
% ocean_posterior [type( ocean_control_struct ),pointer] :: ensemble ocean posterior states or increments to prior in DA space
% nk [integer] :: number of vertical layers used for DA
% grid [type(ocean_grid_type),pointer] :: MOM6 grid type and decomposition for the DA.
% domains [type( ptr_mpp_domain )(:),pointer] :: Pointer to mpp_domain objects for ensemble members.
% gv [type(verticalgrid_type),pointer] :: vertical grid for DA
% us [type(unit_scale_type),pointer] :: structure containing various unit conversion factors for DA
% mpp_domain [type(domain2d),pointer] :: Pointer to a mpp domain object for DA.
% oda_grid [type( grid_type ),pointer] :: local tracer grid
% h [real(:,:,:),pointer] :: layer thicknesses [H ~> m or kg m-2] for DA
% tv [type(thermo_var_ptrs),pointer] :: pointer to thermodynamic variables
% ni [integer] :: global i-direction grid size
% nj [integer] :: global j-direction grid size
% reentrant_x [logical] :: grid is reentrant in the x direction
% reentrant_y [logical] :: grid is reentrant in the y direction
% tripolar_n [logical] :: grid is folded at its north edge
% symmetric [logical] :: Values at C-grid locations are symmetric.
% assim_method [integer] :: Method: NO_ASSIM,EAKF_ASSIM or OI_ASSIM.
% ensemble_size [integer] :: Size of the ensemble.
% ensemble_id [integer] :: id of the current ensemble member
% ensemble_pelist [integer(:,:),pointer] :: PE list for ensemble members.
% filter_pelist [integer(:),pointer] :: PE list for ensemble members.
% assim_frequency [integer] :: analysis interval in hours
% profiles [type( ocean_profile_type ),pointer] :: pointer to linked list of all available profiles
% cprofiles [type( ocean_profile_type ),pointer] :: pointer to linked list of current profiles
% kdroot [type( kd_root ),pointer] :: A structure for storing nearest neighbors.
% ale_cs [type(ale_cs),pointer] :: ALE control structure for DA.
% use_ale_algorithm [logical] :: true is using ALE remapping
% regridcs [type(regridding_cs)] :: ALE control structure for regridding.
% remapcs [type(remapping_cs)] :: ALE control structure for remapping.
% time [type(time_type)] :: Current Analysis time.
% diag_cs [type(diag_ctrl)] :: Diagnostics control structure.