MOM6
mom_ocean_model_nuopc::ocean_state_type Type Reference

Detailed Description

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 133 of file mom_ocean_model_nuopc.F90.

Collaboration diagram for mom_ocean_model_nuopc::ocean_state_type:
[legend]

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...
 
real eps_omesh
 Max allowable difference between ESMF mesh and MOM6 domain coordinates. 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...
 

Variables and constants

◆ c_p

real mom_ocean_model_nuopc::ocean_state_type::c_p

The heat capacity of seawater, in J K-1 kg-1.

Definition at line 156 of file mom_ocean_model_nuopc.F90.

156  real :: C_p !< The heat capacity of seawater, in J K-1 kg-1.

◆ diabatic_first

logical mom_ocean_model_nuopc::ocean_state_type::diabatic_first

If true, apply diabatic and thermodynamic processes before time stepping the dynamics.

Definition at line 174 of file mom_ocean_model_nuopc.F90.

174  logical :: diabatic_first !< If true, apply diabatic and thermodynamic

◆ diag

type(diag_ctrl), pointer mom_ocean_model_nuopc::ocean_state_type::diag => NULL()

A pointer to the diagnostic regulatory structure.

Definition at line 213 of file mom_ocean_model_nuopc.F90.

213  type(diag_ctrl), pointer :: &
214  diag => null() !< A pointer to the diagnostic regulatory structure

◆ dirs

type(directories) mom_ocean_model_nuopc::ocean_state_type::dirs

A structure containing several relevant directory paths.

Definition at line 180 of file mom_ocean_model_nuopc.F90.

180  type(directories) :: dirs !< A structure containing several relevant directory paths.

◆ dt

real mom_ocean_model_nuopc::ocean_state_type::dt

(baroclinic) dynamics time step (seconds)

Definition at line 170 of file mom_ocean_model_nuopc.F90.

170  real :: dt !< (baroclinic) dynamics time step (seconds)

◆ dt_therm

real mom_ocean_model_nuopc::ocean_state_type::dt_therm

thermodynamics time step (seconds)

Definition at line 171 of file mom_ocean_model_nuopc.F90.

171  real :: dt_therm !< thermodynamics time step (seconds)

◆ eps_omesh

real mom_ocean_model_nuopc::ocean_state_type::eps_omesh

Max allowable difference between ESMF mesh and MOM6 domain coordinates.

Definition at line 177 of file mom_ocean_model_nuopc.F90.

177  real :: eps_omesh !< Max allowable difference between ESMF mesh and MOM6

◆ flux_tmp

type(forcing) mom_ocean_model_nuopc::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 184 of file mom_ocean_model_nuopc.F90.

184  type(forcing) :: flux_tmp !< A secondary structure containing pointers to the

◆ fluxes

type(forcing) mom_ocean_model_nuopc::ocean_state_type::fluxes

A structure containing pointers to the thermodynamic ocean forcing fields.

Definition at line 182 of file mom_ocean_model_nuopc.F90.

182  type(forcing) :: fluxes !< A structure containing pointers to

◆ forces

type(mech_forcing) mom_ocean_model_nuopc::ocean_state_type::forces

A structure with the driving mechanical surface forces.

Definition at line 181 of file mom_ocean_model_nuopc.F90.

181  type(mech_forcing) :: forces !< A structure with the driving mechanical surface forces

◆ forcing_csp

type(surface_forcing_cs), pointer mom_ocean_model_nuopc::ocean_state_type::forcing_csp => NULL()

A pointer to the MOM forcing control structure.

Definition at line 208 of file mom_ocean_model_nuopc.F90.

208  type(surface_forcing_CS), pointer :: &
209  forcing_CSp => null() !< A pointer to the MOM forcing control structure

◆ grid

type(ocean_grid_type), pointer mom_ocean_model_nuopc::ocean_state_type::grid => NULL()

A pointer to a grid structure containing metrics.

Definition at line 189 of file mom_ocean_model_nuopc.F90.

189  type(ocean_grid_type), pointer :: &
190  grid => null() !< A pointer to a grid structure containing metrics

◆ gv

type(verticalgrid_type), pointer mom_ocean_model_nuopc::ocean_state_type::gv => NULL()

A pointer to a structure containing information.

Definition at line 192 of file mom_ocean_model_nuopc.F90.

192  type(verticalGrid_type), pointer :: &
193  GV => null() !< A pointer to a structure containing information

◆ ice_shelf_csp

type(ice_shelf_cs), pointer mom_ocean_model_nuopc::ocean_state_type::ice_shelf_csp => NULL()

A pointer to the control structure for the.

Definition at line 199 of file mom_ocean_model_nuopc.F90.

199  type(ice_shelf_CS), pointer :: &
200  Ice_shelf_CSp => null() !< A pointer to the control structure for the

◆ icebergs_alter_ocean

logical mom_ocean_model_nuopc::ocean_state_type::icebergs_alter_ocean

If true, the icebergs can change ocean the ocean dynamics and forcing fluxes.

Definition at line 148 of file mom_ocean_model_nuopc.F90.

148  logical :: icebergs_alter_ocean !< If true, the icebergs can change ocean the

◆ is_ocean_pe

logical mom_ocean_model_nuopc::ocean_state_type::is_ocean_pe = .false.

True if this is an ocean PE.

Definition at line 135 of file mom_ocean_model_nuopc.F90.

135  logical :: is_ocean_PE = .false. !< True if this is an ocean PE.

◆ marine_ice_csp

type(marine_ice_cs), pointer mom_ocean_model_nuopc::ocean_state_type::marine_ice_csp => NULL()

A pointer to the control structure for the.

Definition at line 203 of file mom_ocean_model_nuopc.F90.

203  type(marine_ice_CS), pointer :: &
204  marine_ice_CSp => null() !< A pointer to the control structure for the

◆ mom_csp

type(mom_control_struct), pointer mom_ocean_model_nuopc::ocean_state_type::mom_csp => NULL()

A pointer to the MOM control structure.

Definition at line 197 of file mom_ocean_model_nuopc.F90.

197  type(MOM_control_struct), pointer :: &
198  MOM_CSp => null() !< A pointer to the MOM control structure

◆ nstep

integer mom_ocean_model_nuopc::ocean_state_type::nstep = 0

The number of calls to update_ocean.

Definition at line 144 of file mom_ocean_model_nuopc.F90.

144  integer :: nstep = 0 !< The number of calls to update_ocean.

◆ offline_tracer_mode

logical mom_ocean_model_nuopc::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 157 of file mom_ocean_model_nuopc.F90.

157  logical :: offline_tracer_mode = .false. !< If false, use the model in prognostic mode

◆ press_to_z

real mom_ocean_model_nuopc::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 154 of file mom_ocean_model_nuopc.F90.

154  real :: press_to_z !< A conversion factor between pressure and ocean

◆ restart_control

integer mom_ocean_model_nuopc::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 137 of file mom_ocean_model_nuopc.F90.

137  integer :: Restart_control !< An integer that is bit-tested to determine whether

◆ restart_csp

type(mom_restart_cs), pointer mom_ocean_model_nuopc::ocean_state_type::restart_csp => NULL()

A pointer set to the restart control structure.

Definition at line 210 of file mom_ocean_model_nuopc.F90.

210  type(MOM_restart_CS), pointer :: &
211  restart_CSp => null() !< A pointer set to the restart control structure

◆ restore_salinity

logical mom_ocean_model_nuopc::ocean_state_type::restore_salinity

If true, the coupled MOM driver adds a term to restore salinity to a specified value.

Definition at line 150 of file mom_ocean_model_nuopc.F90.

150  logical :: restore_salinity !< If true, the coupled MOM driver adds a term to

◆ restore_temp

logical mom_ocean_model_nuopc::ocean_state_type::restore_temp

If true, the coupled MOM driver adds a term to restore sst to a specified value.

Definition at line 152 of file mom_ocean_model_nuopc.F90.

152  logical :: restore_temp !< If true, the coupled MOM driver adds a term to

◆ sfc_state

type(surface) mom_ocean_model_nuopc::ocean_state_type::sfc_state

A structure containing pointers to the ocean surface state fields.

Definition at line 187 of file mom_ocean_model_nuopc.F90.

187  type(surface) :: sfc_state !< A structure containing pointers to

◆ single_step_call

logical mom_ocean_model_nuopc::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 165 of file mom_ocean_model_nuopc.F90.

165  logical :: single_step_call !< If true, advance the state of MOM with a single

◆ thermo_spans_coupling

logical mom_ocean_model_nuopc::ocean_state_type::thermo_spans_coupling

If true, thermodynamic and tracer time steps can span multiple coupled time steps.

Definition at line 172 of file mom_ocean_model_nuopc.F90.

172  logical :: thermo_spans_coupling !< If true, thermodynamic and tracer time

◆ time

type(time_type) mom_ocean_model_nuopc::ocean_state_type::time

The ocean model's time and master clock.

Definition at line 136 of file mom_ocean_model_nuopc.F90.

136  type(time_type) :: Time !< The ocean model's time and master clock.

◆ us

type(unit_scale_type), pointer mom_ocean_model_nuopc::ocean_state_type::us => NULL()

A pointer to a structure containing dimensional unit scaling factors.

Definition at line 195 of file mom_ocean_model_nuopc.F90.

195  type(unit_scale_type), pointer :: US => null() !< A pointer to a structure containing

◆ use_ice_shelf

logical mom_ocean_model_nuopc::ocean_state_type::use_ice_shelf

If true, the ice shelf model is enabled.

Definition at line 145 of file mom_ocean_model_nuopc.F90.

145  logical :: use_ice_shelf !< If true, the ice shelf model is enabled.

◆ use_waves

logical mom_ocean_model_nuopc::ocean_state_type::use_waves

If true use wave coupling.

Definition at line 146 of file mom_ocean_model_nuopc.F90.

146  logical :: use_waves !< If true use wave coupling.

◆ waves

type(wave_parameters_cs), pointer mom_ocean_model_nuopc::ocean_state_type::waves

A structure containing pointers to the surface wave fields.

Definition at line 206 of file mom_ocean_model_nuopc.F90.

206  type(wave_parameters_cs), pointer :: &
207  Waves !< A structure containing pointers to the surface wave fields

The documentation for this type was generated from the following file: