MOM6
|
The ocean_state_type contains all information about the state of the ocean, with a format that is private so it can be readily changed without disrupting other coupled components.
Definition at line 134 of file mom_ocean_model_mct.F90.
Public variables and constants | |
logical | is_ocean_pe = .false. |
True if this is an ocean PE. More... | |
type(time_type) | time |
The ocean model's time and master clock. More... | |
integer | restart_control |
An integer that is bit-tested to determine whether incremental restart files are saved and whether they have a time stamped name. +1 (bit 0) for generic files and +2 (bit 1) for time-stamped files. A restart file is saved at the end of a run segment unless Restart_control is negative. More... | |
integer | nstep = 0 |
The number of calls to update_ocean. More... | |
logical | use_ice_shelf |
If true, the ice shelf model is enabled. More... | |
logical | use_waves |
If true use wave coupling. More... | |
logical | icebergs_alter_ocean |
If true, the icebergs can change ocean the ocean dynamics and forcing fluxes. More... | |
logical | restore_salinity |
If true, the coupled MOM driver adds a term to restore salinity to a specified value. More... | |
logical | restore_temp |
If true, the coupled MOM driver adds a term to restore sst to a specified value. More... | |
real | press_to_z |
A conversion factor between pressure and ocean depth in m, usually 1/(rho_0*g), in m Pa-1. More... | |
real | c_p |
The heat capacity of seawater, in J K-1 kg-1. More... | |
logical | offline_tracer_mode = .false. |
If false, use the model in prognostic mode with the barotropic and baroclinic dynamics, thermodynamics, etc. stepped forward integrated in time. If true, all of the above are bypassed with all fields necessary to integrate only the tracer advection and diffusion equation read in from files stored from a previous integration of the prognostic model. More... | |
logical | single_step_call |
If true, advance the state of MOM with a single step including both dynamics and thermodynamics. If false, the two phases are advanced with separate calls. The default is true. More... | |
real | dt |
(baroclinic) dynamics time step (seconds) More... | |
real | dt_therm |
thermodynamics time step (seconds) More... | |
logical | thermo_spans_coupling |
If true, thermodynamic and tracer time steps can span multiple coupled time steps. More... | |
logical | diabatic_first |
If true, apply diabatic and thermodynamic processes before time stepping the dynamics. More... | |
type(directories) | dirs |
A structure containing several relevant directory paths. More... | |
type(mech_forcing) | forces |
A structure with the driving mechanical surface forces. More... | |
type(forcing) | fluxes |
A structure containing pointers to the thermodynamic ocean forcing fields. More... | |
type(forcing) | flux_tmp |
A secondary structure containing pointers to the ocean forcing fields for when multiple coupled timesteps are taken per thermodynamic step. More... | |
type(surface) | sfc_state |
A structure containing pointers to the ocean surface state fields. More... | |
type(ocean_grid_type), pointer | grid => NULL() |
A pointer to a grid structure containing metrics. More... | |
type(verticalgrid_type), pointer | gv => NULL() |
A pointer to a structure containing information. More... | |
type(unit_scale_type), pointer | us => NULL() |
A pointer to a structure containing dimensional unit scaling factors. More... | |
type(mom_control_struct), pointer | mom_csp => NULL() |
A pointer to the MOM control structure. More... | |
type(ice_shelf_cs), pointer | ice_shelf_csp => NULL() |
A pointer to the control structure for the. More... | |
type(marine_ice_cs), pointer | marine_ice_csp => NULL() |
A pointer to the control structure for the. More... | |
type(wave_parameters_cs), pointer | waves |
A structure containing pointers to the surface wave fields. More... | |
type(surface_forcing_cs), pointer | forcing_csp => NULL() |
A pointer to the MOM forcing control structure. More... | |
type(mom_restart_cs), pointer | restart_csp => NULL() |
A pointer set to the restart control structure. More... | |
type(diag_ctrl), pointer | diag => NULL() |
A pointer to the diagnostic regulatory structure. More... | |
real mom_ocean_model_mct::ocean_state_type::c_p |
The heat capacity of seawater, in J K-1 kg-1.
Definition at line 157 of file mom_ocean_model_mct.F90.
logical mom_ocean_model_mct::ocean_state_type::diabatic_first |
If true, apply diabatic and thermodynamic processes before time stepping the dynamics.
Definition at line 175 of file mom_ocean_model_mct.F90.
type(diag_ctrl), pointer mom_ocean_model_mct::ocean_state_type::diag => NULL() |
A pointer to the diagnostic regulatory structure.
Definition at line 211 of file mom_ocean_model_mct.F90.
type(directories) mom_ocean_model_mct::ocean_state_type::dirs |
A structure containing several relevant directory paths.
Definition at line 178 of file mom_ocean_model_mct.F90.
real mom_ocean_model_mct::ocean_state_type::dt |
(baroclinic) dynamics time step (seconds)
Definition at line 171 of file mom_ocean_model_mct.F90.
real mom_ocean_model_mct::ocean_state_type::dt_therm |
thermodynamics time step (seconds)
Definition at line 172 of file mom_ocean_model_mct.F90.
type(forcing) mom_ocean_model_mct::ocean_state_type::flux_tmp |
A secondary structure containing pointers to the ocean forcing fields for when multiple coupled timesteps are taken per thermodynamic step.
Definition at line 182 of file mom_ocean_model_mct.F90.
type(forcing) mom_ocean_model_mct::ocean_state_type::fluxes |
A structure containing pointers to the thermodynamic ocean forcing fields.
Definition at line 180 of file mom_ocean_model_mct.F90.
type(mech_forcing) mom_ocean_model_mct::ocean_state_type::forces |
A structure with the driving mechanical surface forces.
Definition at line 179 of file mom_ocean_model_mct.F90.
type(surface_forcing_cs), pointer mom_ocean_model_mct::ocean_state_type::forcing_csp => NULL() |
A pointer to the MOM forcing control structure.
Definition at line 206 of file mom_ocean_model_mct.F90.
type(ocean_grid_type), pointer mom_ocean_model_mct::ocean_state_type::grid => NULL() |
A pointer to a grid structure containing metrics.
Definition at line 187 of file mom_ocean_model_mct.F90.
type(verticalgrid_type), pointer mom_ocean_model_mct::ocean_state_type::gv => NULL() |
A pointer to a structure containing information.
Definition at line 190 of file mom_ocean_model_mct.F90.
type(ice_shelf_cs), pointer mom_ocean_model_mct::ocean_state_type::ice_shelf_csp => NULL() |
A pointer to the control structure for the.
Definition at line 197 of file mom_ocean_model_mct.F90.
logical mom_ocean_model_mct::ocean_state_type::icebergs_alter_ocean |
If true, the icebergs can change ocean the ocean dynamics and forcing fluxes.
Definition at line 149 of file mom_ocean_model_mct.F90.
logical mom_ocean_model_mct::ocean_state_type::is_ocean_pe = .false. |
True if this is an ocean PE.
Definition at line 136 of file mom_ocean_model_mct.F90.
type(marine_ice_cs), pointer mom_ocean_model_mct::ocean_state_type::marine_ice_csp => NULL() |
A pointer to the control structure for the.
Definition at line 201 of file mom_ocean_model_mct.F90.
type(mom_control_struct), pointer mom_ocean_model_mct::ocean_state_type::mom_csp => NULL() |
A pointer to the MOM control structure.
Definition at line 195 of file mom_ocean_model_mct.F90.
integer mom_ocean_model_mct::ocean_state_type::nstep = 0 |
The number of calls to update_ocean.
Definition at line 145 of file mom_ocean_model_mct.F90.
logical mom_ocean_model_mct::ocean_state_type::offline_tracer_mode = .false. |
If false, use the model in prognostic mode with the barotropic and baroclinic dynamics, thermodynamics, etc. stepped forward integrated in time. If true, all of the above are bypassed with all fields necessary to integrate only the tracer advection and diffusion equation read in from files stored from a previous integration of the prognostic model.
Definition at line 158 of file mom_ocean_model_mct.F90.
real mom_ocean_model_mct::ocean_state_type::press_to_z |
A conversion factor between pressure and ocean depth in m, usually 1/(rho_0*g), in m Pa-1.
Definition at line 155 of file mom_ocean_model_mct.F90.
integer mom_ocean_model_mct::ocean_state_type::restart_control |
An integer that is bit-tested to determine whether incremental restart files are saved and whether they have a time stamped name. +1 (bit 0) for generic files and +2 (bit 1) for time-stamped files. A restart file is saved at the end of a run segment unless Restart_control is negative.
Definition at line 138 of file mom_ocean_model_mct.F90.
type(mom_restart_cs), pointer mom_ocean_model_mct::ocean_state_type::restart_csp => NULL() |
A pointer set to the restart control structure.
Definition at line 208 of file mom_ocean_model_mct.F90.
logical mom_ocean_model_mct::ocean_state_type::restore_salinity |
If true, the coupled MOM driver adds a term to restore salinity to a specified value.
Definition at line 151 of file mom_ocean_model_mct.F90.
logical mom_ocean_model_mct::ocean_state_type::restore_temp |
If true, the coupled MOM driver adds a term to restore sst to a specified value.
Definition at line 153 of file mom_ocean_model_mct.F90.
type(surface) mom_ocean_model_mct::ocean_state_type::sfc_state |
A structure containing pointers to the ocean surface state fields.
Definition at line 185 of file mom_ocean_model_mct.F90.
logical mom_ocean_model_mct::ocean_state_type::single_step_call |
If true, advance the state of MOM with a single step including both dynamics and thermodynamics. If false, the two phases are advanced with separate calls. The default is true.
Definition at line 166 of file mom_ocean_model_mct.F90.
logical mom_ocean_model_mct::ocean_state_type::thermo_spans_coupling |
If true, thermodynamic and tracer time steps can span multiple coupled time steps.
Definition at line 173 of file mom_ocean_model_mct.F90.
type(time_type) mom_ocean_model_mct::ocean_state_type::time |
The ocean model's time and master clock.
Definition at line 137 of file mom_ocean_model_mct.F90.
type(unit_scale_type), pointer mom_ocean_model_mct::ocean_state_type::us => NULL() |
A pointer to a structure containing dimensional unit scaling factors.
Definition at line 193 of file mom_ocean_model_mct.F90.
logical mom_ocean_model_mct::ocean_state_type::use_ice_shelf |
If true, the ice shelf model is enabled.
Definition at line 146 of file mom_ocean_model_mct.F90.
logical mom_ocean_model_mct::ocean_state_type::use_waves |
If true use wave coupling.
Definition at line 147 of file mom_ocean_model_mct.F90.
type(wave_parameters_cs), pointer mom_ocean_model_mct::ocean_state_type::waves |
A structure containing pointers to the surface wave fields.
Definition at line 204 of file mom_ocean_model_mct.F90.