Detailed Description

The control structure for the offline transport module.

Definition at line 46 of file MOM_offline_main.F90.

Collaboration diagram for mom_offline_main::offline_transport_cs:

Public variables and constants
type(ale_cs), pointer	ale_csp => NULL()
	A pointer to the ALE control structure. More...

type(diabatic_cs), pointer	diabatic_csp => NULL()
	A pointer to the diabatic control structure. More...

type(diag_ctrl), pointer	diag => NULL()
	Structure that regulates diagnostic output. More...

type(ocean_obc_type), pointer	obc => NULL()
	A pointer to the open boundary condition control structure. More...

type(tracer_advect_cs), pointer	tracer_adv_csp => NULL()
	A pointer to the tracer advection control structure. More...

type(opacity_cs), pointer	opacity_csp => NULL()
	A pointer to the opacity control structure. More...

type(tracer_flow_control_cs), pointer	tracer_flow_csp => NULL()
	A pointer to control structure that orchestrates the calling of tracer packages. More...

type(tracer_registry_type), pointer	tracer_reg => NULL()
	A pointer to the tracer registry. More...

type(thermo_var_ptrs), pointer	tv => NULL()
	A structure pointing to various thermodynamic variables. More...

type(ocean_grid_type), pointer	g => NULL()
	Pointer to a structure containing metrics and related information. More...

type(verticalgrid_type), pointer	gv => NULL()
	Pointer to structure containing information about the vertical grid. More...

type(unit_scale_type), pointer	us => NULL()
	structure containing various unit conversion factors More...

type(optics_type), pointer	optics => NULL()
	Pointer to the optical properties type. More...

type(diabatic_aux_cs), pointer	diabatic_aux_csp => NULL()
	Pointer to the diabatic_aux control structure. More...

integer	start_index
	Variables related to reading in fields from online run. More...

integer	iter_no
	Timelevel to start. More...

integer	numtime
	How many timelevels in the input fields. More...

integer	accumulated_time
	Length of time accumulated in the current offline interval. More...

integer	ridx_sum = -1
	Read index offset of the summed variables. More...

integer	ridx_snap = -1
	Read index offset of the snapshot variables. More...

integer	nk_input
	Number of input levels in the input fields. More...

character(len=200)	offlinedir
	Directory where offline fields are stored. More...

character(len=200)	surf_file
	Contains surface fields (2d arrays) More...

character(len=200)	snap_file
	Snapshotted fields (layer thicknesses) More...

character(len=200)	sum_file
	Fields which are accumulated over time. More...

character(len=200)	mean_file
	Fields averaged over time. More...

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 More...

character(len=20)	mld_var_name
	Name of the mixed layer depth variable to use. More...

logical	fields_are_offset
	True if the time-averaged fields and snapshot fields are offset by one time level. More...

logical	x_before_y
	Which horizontal direction is advected first. More...

logical	print_adv_offline
	Prints out some updates each advection sub interation. More...

logical	skip_diffusion
	Skips horizontal diffusion of tracers. More...

logical	read_sw
	Read in averaged values for shortwave radiation. More...

logical	read_mld
	Check to see whether mixed layer depths should be read in. More...

logical	diurnal_sw
	Adds a synthetic diurnal cycle on shortwave radiation. More...

logical	debug
	If true, write verbose debugging messages. More...

logical	redistribute_barotropic
	Redistributes column-summed residual transports throughout a column weighted by thickness. More...

logical	redistribute_upwards
	Redistributes remaining fluxes only in layers above the current one based as the max allowable transport in that cell. More...

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. More...

integer	num_off_iter
	Number of advection iterations per offline step. More...

integer	num_vert_iter
	Number of vertical iterations per offline step. More...

integer	off_ale_mod
	Sets how frequently the ALE step is done during the advection. More...

real	dt_offline
	Timestep used for offline tracers [T ~> s]. More...

real	dt_offline_vertical
	Timestep used for calls to tracer vertical physics [T ~> s]. More...

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. More...

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. More...

real	kd_max
	Runtime parameter specifying the maximum value of vertical diffusivity. More...

real	min_residual
	The minimum amount of total mass flux before exiting the main advection routine. More...


integer	id_uhr = -1
	Diagnostic manager IDs for some fields that may be of interest when doing offline transport. More...

integer	id_vhr = -1
	Diagnostic manager IDs for some fields that may be of interest when doing offline transport. More...

integer	id_ear = -1
	Diagnostic manager IDs for some fields that may be of interest when doing offline transport. More...

integer	id_ebr = -1
	Diagnostic manager IDs for some fields that may be of interest when doing offline transport. More...

integer	id_hr = -1
	Diagnostic manager IDs for some fields that may be of interest when doing offline transport. More...

