mom_tidal_forcing mom_tidal_forcing::astro_longitudes mom_tidal_forcing::tidal_forcing_cs integer, parameter integer, parameter mom_tidal_forcing::max_constituents max_constituents = 10 The maximum number of tidal constituents that could be used. tidal_forcing_init integer integer mom_tidal_forcing::id_clock_tides id_clock_tides CPU clock for tides. calc_tidal_forcing tidal_forcing_init subroutine, public subroutine, public mom_tidal_forcing::astro_longitudes_init (time_ref, longitudes) astro_longitudes_init time_ref time_ref longitudes longitudes Finds astronomical longitudes s, h, p, and N, the mean longitude of the moon, sun, lunar perigee, and ascending node, respectively, at the specified reference time time_ref. These formulas were obtained from Kowalik and Luick, "Modern Theory and Practice of Tide Analysis and Tidal Power", 2019 (their Equation I.71), which are based on Schureman, 1958. For simplicity, the time associated with time_ref should be at midnight. These formulas also only make sense if the calendar is gregorian. mom_open_boundary::initialize_obc_tides tidal_forcing_init real function, public real function, public mom_tidal_forcing::eq_phase (constit, longitudes) eq_phase constit constit longitudes longitudes Calculates the equilibrium phase argument for the given tidal constituent constit and the astronomical longitudes and the reference time. These formulas follow Table I.4 of Kowalik and Luick, "Modern Theory and Practice of Tide Analysis and Tidal Power", 2019. mom_error_handler::mom_error mom_open_boundary::initialize_obc_tides tidal_forcing_init real function, public real function, public mom_tidal_forcing::tidal_frequency (constit) tidal_frequency constit constit Looks up angular frequencies for the main tidal constituents. Values used here are from previous versions of MOM. mom_error_handler::mom_error mom_open_boundary::initialize_obc_tides tidal_forcing_init subroutine, public subroutine, public mom_tidal_forcing::nodal_fu (constit, N, fn, un) nodal_fu constit constit N N fn fn un un Find amplitude (f) and phase (u) modulation of tidal constituents by the 18.6 year nodal cycle. Values here follow Table I.6 in Kowalik and Luick, "Modern Theory and Practice of Tide Analysis and Tidal Power", 2019. mom_error_handler::mom_error mom_open_boundary::initialize_obc_tides subroutine, public subroutine, public mom_tidal_forcing::tidal_forcing_init (Time, G, param_file, CS) tidal_forcing_init Time Time G G param_file param_file CS CS This subroutine allocates space for the static variables used by this module. The metrics may be effectively 0, 1, or 2-D arrays, while fields like the background viscosities are 2-D arrays. ALLOC is a macro defined in MOM_memory.h for allocate or nothing with static memory. time The current model time. g The ocean's grid structure. param_file A structure to parse for run-time parameters. cs A pointer that is set to point to the control structure for this module. astro_longitudes_init mom_cpu_clock::cpu_clock_id eq_phase find_in_files id_clock_tides max_constituents mom_error_handler::mom_error mom_error_handler::mom_mesg tidal_frequency subroutine subroutine mom_tidal_forcing::find_in_files (filenames, varname, array, G) find_in_files filenames filenames varname varname array array G G This subroutine finds a named variable in a list of files and reads its values into a domain-decomposed 2-d array. filenames The names of the files to search for the named variable varname The name of the variable to read g The ocean's grid structure array The array to fill with the data mom_error_handler::mom_error tidal_forcing_init subroutine, public subroutine, public mom_tidal_forcing::tidal_forcing_sensitivity (G, CS, deta_tidal_deta) tidal_forcing_sensitivity G G CS CS deta_tidal_deta deta_tidal_deta This subroutine calculates returns the partial derivative of the local geopotential height with the input sea surface height due to self-attraction and loading. g The ocean's grid structure. cs The control structure returned by a previous call to tidal_forcing_init. deta_tidal_deta The partial derivative of eta_tidal with the local value of eta [nondim]. mom_barotropic::btstep mom_barotropic::set_dtbt subroutine, public subroutine, public mom_tidal_forcing::calc_tidal_forcing (Time, eta, eta_tidal, G, CS, deta_tidal_deta, m_to_Z) calc_tidal_forcing Time Time eta eta eta_tidal eta_tidal G G CS CS deta_tidal_deta deta_tidal_deta m_to_Z m_to_Z This subroutine calculates the geopotential anomalies that drive the tides, including self-attraction and loading. Optionally, it also returns the partial derivative of the local geopotential height with the input sea surface height. For now, eta and eta_tidal are both geopotential heights in depth units, but probably the input for eta should really be replaced with the column mass anomalies. g The ocean's grid structure. time The time for the caluculation. eta The sea surface height anomaly from a time-mean geoid [Z ~> m]. eta_tidal The tidal forcing geopotential height anomalies [Z ~> m]. cs The control structure returned by a previous call to tidal_forcing_init. deta_tidal_deta The partial derivative of eta_tidal with the local value of eta [nondim]. m_to_z A scaling factor from m to the units of eta. id_clock_tides mom_pressureforce_fv::pressureforce_fv_bouss mom_pressureforce_fv::pressureforce_fv_nonbouss mom_pressureforce_mont::pressureforce_mont_bouss mom_pressureforce_mont::pressureforce_mont_nonbouss subroutine, public subroutine, public mom_tidal_forcing::tidal_forcing_end (CS) tidal_forcing_end CS CS This subroutine deallocates memory associated with the tidal forcing module. cs The control structure returned by a previous call to tidal_forcing_init; it is deallocated here. Tidal contributions to geopotential.