idealized_hurricane module reference¶

Forcing for the idealized hurricane and SCM_idealized_hurricane examples.

Data Types¶

idealized_hurricane_cs

Container for parameters describing idealized wind structure.

Functions/Subroutines¶

`idealized_hurricane_wind_init()`	Initializes wind profile for the SCM idealized hurricane example.
`idealized_hurricane_wind_forcing()`	Computes the surface wind for the idealized hurricane test cases.
`idealized_hurricane_wind_profile()`	Calculate the wind speed at a location as a function of time.
`scm_idealized_hurricane_wind_forcing()`	This subroutine is primarily needed as a legacy for reproducing answers.

Detailed Description¶

Forcing for the idealized hurricane and SCM_idealized_hurricane examples.

Type Documentation¶

type idealized_hurricane/idealized_hurricane_cs¶

Container for parameters describing idealized wind structure.

Type fields:

% rho_a [real] :: Mean air density [R ~> kg m-3].
% pressure_ambient [real] :: Pressure at surface of ambient air [R L2 T-2 ~> Pa].
% pressure_central [real] :: Pressure at surface at hurricane center [R L2 T-2 ~> Pa].
% rad_max_wind [real] :: Radius of maximum winds [L ~> m].
% max_windspeed [real] :: Maximum wind speeds [L T-1 ~> m s-1].
% hurr_translation_spd [real] :: Hurricane translation speed [L T-1 ~> m s-1].
% hurr_translation_dir [real] :: Hurricane translation direction [radians].
% gustiness [real] :: Gustiness (optional, used in u*) [R L Z T-2 ~> Pa].
% rho0 [real] :: A reference ocean density [R ~> kg m-3].
% hurr_cen_y0 [real] :: The initial y position of the hurricane This experiment is conducted in a Cartesian grid and this is assumed to be in meters [L ~> m].
% hurr_cen_x0 [real] :: The initial x position of the hurricane This experiment is conducted in a Cartesian grid and this is assumed to be in meters [L ~> m].
% holland_a [real] :: Parameter ‘A’ from the Holland formula [nondim].
% holland_b [real] :: Parameter ‘B’ from the Holland formula [nondim].
% holland_axbxdp [real] :: ‘A’ x ‘B’ x (Pressure Ambient-Pressure central) for the Holland prorfile calculation [R L2 T-2 ~> Pa]
% relative_tau [logical] :: A logical to take difference between wind and surface currents to compute the stress.
% answer_date [integer] :: The vintage of the expressions in the idealized hurricane test case. Values below 20190101 recover the answers from the end of 2018, while higher values use expressions that are rescalable and respect rotational symmetry.
% scm_mode [logical] :: If true this being used in Single Column Model mode.
% br_bench [logical] :: A “benchmark” configuration (which is meant to provide identical wind to reproduce a previous experiment, where that wind formula contained an error)
% dy_from_center [real] :: (Fixed) distance in y from storm center path [L ~> m]
% pi [real] :: Mathematical constant.
% deg2rad [real] :: Mathematical constant.

Function/Subroutine Documentation¶

subroutine idealized_hurricane/idealized_hurricane_wind_init(Time, G, US, param_file, CS)¶

Initializes wind profile for the SCM idealized hurricane example.

Parameters:

time :: [in] Model time
g :: [in] Grid structure
us :: [in] A dimensional unit scaling type
param_file :: [in] Input parameter structure
cs :: Parameter container for this module

Call to:

mdl mom_error_handler::mom_error

subroutine idealized_hurricane/idealized_hurricane_wind_forcing(sfc_state, forces, day, G, US, CS)¶

Computes the surface wind for the idealized hurricane test cases.

Parameters:

sfc_state :: [in] Surface state structure
forces :: [inout] A structure with the driving mechanical forces
day :: [in] Time in days
g :: [inout] Grid structure
us :: [in] A dimensional unit scaling type
cs :: Container for idealized hurricane parameters

Call to:

idealized_hurricane_wind_profile

subroutine idealized_hurricane/idealized_hurricane_wind_profile(CS, US, absf, YY, XX, UOCN, VOCN, Tx, Ty)¶

Calculate the wind speed at a location as a function of time.

Parameters:

cs :: Container for idealized hurricane parameters
us :: [in] A dimensional unit scaling type
absf :: [in] Input Coriolis magnitude [T-1 ~> s-1]
yy :: [in] Location in m relative to center y [L ~> m]
xx :: [in] Location in m relative to center x [L ~> m]
uocn :: [in] X surface current [L T-1 ~> m s-1]
vocn :: [in] Y surface current [L T-1 ~> m s-1]
tx :: [out] X stress [R L Z T-2 ~> Pa]
ty :: [out] Y stress [R L Z T-2 ~> Pa]

Called from:

idealized_hurricane_wind_forcing

subroutine idealized_hurricane/scm_idealized_hurricane_wind_forcing(sfc_state, forces, day, G, US, CS)¶

This subroutine is primarily needed as a legacy for reproducing answers. It is included as an additional subroutine rather than padded into the previous routine with flags to ease its eventual removal. Its functionality is replaced with the new routines and it can be deleted when answer changes are acceptable.

Parameters:

sfc_state :: [in] Surface state structure
forces :: [inout] A structure with the driving mechanical forces
day :: [in] Time in days
g :: [inout] Grid structure
us :: [in] A dimensional unit scaling type
cs :: Container for SCM parameters