Explanation of entry points - modified 1 June 2011
- Entry point names in the dispersion-relation subroutines
- ENTRY SETDSP - This entry point is called only once, to do
some initializing. It then calls corresponding entry points in
some of the other model subroutines.
- ENTRY IDISPER - This entry point is called whenever new data
have been read into the w-array. It then calls corresponding
entry points in some of the other model subroutines. The output
is to common block /RIN/.
- ENTRY DISPER - This entry point is called whenever it is
necessary to calculate the dispersion relation (specifically, the
Hamiltonian and it's derivatives). It then calls corresponding
entry points in some of the other model subroutines. The output
is to common block /RIN/.
- ENTRY RINDEX - same as ENTRY DISPER (for compatibility with
earlier versions).
- Entry point names in the wind/current subroutines
- ENTRY SETWND - This entry point is called only once, to do
some initializing. It then calls corresponding entry points in
the wind/current perturbation model subroutine.
- ENTRY IWINDR - This entry point is called whenever new data
have been read into the w-array. It then calls corresponding
entry points in the wind/current perturbation model subroutine.
The output is to common block /UU/.
- ENTRY IWINDg(modug) - This entry point (for gravity-wave
models only) is called whenever new data have been read into the
w-array. It then calls corresponding entry points in the
wind/current perturbation model subroutine. The output is to the
calling sequence in addition to common block /UU/.
Although this entry point was mistakenly added to some wind models,
it is not actually needed.
- ENTRY WINDR - This entry point is called whenever it is
necessary to calculate the wind/current velocity and it's
derivatives. It then calls corresponding entry points in the
wind/current perturbation model subroutine. The output is to
common block /UU/.
- ENTRY WINDg(wind) - This entry point (for gravity-wave
models only) is called whenever it is necessary to calculate the
wind/current velocity and it's first and second derivatives. It
then calls corresponding entry points in the wind/current
perturbation model subroutine. The output is to the calling
sequence in addition to common block /UU/.
Although this entry point was mistakenly added to some wind models,
it is not actually needed.
- Entry point names in the sound-speed subroutines
- ENTRY SETSPD - This entry point is called only once, to do
some initializing. It then calls corresponding entry points in
some of the other model subroutines.
- ENTRY ISPEED - This entry point is called whenever new data
have been read into the w-array. It then calls corresponding
entry points in some of the other model subroutines. The output
is to common block /CC/.
- ENTRY SPEED - This entry point is called whenever it is
necessary to calculate the sound speed and it's derivatives. It
then calls corresponding entry points in some of the other model
subroutines and in the sound-speed perturbation subroutine. The
output is to common block /CC/.
- Entry point names in the temperature subroutines
- ENTRY SETTMP - This entry point is called only once, to do
some initializing. It then calls a corresponding entry point in
the temperature perturbation model subroutine.
- ENTRY ITEMP - This entry point is called whenever new data
have been read into the w-array. It then calls a corresponding
entry point in the temperature perturbation model subroutine.
The output is to common block /TT/.
- ENTRY ITEMPg(modtg) - This entry point (for gravity-wave
models only) is called whenever new data have been read into the
w-array. It then calls a corresponding entry point in the
temperature perturbation model subroutine. The output is to the
calling sequence in addition to common block /TT/.
- ENTRY TEMP - This entry point is called whenever it is
necessary to calculate the temperature and it's first
derivatives. It then calls a corresponding entry point in the
temperature perturbation model subroutine. The output is to
common block /TT/.
- ENTRY TEMPg(temperature) - This entry point is called
whenever it is necessary to calculate the temperature and it's
first and second derivatives. It then calls a corresponding
entry point in the temperature perturbation model subroutine.
This entry point was added when we added the gravity-wave
dispersion-relation model because temperature gradients are
required to calculate the Brunt-Väisälä frequency,
and then second derivatives of temperature are required to
calculate its gradient. The output is to the calling sequence
instead of to a common block. The temperature and its first
derivatives are also output to common block /TT/.
- Entry point names in the pressure subroutines
- ENTRY SETPRES - This entry point is called only once, to do
some initializing. It then calls a corresponding entry point in
the pressure perturbation model subroutine.
- ENTRY IPRES - This entry point (for acoustic-wave models
only) is called whenever new data have been read into the
w-array. It then calls a corresponding entry point in the
pressure perturbation model subroutine. The output is to common
block /PP/.
- ENTRY IPRESg(modpg) - This entry point (for gravity-wave
models only) is called whenever new data have been read into the
w-array. It then calls a corresponding entry point in the
pressure perturbation model subroutine. The output is to the
calling sequence in addition to common block /PP/.
- ENTRY PRES - This entry point (for acoustic-wave models
only) is called whenever it is necessary to calculate the
pressure and its first derivatives. This entry point is used
mostly to calculate the pressure for loss models with acoustic
waves. The output is to common block /PP/.
- ENTRY PRESg(pressure) - This entry point (for gravity-wave
models only) is called whenever it is necessary to calculate the
pressure and it's first and second derivatives. It then calls a
corresponding entry point in the pressure perturbation model
subroutine. The output is to the calling sequence instead of to
a common block. The pressure and its first derivatives are also
output to common block /PP/.
- Entry point names in the density subroutines
- ENTRY SETDENSITY - This entry point is called only once, to
do some initializing. It then calls a corresponding entry point
in the density perturbation model subroutine.
- ENTRY IDENSITY - This entry point (for acoustic-wave models
only) is called whenever new data have been read into the
w-array. It then calls a corresponding entry point in the
density perturbation model subroutine. The output is to common
block /DS/.
- ENTRY IDENSITYg(moddg) - This entry point (for gravity-wave
models only) is called whenever new data have been read into the
w-array. It then calls a corresponding entry point in the
density perturbation model subroutine. The output is to the
calling sequence in addition to common block /DS/.
- ENTRY DENSITYa - This entry point (for acoustic-wave models
only) is called whenever it is necessary to calculate the density
and its first derivatives. This entry point is used mostly to
calculate the pressure for loss models with acoustic waves. The
output is to common block /DS/.
- ENTRY DENSITYg(rho,potentialrho) - This entry point (for
gravity-wave models only) is called whenever it is necessary to
calculate the density and it's first and second derivatives. It
then calls a corresponding entry point in the density
perturbation model subroutine. A density model was added when we
added the gravity-wave dispersion-relation model to calculate the
Brunt-Väisälä frequency. The output is to the
calling sequence instead of to a common block. The density and
its first derivatives are also output to common block /DS/.
- ENTRY DENSITY(rho,potentialrho) - same as ENTRY
DENSITYg(rho,potentialrho) (for compatibility with earlier
versions).
- Entry point names in the gravity subroutines
- ENTRY SETGRAV - This entry point is called only once, to do
some initializing. It then calls a corresponding entry point in
the gravity perturbation model subroutine.
- ENTRY IGRAV - This entry point (for acoustic-wave models
only) is called whenever new data have been read into the
w-array. It then calls a corresponding entry point in the
gravity perturbation model subroutine. The output is to common
block /GV/.
- ENTRY IGRAVg(modgg) - This entry point (for gravity-wave
models only) is called whenever new data have been read into the
w-array. It then calls a corresponding entry point in the
gravity perturbation model subroutine. The output is to the
calling sequence in addition to common block /GV/.
- ENTRY GRAVa - This entry point (for acoustic-wave models
only) is called whenever it is necessary to calculate the
gravitational field and its first derivatives. This entry point
is used mostly to calculate the pressure for loss models with
acoustic waves. The output is to common block /GV/.
- ENTRY GRAVg(gravity) - This entry point (for gravity-wave
models only) is called whenever it is necessary to calculate the
gravitational field and it's first and second derivatives. It
then calls a corresponding entry point in the gravity
perturbation model subroutine. The output is to the calling
sequence instead of to a common block. The gravitational field
and its first derivatives are also output to common block /GV/.
- ENTRY GRAV(gravity) - same as ENTRY GRAVg(gravity) (for
compatibility with earlier versions).
- Entry points in the other models have similar names and
similar functions.