integer	id_hdiff = -1
	Diagnostic manager IDs for some fields that may be of interest when doing offline transport. More...

integer	id_uhr_redist = -1
	Diagnostic manager IDs for some fields that may be of interest when doing offline transport. More...

integer	id_vhr_redist = -1
	Diagnostic manager IDs for some fields that may be of interest when doing offline transport. More...

integer	id_uhr_end = -1
	Diagnostic manager IDs for some fields that may be of interest when doing offline transport. More...

integer	id_vhr_end = -1
	Diagnostic manager IDs for some fields that may be of interest when doing offline transport. More...

integer	id_eta_pre_distribute = -1
	Diagnostic manager IDs for some fields that may be of interest when doing offline transport. More...

integer	id_eta_post_distribute = -1
	Diagnostic manager IDs for some fields that may be of interest when doing offline transport. More...

integer	id_h_redist = -1
	Diagnostic manager IDs for some fields that may be of interest when doing offline transport. More...

integer	id_eta_diff_end = -1
	Diagnostic manager IDs for some fields that may be of interest when doing offline transport. More...

integer	id_uhtr_regrid = -1
	Diagnostic manager IDs for some fields that may be of interest when doing offline transport. More...

integer	id_vhtr_regrid = -1
	Diagnostic manager IDs for some fields that may be of interest when doing offline transport. More...

integer	id_temp_regrid = -1
	Diagnostic manager IDs for some fields that may be of interest when doing offline transport. More...

integer	id_salt_regrid = -1
	Diagnostic manager IDs for some fields that may be of interest when doing offline transport. More...

integer	id_h_regrid = -1
	Diagnostic manager IDs for some fields that may be of interest when doing offline transport. More...

integer	id_clock_read_fields = -1
	A CPU time clock. More...

integer	id_clock_offline_diabatic = -1
	A CPU time clock. More...

integer	id_clock_offline_adv = -1
	A CPU time clock. More...

integer	id_clock_redistribute = -1
	A CPU time clock. More...

real, dimension(:,:,:), allocatable	uhtr
	Zonal transport that may need to be stored between calls to step_MOM. More...

real, dimension(:,:,:), allocatable	vhtr
	Meridional transport that may need to be stored between calls to step_MOM. More...

real, dimension(:,:,:), allocatable	eatr
	Amount of fluid entrained from the layer above within one time step [H ~> m or kg m-2]. More...

real, dimension(:,:,:), allocatable	ebtr
	Amount of fluid entrained from the layer below within one time step [H ~> m or kg m-2]. More...

real, dimension(:,:,:), allocatable	kd
	Vertical diffusivity. More...

real, dimension(:,:,:), allocatable	h_end
	Thicknesses at the end of offline timestep. More...

real, dimension(:,:), allocatable	netmassin
	Freshwater fluxes into the ocean. More...

real, dimension(:,:), allocatable	netmassout
	Freshwater fluxes out of the ocean. More...

real, dimension(:,:), allocatable	mld
	Mixed layer depths at thickness points [H ~> m or kg m-2]. More...

real, dimension(:,:,:,:), allocatable	uhtr_all
	Entire field of zonal transport. More...

real, dimension(:,:,:,:), allocatable	vhtr_all
	Entire field of mericional transport. More...

real, dimension(:,:,:,:), allocatable	hend_all
	Entire field of layer thicknesses. More...

real, dimension(:,:,:,:), allocatable	temp_all
	Entire field of temperatures. More...

real, dimension(:,:,:,:), allocatable	salt_all
	Entire field of salinities. More...

Variables and constants

◆ accumulated_time

integer mom_offline_main::offline_transport_cs::accumulated_time

Length of time accumulated in the current offline interval.

Definition at line 82 of file MOM_offline_main.F90.

82 integer :: accumulated_time !< Length of time accumulated in the current offline interval

◆ ale_csp

type(ale_cs), pointer mom_offline_main::offline_transport_cs::ale_csp => NULL()

A pointer to the ALE control structure.

Definition at line 49 of file MOM_offline_main.F90.

49 type(ALE_CS), pointer :: ALE_CSp => null()

◆ debug

logical mom_offline_main::offline_transport_cs::debug

If true, write verbose debugging messages.

Definition at line 107 of file MOM_offline_main.F90.

107 logical :: debug !< If true, write verbose debugging messages

◆ diabatic_aux_csp

type(diabatic_aux_cs), pointer mom_offline_main::offline_transport_cs::diabatic_aux_csp => NULL()

Pointer to the diabatic_aux control structure.

Definition at line 75 of file MOM_offline_main.F90.

75 type(diabatic_aux_CS), pointer :: diabatic_aux_CSp => null()

◆ diabatic_csp

type(diabatic_cs), pointer mom_offline_main::offline_transport_cs::diabatic_csp => NULL()

A pointer to the diabatic control structure.

