mom_unit_scaling Module Reference

Detailed Description

Provides a transparent unit rescaling type to facilitate dimensional consistency testing.

Data Types
type	unit_scale_type
	Describes various unit conversion factors. More...

Functions/Subroutines
subroutine, public	unit_scaling_init (param_file, US)
	Allocates and initializes the ocean model unit scaling type. More...
subroutine, public	fix_restart_unit_scaling (US)
	Set the unit scaling factors for output to restart files to the unit scaling factors for this run. More...
subroutine, public	unit_scaling_end (US)
	Deallocates a unit scaling structure. More...

Function/Subroutine Documentation

fix_restart_unit_scaling()

subroutine, public mom_unit_scaling::fix_restart_unit_scaling

(

type(unit_scale_type), intent(inout)

US

)

Set the unit scaling factors for output to restart files to the unit scaling factors for this run.

Parameters

[in,out]

us

A dimensional unit scaling type

Definition at line 172 of file MOM_unit_scaling.F90.

  type(unit_scale_type), intent(inout) :: US !< A dimensional unit scaling type
 
  us%m_to_Z_restart = us%m_to_Z
  us%m_to_L_restart = us%m_to_L
  us%s_to_T_restart = us%s_to_T
  us%kg_m3_to_R_restart = us%kg_m3_to_R
  us%J_kg_to_Q_restart = us%J_kg_to_Q
 

unit_scaling_end()

subroutine, public mom_unit_scaling::unit_scaling_end

(

type(unit_scale_type), pointer

US

)

Deallocates a unit scaling structure.

Parameters

us	A dimensional unit scaling type

Definition at line 184 of file MOM_unit_scaling.F90.

  type(unit_scale_type), pointer :: US !< A dimensional unit scaling type
 
  deallocate( us )
 

unit_scaling_init()

subroutine, public mom_unit_scaling::unit_scaling_init	(	type(param_file_type), intent(in), optional	param_file,
		type(unit_scale_type), optional, pointer	US
	)

Allocates and initializes the ocean model unit scaling type.

Parameters

[in]	param_file	Parameter file handle/type
	us	A dimensional unit scaling type

Definition at line 56 of file MOM_unit_scaling.F90.

  type(param_file_type), optional, intent(in) :: param_file !< Parameter file handle/type
  type(unit_scale_type), optional, pointer    :: US         !< A dimensional unit scaling type
 
  ! This routine initializes a unit_scale_type structure (US).
 
  ! Local variables
  integer :: Z_power, L_power, T_power, R_power, Q_power
  real    :: Z_rescale_factor, L_rescale_factor, T_rescale_factor, R_rescale_factor, Q_rescale_factor
  ! This include declares and sets the variable "version".
