MOM6
mom_offline_main::offline_transport_cs Type Reference

Detailed Description

The control structure for the offline transport module.

Definition at line 45 of file MOM_offline_main.F90.

Collaboration diagram for mom_offline_main::offline_transport_cs:
[legend]

Public variables and constants

type(ale_cs), pointer ale_csp => NULL()
 A pointer to the ALE control structure.
 
type(diabatic_cs), pointer diabatic_csp => NULL()
 A pointer to the diabatic control structure.
 
type(diag_ctrl), pointer diag => NULL()
 Structure that regulates diagnostic output.
 
type(ocean_obc_type), pointer obc => NULL()
 A pointer to the open boundary condition control structure.
 
type(tracer_advect_cs), pointer tracer_adv_csp => NULL()
 A pointer to the tracer advection control structure.
 
type(opacity_cs), pointer opacity_csp => NULL()
 A pointer to the opacity control structure.
 
type(tracer_flow_control_cs), pointer tracer_flow_csp => NULL()
 A pointer to control structure that orchestrates the calling of tracer packages.
 
type(tracer_registry_type), pointer tracer_reg => NULL()
 A pointer to the tracer registry.
 
type(thermo_var_ptrs), pointer tv => NULL()
 A structure pointing to various thermodynamic variables.
 
type(ocean_grid_type), pointer g => NULL()
 Pointer to a structure containing metrics and related information.
 
type(verticalgrid_type), pointer gv => NULL()
 Pointer to structure containing information about the vertical grid.
 
type(unit_scale_type), pointer us => NULL()
 structure containing various unit conversion factors
 
type(optics_type), pointer optics => NULL()
 Pointer to the optical properties type.
 
type(diabatic_aux_cs), pointer diabatic_aux_csp => NULL()
 Pointer to the diabatic_aux control structure.
 
integer start_index
 Variables related to reading in fields from online run. More...
 
integer iter_no
 Timelevel to start.
 
integer numtime
 How many timelevels in the input fields.
 
type(time_type) accumulated_time
 Length of time accumulated in the current offline interval.
 
type(time_type) vertical_time
 The next value of accumulate_time at which to apply vertical processes.
 
integer ridx_sum = -1
 Read index offset of the summed variables.
 
integer ridx_snap = -1
 Read index offset of the snapshot variables.
 
integer nk_input
 Number of input levels in the input fields.
 
character(len=200) offlinedir
 Directory where offline fields are stored.
 
character(len=200) surf_file
 Contains surface fields (2d arrays)
 
character(len=200) snap_file
 Snapshotted fields (layer thicknesses)
 
character(len=200) sum_file
 Fields which are accumulated over time.
 
character(len=200) mean_file
 Fields averaged over time.
 
character(len=20) redistribute_method
 'barotropic' if evenly distributing extra flow throughout entire watercolumn, 'upwards', if trying to do it just in the layers above 'both' if both methods are used
 
character(len=20) mld_var_name
 Name of the mixed layer depth variable to use.
 
logical fields_are_offset
 True if the time-averaged fields and snapshot fields are offset by one time level.
 
logical x_before_y
 Which horizontal direction is advected first.
 
logical print_adv_offline
 Prints out some updates each advection sub interation.
 
logical skip_diffusion
 Skips horizontal diffusion of tracers.
 
logical read_sw
 Read in averaged values for shortwave radiation.
 
logical read_mld
 Check to see whether mixed layer depths should be read in.
 
logical diurnal_sw
 Adds a synthetic diurnal cycle on shortwave radiation.
 
logical debug
 If true, write verbose debugging messages.
 
logical redistribute_barotropic
 Redistributes column-summed residual transports throughout a column weighted by thickness.
 
logical redistribute_upwards
 Redistributes remaining fluxes only in layers above the current one based as the max allowable transport in that cell.
 
logical read_all_ts_uvh
 If true, then all timelevels of temperature, salinity, mass transports, and Layer thicknesses are read during initialization Variables controlling some of the numerical considerations of offline transport.
 
integer num_off_iter
 Number of advection iterations per offline step.
 
integer num_vert_iter
 Number of vertical iterations per offline step.
 
integer off_ale_mod
 Sets how frequently the ALE step is done during the advection.
 
real dt_offline
 Timestep used for offline tracers [T ~> s].
 
real dt_offline_vertical
 Timestep used for calls to tracer vertical physics [T ~> s].
 
real evap_cfl_limit
 Limit on the fraction of the water that can be fluxed out of the top layer in a timestep [nondim]. This is Copied from diabatic_CS controlling how tracers follow freshwater fluxes.
 
