namespace mom_oda_driver_mod

Overview

Interfaces for MOM6 ensembles and data assimilation. More…

namespace mom_oda_driver_mod {

// global functions

subroutine, public init_oda(Time Time, G G, GV GV, CS CS);
subroutine, public set_prior_tracer(Time Time, G G, GV GV, h h, tv tv, CS CS);
subroutine, public get_posterior_tracer(Time Time, CS CS, h h, tv tv, increment increment);
subroutine, public oda(Time Time, CS CS);
subroutine, public oda_end(CS CS);
subroutine, public set_analysis_time(Time Time, CS CS);
subroutine, public save_obs_diff(filename filename, CS CS);
subroutine, public apply_oda_tracer_increments(dt dt, G G, tv tv, h h, CS CS);

} // namespace mom_oda_driver_mod

Detailed Documentation

Interfaces for MOM6 ensembles and data assimilation.

Global Functions

subroutine, public init_oda(Time Time, G G, GV GV, CS CS)

initialize First_guess (prior) and Analysis grid information for all ensemble members

Parameters:

time	The current model time.
g	domain and grid information for ocean model
gv	The ocean’s vertical grid structure
cs	The DA control structure

subroutine, public set_prior_tracer(Time Time, G G, GV GV, h h, tv tv, CS CS)

Copy ensemble member tracers to ensemble vector.

Parameters:

time	The current model time
g	domain and grid information for ocean model
gv	The ocean’s vertical grid structure
h	Layer thicknesses [H ~> m or kg m-2]
tv	A structure pointing to various thermodynamic variables
cs	ocean DA control structure

subroutine, public get_posterior_tracer(
    Time Time,
    CS CS,
    h h,
    tv tv,
    increment increment
    )

Returns posterior adjustments or full state Note that only those PEs associated with an ensemble member receive data.

Parameters:

time	the current model time
cs	ocean DA control structure
h	Layer thicknesses [H ~> m or kg m-2]
tv	A structure pointing to various thermodynamic variables
increment	True if returning increment only

subroutine, public oda(Time Time, CS CS)

Gather observations and sall ODA routines.

Parameters:

time	the current model time
cs	the ocean DA control structure

subroutine, public oda_end(CS CS)

Finalize DA module.

Parameters:

cs	the ocean DA control structure

subroutine, public set_analysis_time(Time Time, CS CS)

Set the next analysis time.

Parameters:

time	the current model time
cs	the DA control structure

subroutine, public save_obs_diff(filename filename, CS CS)

Write observation differences to a file.

Parameters:

filename	name of output file
cs	pointer to DA control structure

subroutine, public apply_oda_tracer_increments(dt dt, G G, tv tv, h h, CS CS)

Apply increments to tracers.

Parameters:

dt	The tracer timestep [s]
g	ocean grid structure
tv	A structure pointing to various thermodynamic variables
h	layer thickness [H ~> m or kg m-2]
cs	the data assimilation structure