# include "version_variable.h"
  character(len=16) :: mdl = "MOM_unit_scaling"
 
  if (.not.present(us)) return
 
  if (associated(us)) call mom_error(fatal, &
     'unit_scaling_init: called with an associated US pointer.')
  allocate(us)
 
  if (present(param_file)) then
    ! Read all relevant parameters and write them to the model log.
    call log_version(param_file, mdl, version, &
                 "Parameters for doing unit scaling of variables.", debugging=.true.)
    call get_param(param_file, mdl, "Z_RESCALE_POWER", z_power, &
                 "An integer power of 2 that is used to rescale the model's "//&
                 "internal units of depths and heights.  Valid values range from -300 to 300.", &
                 units="nondim", default=0, debuggingparam=.true.)
    call get_param(param_file, mdl, "L_RESCALE_POWER", l_power, &
                 "An integer power of 2 that is used to rescale the model's "//&
                 "internal units of lateral distances.  Valid values range from -300 to 300.", &
                 units="nondim", default=0, debuggingparam=.true.)
    call get_param(param_file, mdl, "T_RESCALE_POWER", t_power, &
                 "An integer power of 2 that is used to rescale the model's "//&
                 "internal units of time.  Valid values range from -300 to 300.", &
                 units="nondim", default=0, debuggingparam=.true.)
    call get_param(param_file, mdl, "R_RESCALE_POWER", r_power, &
                 "An integer power of 2 that is used to rescale the model's "//&
                 "internal units of density.  Valid values range from -300 to 300.", &
                 units="nondim", default=0, debuggingparam=.true.)
    call get_param(param_file, mdl, "Q_RESCALE_POWER", q_power, &
                 "An integer power of 2 that is used to rescale the model's "//&
                   "internal units of heat content.  Valid values range from -300 to 300.", &
                   units="nondim", default=0, debuggingparam=.true.)
  else
    z_power = 0 ; l_power = 0 ; t_power = 0 ; r_power = 0 ; q_power = 0
  endif
 
  if (abs(z_power) > 300) call mom_error(fatal, "unit_scaling_init: "//&
                 "Z_RESCALE_POWER is outside of the valid range of -300 to 300.")
  if (abs(l_power) > 300) call mom_error(fatal, "unit_scaling_init: "//&
                 "L_RESCALE_POWER is outside of the valid range of -300 to 300.")
  if (abs(t_power) > 300) call mom_error(fatal, "unit_scaling_init: "//&
                 "T_RESCALE_POWER is outside of the valid range of -300 to 300.")
  if (abs(r_power) > 300) call mom_error(fatal, "unit_scaling_init: "//&
                 "R_RESCALE_POWER is outside of the valid range of -300 to 300.")
  if (abs(q_power) > 300) call mom_error(fatal, "unit_scaling_init: "//&
                 "Q_RESCALE_POWER is outside of the valid range of -300 to 300.")
 
  z_rescale_factor = 1.0
  if (z_power /= 0) z_rescale_factor = 2.0**z_power
  us%Z_to_m = 1.0 * z_rescale_factor
  us%m_to_Z = 1.0 / z_rescale_factor
 
  l_rescale_factor = 1.0
  if (l_power /= 0) l_rescale_factor = 2.0**l_power
  us%L_to_m = 1.0 * l_rescale_factor
  us%m_to_L = 1.0 / l_rescale_factor
 
  t_rescale_factor = 1.0
  if (t_power /= 0) t_rescale_factor = 2.0**t_power
  us%T_to_s = 1.0 * t_rescale_factor
  us%s_to_T = 1.0 / t_rescale_factor
 
  r_rescale_factor = 1.0
  if (r_power /= 0) r_rescale_factor = 2.0**r_power
  us%R_to_kg_m3 = 1.0 * r_rescale_factor
  us%kg_m3_to_R = 1.0 / r_rescale_factor
 
  q_rescale_factor = 1.0
  if (q_power /= 0) q_rescale_factor = 2.0**q_power
  us%Q_to_J_kg = 1.0 * q_rescale_factor
  us%J_kg_to_Q = 1.0 / q_rescale_factor
 
  ! These are useful combinations of the fundamental scale conversion factors set above.
  us%Z_to_L = us%Z_to_m * us%m_to_L
  us%L_to_Z = us%L_to_m * us%m_to_Z
  ! Horizontal velocities:
  us%L_T_to_m_s = us%L_to_m * us%s_to_T
  us%m_s_to_L_T = us%m_to_L * us%T_to_s
  ! Horizontal accelerations:
  us%L_T2_to_m_s2 = us%L_to_m * us%s_to_T**2
    ! It does not look like US%m_s2_to_L_T2 would be used, so it does not exist.
  ! Vertical diffusivities and viscosities:
  us%Z2_T_to_m2_s = us%Z_to_m**2 * us%s_to_T
  us%m2_s_to_Z2_T = us%m_to_Z**2 * us%T_to_s
  ! Column mass loads:
  us%RZ_to_kg_m2  = us%R_to_kg_m3 * us%Z_to_m
    ! It does not seem like US%kg_m2_to_RZ would be used enough in MOM6 to justify its existence.
  ! Vertical mass fluxes:
  us%kg_m2s_to_RZ_T = us%kg_m3_to_R * us%m_to_Z * us%T_to_s
  us%RZ_T_to_kg_m2s = us%R_to_kg_m3 * us%Z_to_m * us%s_to_T
  ! Turbulent kinetic energy vertical fluxes:
  us%RZ3_T3_to_W_m2 = us%R_to_kg_m3 * us%Z_to_m**3 * us%s_to_T**3
  us%W_m2_to_RZ3_T3 = us%kg_m3_to_R * us%m_to_Z**3 * us%T_to_s**3
  ! Vertical heat fluxes:
  us%W_m2_to_QRZ_T = us%J_kg_to_Q * us%kg_m3_to_R * us%m_to_Z * us%T_to_s
  us%QRZ_T_to_W_m2 = us%Q_to_J_kg * us%R_to_kg_m3 * us%Z_to_m * us%s_to_T
  ! Pressures:
  us%RL2_T2_to_Pa = us%R_to_kg_m3 * us%L_T_to_m_s**2
    ! It does not seem like US%Pa_to_RL2_T2 would be used enough in MOM6 to justify its existence.
  ! US%Pa_to_RL2_T2 = US%kg_m3_to_R * US%m_s_to_L_T**2