namespace idealized_hurricane¶

Overview¶

Forcing for the idealized hurricane and SCM_idealized_hurricane examples. More…

namespace idealized_hurricane {

// global variables

character(len=40) mdl = "idealized_hurricane";

// global functions

subroutine, public idealized_hurricane_wind_init(Time Time, G G, param_file param_file, CS CS);
subroutine, public idealized_hurricane_wind_forcing(state state, forces forces, day day, G G, US US, CS CS);
subroutine, public scm_idealized_hurricane_wind_forcing(state state, forces forces, day day, G G, US US, CS CS);

} // namespace idealized_hurricane

Detailed Documentation¶

Forcing for the idealized hurricane and SCM_idealized_hurricane examples.

Global Variables¶

character(len=40) mdl = "idealized_hurricane"

This module’s name.

Global Functions¶

subroutine, public idealized_hurricane_wind_init(
    Time Time,
    G G,
    param_file param_file,
    CS CS
    )

Initializes wind profile for the SCM idealized hurricane example.

Parameters:

time	Model time
g	Grid structure
param_file	Input parameter structure
cs	Parameter container

subroutine, public idealized_hurricane_wind_forcing(
    state state,
    forces forces,
    day day,
    G G,
    US US,
    CS CS
    )

Computes the surface wind for the idealized hurricane test cases.

Parameters:

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

subroutine, public scm_idealized_hurricane_wind_forcing(
    state state,
    forces forces,
    day day,
    G G,
    US US,
    CS 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:

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