Definition at line 51 of file MOM_offline_main.F90.

51 type(diabatic_CS), pointer :: diabatic_CSp => null()

◆ diag

type(diag_ctrl), pointer mom_offline_main::offline_transport_cs::diag => NULL()

Structure that regulates diagnostic output.

Definition at line 53 of file MOM_offline_main.F90.

53 type(diag_ctrl), pointer :: diag => null()

◆ diurnal_sw

logical mom_offline_main::offline_transport_cs::diurnal_sw

Adds a synthetic diurnal cycle on shortwave radiation.

Definition at line 106 of file MOM_offline_main.F90.

106 logical :: diurnal_sw !< Adds a synthetic diurnal cycle on shortwave radiation

◆ dt_offline

real mom_offline_main::offline_transport_cs::dt_offline

Timestep used for offline tracers [T ~> s].

Definition at line 119 of file MOM_offline_main.F90.

119 real :: dt_offline !< Timestep used for offline tracers [T ~> s]

◆ dt_offline_vertical

real mom_offline_main::offline_transport_cs::dt_offline_vertical

Timestep used for calls to tracer vertical physics [T ~> s].

Definition at line 120 of file MOM_offline_main.F90.

120 real :: dt_offline_vertical !< Timestep used for calls to tracer vertical physics [T ~> s]

◆ eatr

real, dimension(:,:,:), allocatable mom_offline_main::offline_transport_cs::eatr

Amount of fluid entrained from the layer above within one time step [H ~> m or kg m-2].

Definition at line 167 of file MOM_offline_main.F90.

167 real, allocatable, dimension(:,:,:) :: eatr

◆ ebtr

real, dimension(:,:,:), allocatable mom_offline_main::offline_transport_cs::ebtr

Amount of fluid entrained from the layer below within one time step [H ~> m or kg m-2].

Definition at line 170 of file MOM_offline_main.F90.

170 real, allocatable, dimension(:,:,:) :: ebtr

◆ evap_cfl_limit

real mom_offline_main::offline_transport_cs::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.

Definition at line 121 of file MOM_offline_main.F90.

121 real :: evap_CFL_limit !< Limit on the fraction of the water that can be fluxed out of the top

◆ fields_are_offset

logical mom_offline_main::offline_transport_cs::fields_are_offset

True if the time-averaged fields and snapshot fields are offset by one time level.

Definition at line 99 of file MOM_offline_main.F90.

99 logical :: fields_are_offset !< True if the time-averaged fields and snapshot fields are

◆ g

type(ocean_grid_type), pointer mom_offline_main::offline_transport_cs::g => NULL()

Pointer to a structure containing metrics and related information.

Definition at line 67 of file MOM_offline_main.F90.

67 type(ocean_grid_type), pointer :: G => null()

◆ gv

type(verticalgrid_type), pointer mom_offline_main::offline_transport_cs::gv => NULL()

Pointer to structure containing information about the vertical grid.

Definition at line 69 of file MOM_offline_main.F90.

69 type(verticalGrid_type), pointer :: GV => null()

◆ h_end

real, dimension(:,:,:), allocatable mom_offline_main::offline_transport_cs::h_end

Thicknesses at the end of offline timestep.

Definition at line 175 of file MOM_offline_main.F90.

175 real, allocatable, dimension(:,:,:) :: h_end !< Thicknesses at the end of offline timestep

◆ hend_all

real, dimension(:,:,:,:), allocatable mom_offline_main::offline_transport_cs::hend_all

Entire field of layer thicknesses.

Definition at line 184 of file MOM_offline_main.F90.

184 real, allocatable, dimension(:,:,:,:) :: hend_all !< Entire field of layer thicknesses

◆ id_clock_offline_adv

integer mom_offline_main::offline_transport_cs::id_clock_offline_adv = -1

A CPU time clock.

Definition at line 158 of file MOM_offline_main.F90.

158 integer :: id_clock_offline_adv = -1 !< A CPU time clock

◆ id_clock_offline_diabatic

integer mom_offline_main::offline_transport_cs::id_clock_offline_diabatic = -1

A CPU time clock.

Definition at line 157 of file MOM_offline_main.F90.

157 integer :: id_clock_offline_diabatic = -1 !< A CPU time clock

◆ id_clock_read_fields

integer mom_offline_main::offline_transport_cs::id_clock_read_fields = -1

A CPU time clock.

Definition at line 156 of file MOM_offline_main.F90.

156 integer :: id_clock_read_fields = -1 !< A CPU time clock

◆ id_clock_redistribute

integer mom_offline_main::offline_transport_cs::id_clock_redistribute = -1

A CPU time clock.

Definition at line 159 of file MOM_offline_main.F90.

159 integer :: id_clock_redistribute = -1 !< A CPU time clock