real minimum_forcing_depth
 The smallest depth over which fluxes can be applied [H ~> m or kg m-2]. This is copied from diabatic_CS controlling how tracers follow freshwater fluxes.
 
real kd_max
 Runtime parameter specifying the maximum value of vertical diffusivity.
 
real min_residual
 The minimum amount of total mass flux before exiting the main advection routine.
 
integer id_clock_read_fields = -1
 A CPU time clock.
 
integer id_clock_offline_diabatic = -1
 A CPU time clock.
 
integer id_clock_offline_adv = -1
 A CPU time clock.
 
integer id_clock_redistribute = -1
 A CPU time clock.
 
real, dimension(:,:,:), allocatable uhtr
 Zonal transport that may need to be stored between calls to step_MOM.
 
real, dimension(:,:,:), allocatable vhtr
 Meridional transport that may need to be stored between calls to step_MOM.
 
real, dimension(:,:,:), allocatable eatr
 Amount of fluid entrained from the layer above within one time step [H ~> m or kg m-2].
 
real, dimension(:,:,:), allocatable ebtr
 Amount of fluid entrained from the layer below within one time step [H ~> m or kg m-2].
 
real, dimension(:,:,:), allocatable kd
 Vertical diffusivity.
 
real, dimension(:,:,:), allocatable h_end
 Thicknesses at the end of offline timestep.
 
real, dimension(:,:), allocatable netmassin
 Freshwater fluxes into the ocean.
 
real, dimension(:,:), allocatable netmassout
 Freshwater fluxes out of the ocean.
 
real, dimension(:,:), allocatable mld
 Mixed layer depths at thickness points [Z ~> m].
 
real, dimension(:,:,:,:), allocatable uhtr_all
 Entire field of zonal transport.
 
real, dimension(:,:,:,:), allocatable vhtr_all
 Entire field of mericional transport.
 
real, dimension(:,:,:,:), allocatable hend_all
 Entire field of layer thicknesses.
 
real, dimension(:,:,:,:), allocatable temp_all
 Entire field of temperatures.
 
real, dimension(:,:,:,:), allocatable salt_all
 Entire field of salinities.
 
integer id_uhr = -1
 Diagnostic manager IDs for some fields that may be of interest when doing offline transport.
 
integer id_vhr = -1
 Diagnostic manager IDs for some fields that may be of interest when doing offline transport.
 
integer id_ear = -1
 Diagnostic manager IDs for some fields that may be of interest when doing offline transport.
 
integer id_ebr = -1
 Diagnostic manager IDs for some fields that may be of interest when doing offline transport.
 
integer id_hr = -1
 Diagnostic manager IDs for some fields that may be of interest when doing offline transport.
 
integer id_hdiff = -1
 Diagnostic manager IDs for some fields that may be of interest when doing offline transport.
 
integer id_uhr_redist = -1
 Diagnostic manager IDs for some fields that may be of interest when doing offline transport.
 
integer id_vhr_redist = -1
 Diagnostic manager IDs for some fields that may be of interest when doing offline transport.
 
integer id_uhr_end = -1
 Diagnostic manager IDs for some fields that may be of interest when doing offline transport.
 
integer id_vhr_end = -1
 Diagnostic manager IDs for some fields that may be of interest when doing offline transport.
 
integer id_eta_pre_distribute = -1
 Diagnostic manager IDs for some fields that may be of interest when doing offline transport.
 
integer id_eta_post_distribute = -1
 Diagnostic manager IDs for some fields that may be of interest when doing offline transport.
 
integer id_h_redist = -1
 Diagnostic manager IDs for some fields that may be of interest when doing offline transport.
 
integer id_eta_diff_end = -1
 Diagnostic manager IDs for some fields that may be of interest when doing offline transport.
 
integer id_uhtr_regrid = -1
 Diagnostic manager IDs for some fields that may be of interest when doing offline transport.
 
integer id_vhtr_regrid = -1
 Diagnostic manager IDs for some fields that may be of interest when doing offline transport.
 
integer id_temp_regrid = -1
 Diagnostic manager IDs for some fields that may be of interest when doing offline transport.
 
integer id_salt_regrid = -1
 Diagnostic manager IDs for some fields that may be of interest when doing offline transport.
 
integer id_h_regrid = -1
 Diagnostic manager IDs for some fields that may be of interest when doing offline transport.
 

Detailed Description

The control structure for the offline transport module.

Definition at line 45 of file MOM_offline_main.F90.

Variables and constants

◆ start_index

integer mom_offline_main::offline_transport_cs::start_index

Variables related to reading in fields from online run.

Timelevel to start

Definition at line 78 of file MOM_offline_main.F90.

78  integer :: start_index !< Timelevel to start

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