FV3 Bundle
Private Member Functions | List of all members
astronomy_mod::diurnal_solar Interface Reference

Private Member Functions

subroutine diurnal_solar_2d (lat, lon, gmt, time_since_ae, cosz, fracday, rrsun, dt, allow_negative_cosz, half_day_out)
 diurnal_solar_2d returns 2d fields of cosine of zenith angle, daylight fraction and earth-sun distance at the specified latitudes, longitudes and time. These values may be instantaneous or averaged over a specified time interval. More...
 
subroutine diurnal_solar_1d (lat, lon, gmt, time_since_ae, cosz, fracday, rrsun, dt, allow_negative_cosz, half_day_out)
 diurnal_solar_1d takes 1-d input fields, adds a second dimension and calls diurnal_solar_2d. on return, the 2d fields are returned to the original 1d fields. More...
 
subroutine diurnal_solar_0d (lat, lon, gmt, time_since_ae, cosz, fracday, rrsun, dt, allow_negative_cosz, half_day_out)
 diurnal_solar_0d takes scalar input fields, makes them into 2d arrays dimensioned (1,1), and calls diurnal_solar_2d. on return, the 2d fields are converted back to the desired scalar output. More...
 
subroutine diurnal_solar_cal_2d (lat, lon, time, cosz, fracday, rrsun, dt_time, allow_negative_cosz, half_day_out)
 diurnal_solar_cal_2d receives time_type inputs, converts them to real variables and then calls diurnal_solar_2d to compute desired astronomical variables. More...
 
subroutine diurnal_solar_cal_1d (lat, lon, time, cosz, fracday, rrsun, dt_time, allow_negative_cosz, half_day_out)
 diurnal_solar_cal_1d receives time_type inputs, converts them to real variables and then calls diurnal_solar_2d to compute desired astronomical variables. More...
 
subroutine diurnal_solar_cal_0d (lat, lon, time, cosz, fracday, rrsun, dt_time, allow_negative_cosz, half_day_out)
 diurnal_solar_cal_0d receives time_type inputs, converts them to real variables and then calls diurnal_solar_2d to compute desired astronomical variables. More...
 

Detailed Description

Definition at line 161 of file astronomy.F90.

Member Function/Subroutine Documentation

◆ diurnal_solar_0d()

subroutine astronomy_mod::diurnal_solar::diurnal_solar_0d ( real, intent(in)  lat,
real, intent(in)  lon,
real, intent(in)  gmt,
real, intent(in)  time_since_ae,
real, intent(out)  cosz,
real, intent(out)  fracday,
real, intent(out)  rrsun,
real, intent(in), optional  dt,
logical, intent(in), optional  allow_negative_cosz,
real, intent(out), optional  half_day_out 
)
private

diurnal_solar_0d takes scalar input fields, makes them into 2d arrays dimensioned (1,1), and calls diurnal_solar_2d. on return, the 2d fields are converted back to the desired scalar output.

Parameters
[in]<lat>Latitudes of model grid points
[in]<lon>Longitudes of model grid points
[in]<gmt>Time of day at longitude 0.0; midnight = 0.0, one day = 2 * pi
[in]<time_since_ae>Time of year; autumnal equinox = 0.0, one year = 2 * pi
[out]<cosz>Cosine of solar zenith angle
[out]<fracday>Daylight fraction of time interval
[out]<rrsun>earth-sun distance (r) relative to semi-major axis of orbital ellipse (a):(a/r)**2
[in]<dt>OPTIONAL: time interval after gmt over which the astronomical variables are to be averaged. this produces averaged output rather than instantaneous.
[in]<allow_negative_cosz>Allow negative values for cosz?
[out]<half_day_out>half_day_out

Definition at line 1130 of file astronomy.F90.

◆ diurnal_solar_1d()

subroutine astronomy_mod::diurnal_solar::diurnal_solar_1d ( real, dimension(:), intent(in)  lat,
real, dimension(:), intent(in)  lon,
real, intent(in)  gmt,
real, intent(in)  time_since_ae,
real, dimension(:), intent(out)  cosz,
real, dimension(:), intent(out)  fracday,
real, intent(out)  rrsun,
real, intent(in), optional  dt,
logical, intent(in), optional  allow_negative_cosz,
real, dimension(:), intent(out), optional  half_day_out 
)
private

diurnal_solar_1d takes 1-d input fields, adds a second dimension and calls diurnal_solar_2d. on return, the 2d fields are returned to the original 1d fields.

Parameters
[in]<lat>Latitudes of model grid points
[in]<lon>Longitudes of model grid points
[in]<gmt>Time of day at longitude 0.0; midnight = 0.0, one day = 2 * pi
[in]<time_since_ae>Time of year; autumnal equinox = 0.0, one year = 2 * pi
[out]<cosz>Cosine of solar zenith angle
[out]<fracday>Daylight fraction of time interval
[out]<rrsun>earth-sun distance (r) relative to semi-major axis of orbital ellipse (a):(a/r)**2
[in]<dt>OPTIONAL: time interval after gmt over which the astronomical variables are to be averaged. this produces averaged output rather than instantaneous.
[in]<allow_negative_cosz>Allow negative values for cosz?
[out]<half_day_out>half_day_out

Definition at line 1064 of file astronomy.F90.

◆ diurnal_solar_2d()

subroutine astronomy_mod::diurnal_solar::diurnal_solar_2d ( real, dimension(:,:), intent(in)  lat,
real, dimension(:,:), intent(in)  lon,
real, intent(in)  gmt,
real, intent(in)  time_since_ae,
real, dimension(:,:), intent(out)  cosz,
real, dimension(:,:), intent(out)  fracday,
real, intent(out)  rrsun,
real, intent(in), optional  dt,
logical, intent(in), optional  allow_negative_cosz,
real, dimension(:,:), intent(out), optional  half_day_out 
)
private

