Warning, /doc/phys_pkgs/sun.rst is written in an unsupported language. File is not indexed.
view on githubraw file Latest commit faa67d17 on 2022-01-31 17:00:48 UTC
faa67d1773 Oliv*0001 .. include:: ../defs.hrst
0002
0003 .. _sub_phys_pkg_sun:
0004
0005 SUN package
0006 -----------
0007
0008 Introduction
0009 ~~~~~~~~~~~~
0010
0011 The :filelink:`sun package <pkg/sun>` computes the solar zenith angle above the
0012 sea surface for all grid center locations. The computation follows Patt and
0013 Gregg (1994) :cite:`patt:1994`. The code has been adapted from the
0014 `Ocean-Atmosphere Spectral Irradiance Model (OASIM)
0015 <https://gmao.gsfc.nasa.gov/research/oceanbiology/software.php>`_.
0016
0017
0018 Compiling and Running
0019 ~~~~~~~~~~~~~~~~~~~~~
0020
0021 Include the word ``sun`` in ``packages.conf`` in your code directory.
0022 This will automatically include the :ref:`cal package <sub_phys_pkg_cal>`.
0023
0024 This is a utility package that does not have compile or runtime configuration
0025 options. It needs to be called by another package in order to do anything
0026 useful.
0027
0028
0029 Subroutines
0030 ~~~~~~~~~~~
0031
0032 .. csv-table::
0033 :delim: &
0034 :widths: auto
0035
0036 sun_init_varia & creates arrays of up, north, and east vectors
0037 sun_sfcsolz & computes solar zenith angle above the sea surface
0038 sun_jd & converts calendar date to Julian day
0039 sun_ephparms & computes ephemeris parameters
0040 sun_nutate & computes the nutation in longitude and the obliquity
0041 sun_sun2000 & computes the sun vector in geocentric inertial coordinates
0042 sun_gha2000 & computes the Greenwich hour angle in degrees
0043
0044
0045 Call tree
0046 ~~~~~~~~~
0047
0048 ::
0049
0050 the_model_main
0051 the_main_loop
0052 initialise_varia
0053 packages_init_variables
0054 sun_init_varia
0055 main_do_loop
0056 forward_step
0057 gchem_forcing_sep
0058 darwin_forcing
0059 darwin_light_radtrans
0060 radtrans_calc
0061 sun_sfcsolz
0062 sun_ephparms
0063 sun_nutate
0064 sun_sun2000
0065 sun_gha2000
0066 sun_jd