diurnal_solar_2d returns 2d fields of cosine of zenith angle, daylight fraction and earth-sun distance at the specified latitudes, longitudes and time. These values may be instantaneous or averaged over a specified time interval.

Parameters
[in]<lat>Latitudes of model grid points
[in]<lon>Longitudes of model grid points
[in]<gmt>Time of day at longitude 0.0; midnight = 0.0, one day = 2 * pi
[in]<time_since_ae>Time of year; autumnal equinox = 0.0, one year = 2 * pi
[out]<cosz>Cosine of solar zenith angle
[out]<fracday>Daylight fraction of time interval
[out]<rrsun>earth-sun distance (r) relative to semi-major axis of orbital ellipse (a):(a/r)**2
[in]<dt>OPTIONAL: time interval after gmt over which the astronomical variables are to be averaged. this produces averaged output rather than instantaneous.
[in]<allow_negative_cosz>Allow negative values for cosz?
[out]<half_day_out>half_day_out
Exceptions
FATAL,astronomy_mod time_since_ae not between 0 and 2pi
FATAL,astronomy_mod gmt not between 0 and 2pi

Definition at line 841 of file astronomy.F90.

◆ diurnal_solar_cal_0d()

subroutine astronomy_mod::diurnal_solar::diurnal_solar_cal_0d ( real, intent(in)  lat,
real, intent(in)  lon,
type(time_type), intent(in)  time,
real, intent(out)  cosz,
real, intent(out)  fracday,
real, intent(out)  rrsun,
type(time_type), intent(in), optional  dt_time,
logical, intent(in), optional  allow_negative_cosz,
real, intent(out), optional  half_day_out 
)
private

diurnal_solar_cal_0d receives time_type inputs, converts them to real variables and then calls diurnal_solar_2d to compute desired astronomical variables.

Parameters
[in]<lat>Latitudes of model grid points
[in]<lon>Longitudes of model grid points
[in]<time>Time of year (time_type)
[out]<cosz>Cosine of solar zenith angle
[out]<fracday>Daylight fraction of time interval
[out]<rrsun>Earth-Sun distance (r) relative to semi-major axis of orbital ellipse (a) : (a/r)**2
[out]<dt_time>OPTIONAL: time interval after gmt over which the astronomical variables are to be averaged. this produces averaged output rather than instantaneous.
[in]<allow_negative_cosz>allow_negative_cosz
[out]<half_day_out>half_day_out

Definition at line 1344 of file astronomy.F90.

◆ diurnal_solar_cal_1d()

subroutine astronomy_mod::diurnal_solar::diurnal_solar_cal_1d ( real, dimension(:), intent(in)  lat,
real, dimension(:), intent(in)  lon,
type(time_type), intent(in)  time,
real, dimension(:), intent(out)  cosz,
real, dimension(:), intent(out)  fracday,
real, intent(out)  rrsun,
type(time_type), intent(in), optional  dt_time,
logical, intent(in), optional  allow_negative_cosz,
real, dimension(:), intent(out), optional  half_day_out 
)
private

diurnal_solar_cal_1d receives time_type inputs, converts them to real variables and then calls diurnal_solar_2d to compute desired astronomical variables.

Parameters
[in]<lat>Latitudes of model grid points
[in]<lon>Longitudes of model grid points
[in]<gmt>Time of day at longitude 0.0; midnight = 0.0, one day = 2 * pi
[in]<time>Time of year (time_type)
[out]<cosz>Cosine of solar zenith angle
[out]<fracday>Daylight fraction of time interval
[out]<rrsun>earth-sun distance (r) relative to semi-major axis of orbital ellipse (a):(a/r)**2
[in]<dt>OPTIONAL: time interval after gmt over which the astronomical variables are to be averaged. this produces averaged output rather than instantaneous.
[in]<allow_negative_cosz>Allow negative values for cosz?
[out]<half_day_out>half_day_out

Definition at line 1276 of file astronomy.F90.

◆ diurnal_solar_cal_2d()

subroutine astronomy_mod::diurnal_solar::diurnal_solar_cal_2d ( real, dimension(:,:), intent(in)  lat,
real, dimension(:,:), intent(in)  lon,
type(time_type), intent(in)  time,
real, dimension(:,:), intent(out)  cosz,
real, dimension(:,:), intent(out)  fracday,
real, intent(out)  rrsun,
type(time_type), intent(in), optional  dt_time,
logical, intent(in), optional  allow_negative_cosz,
real, dimension(:,:), intent(out), optional  half_day_out 
)
private

diurnal_solar_cal_2d receives time_type inputs, converts them to real variables and then calls diurnal_solar_2d to compute desired astronomical variables.

Parameters
[in]<lat>Latitudes of model grid points
[in]<lon>Longitudes of model grid points
[in]<gmt>Time of day at longitude 0.0; midnight = 0.0, one day = 2 * pi
[in]<time>Time of year (time_type)
[out]<cosz>Cosine of solar zenith angle
[out]<fracday>Daylight fraction of time interval
[out]<rrsun>earth-sun distance (r) relative to semi-major axis of orbital ellipse (a):(a/r)**2
[in]<dt>OPTIONAL: time interval after gmt over which the astronomical variables are to be averaged. this produces averaged output rather than instantaneous.
[in]<allow_negative_cosz>Allow negative values for cosz?
[out]<half_day_out>half_day_out
Exceptions
FATAL,astronomy_mod radiation time step must be no longer than 12 hrs
FATAL,astronomy_mod radiation time step must not be an integral number of days

Definition at line 1194 of file astronomy.F90.

The documentation for this interface was generated from the following file: