Skip to content

Commit

Permalink
update version and interface documentation (#335)
Browse files Browse the repository at this point in the history
  • Loading branch information
@apcraig
apcraig authored Aug 25, 2020
1 parent ddec41e commit 1e6bed9
Show file tree
Hide file tree
Showing 3 changed files with 69 additions and 9 deletions.
2 changes: 1 addition & 1 deletion columnphysics/version.txt
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
ICEPACK 1.2.2
ICEPACK 1.2.3
4 changes: 2 additions & 2 deletions doc/source/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,9 @@
# built documents.
#
# The short X.Y version.
version = u'1.2.2'
version = u'1.2.3'
# The full version, including alpha/beta/rc tags.
version = u'1.2.2'
version = u'1.2.3'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
72 changes: 66 additions & 6 deletions doc/source/user_guide/interfaces.include
View file
Original file line number Diff line number Diff line change
Expand Up @@ -762,7 +762,8 @@ icepack_init_parameters
op_dep_min_in, fr_graze_s_in, fr_graze_e_in, fr_mort2min_in, &
fr_dFe_in, k_nitrif_in, t_iron_conv_in, max_loss_in, &
max_dfe_doc1_in, fr_resp_s_in, conserv_check_in, &
y_sk_DMS_in, t_sk_conv_in, t_sk_ox_in, frazil_scav_in)
y_sk_DMS_in, t_sk_conv_in, t_sk_ox_in, frazil_scav_in, &
sw_redist_in, sw_frac_in, sw_dtemp_in)

!-----------------------------------------------------------------
! parameter constants
Expand Down Expand Up @@ -889,6 +890,13 @@ icepack_init_parameters
rsnw_mlt_in , & ! maximum melting snow grain radius (10^-6 m)
kalg_in ! algae absorption coefficient for 0.5 m thick layer

logical (kind=log_kind), intent(in), optional :: &
sw_redist_in ! redistribute shortwave

real (kind=dbl_kind), intent(in), optional :: &
sw_frac_in , & ! Fraction of internal shortwave moved to surface
sw_dtemp_in ! temperature difference from melting

!-----------------------------------------------------------------------
! Parameters for dynamics
!-----------------------------------------------------------------------
Expand Down Expand Up @@ -1100,7 +1108,8 @@ icepack_query_parameters
T_max_out, fsal_out, op_dep_min_out, fr_graze_s_out, fr_graze_e_out, &
fr_mort2min_out, fr_resp_s_out, fr_dFe_out, &
k_nitrif_out, t_iron_conv_out, max_loss_out, max_dfe_doc1_out, &
y_sk_DMS_out, t_sk_conv_out, t_sk_ox_out, frazil_scav_out)
y_sk_DMS_out, t_sk_conv_out, t_sk_ox_out, frazil_scav_out, &
sw_redist_out, sw_frac_out, sw_dtemp_out)

!-----------------------------------------------------------------
! parameter constants
Expand Down Expand Up @@ -1236,6 +1245,13 @@ icepack_query_parameters
rsnw_mlt_out , & ! maximum melting snow grain radius (10^-6 m)
kalg_out ! algae absorption coefficient for 0.5 m thick layer

logical (kind=log_kind), intent(out), optional :: &
sw_redist_out ! redistribute shortwave

real (kind=dbl_kind), intent(out), optional :: &
sw_frac_out , & ! Fraction of internal shortwave moved to surface
sw_dtemp_out ! temperature difference from melting

!-----------------------------------------------------------------------
! Parameters for dynamics
!-----------------------------------------------------------------------
Expand Down Expand Up @@ -1446,7 +1462,12 @@ icepack_prep_radiation
alidr_ai, alidf_ai, &
scale_factor, &
fswsfcn, fswintn, &
fswthrun, fswpenln, &
fswthrun, &
fswthrun_vdr, &
fswthrun_vdf, &
fswthrun_idr, &
fswthrun_idf, &
fswpenln, &
Sswabsn, Iswabsn)

integer (kind=int_kind), intent(in) :: &
Expand Down Expand Up @@ -1477,6 +1498,12 @@ icepack_prep_radiation
fswintn , & ! SW absorbed in ice interior, below surface (W m-2)
fswthrun ! SW through ice to ocean (W/m^2)

real (kind=dbl_kind), dimension(:), intent(inout), optional :: &
fswthrun_vdr , & ! vis dir SW through ice to ocean (W/m^2)
fswthrun_vdf , & ! vis dif SW through ice to ocean (W/m^2)
fswthrun_idr , & ! nir dir SW through ice to ocean (W/m^2)
fswthrun_idf ! nir dif SW through ice to ocean (W/m^2)

real (kind=dbl_kind), dimension(:,:), intent(inout) :: &
fswpenln , & ! visible SW entering ice layers (W m-2)
Iswabsn , & ! SW radiation absorbed in ice layers (W m-2)
Expand Down Expand Up @@ -1527,7 +1554,12 @@ icepack_step_radiation
alvdrn, alvdfn, &
alidrn, alidfn, &
fswsfcn, fswintn, &
fswthrun, fswpenln, &
fswthrun, &
fswthrun_vdr, &
fswthrun_vdf, &
fswthrun_idr, &
fswthrun_idf, &
fswpenln, &
Sswabsn, Iswabsn, &
albicen, albsnon, &
albpndn, apeffn, &
Expand Down Expand Up @@ -1620,6 +1652,12 @@ icepack_step_radiation
albpndn , & ! pond
apeffn ! effective pond area used for radiation calculation

real (kind=dbl_kind), dimension(:), intent(inout), optional :: &
fswthrun_vdr , & ! vis dir SW through ice to ocean (W/m^2)
fswthrun_vdf , & ! vis dif SW through ice to ocean (W/m^2)
fswthrun_idr , & ! nir dir SW through ice to ocean (W/m^2)
fswthrun_idf ! nir dif SW through ice to ocean (W/m^2)

real (kind=dbl_kind), dimension(:,:), intent(inout) :: &
fswpenln , & ! visible SW entering ice layers (W m-2)
Iswabsn , & ! SW radiation absorbed in ice layers (W m-2)
Expand Down Expand Up @@ -1989,7 +2027,12 @@ icepack_step_therm1
fcondtop , fcondtopn , &
fcondbot , fcondbotn , &
fswsfcn , fswintn , &
fswthrun , fswabs , &
fswthrun , &
fswthrun_vdr, &
fswthrun_vdf, &
fswthrun_idr, &
fswthrun_idf, &
fswabs , &
flwout , &
Sswabsn , Iswabsn , &
flw , &
Expand All @@ -1998,7 +2041,12 @@ icepack_step_therm1
evap , &
evaps , evapi , &
fresh , fsalt , &
fhocn , fswthru , &
fhocn , &
fswthru , &
fswthru_vdr , &
fswthru_vdf , &
fswthru_idr , &
fswthru_idf , &
flatn_f , fsensn_f , &
fsurfn_f , fcondtopn_f , &
faero_atm , faero_ocn , &
Expand Down Expand Up @@ -2109,6 +2157,12 @@ icepack_step_therm1
mlt_onset , & ! day of year that sfc melting begins
frz_onset ! day of year that freezing begins (congel or frazil)

real (kind=dbl_kind), intent(inout), optional :: &
fswthru_vdr , & ! vis dir shortwave penetrating to ocean (W/m^2)
fswthru_vdf , & ! vis dif shortwave penetrating to ocean (W/m^2)
fswthru_idr , & ! nir dir shortwave penetrating to ocean (W/m^2)
fswthru_idf ! nir dif shortwave penetrating to ocean (W/m^2)

real (kind=dbl_kind), dimension(:), optional, intent(inout) :: &
Qa_iso , & ! isotope specific humidity (kg/kg)
Qref_iso , & ! isotope 2m atm reference spec humidity (kg/kg)
Expand Down Expand Up @@ -2159,6 +2213,12 @@ icepack_step_therm1
snoicen , & ! snow-ice growth (m)
dsnown ! change in snow thickness (m/step-->cm/day)

real (kind=dbl_kind), optional, dimension(:), intent(inout) :: &
fswthrun_vdr , & ! vis dir SW through ice to ocean (W/m^2)
fswthrun_vdf , & ! vis dif SW through ice to ocean (W/m^2)
fswthrun_idr , & ! nir dir SW through ice to ocean (W/m^2)
fswthrun_idf ! nir dif SW through ice to ocean (W/m^2)

real (kind=dbl_kind), dimension(:,:), intent(inout) :: &
zqsn , & ! snow layer enthalpy (J m-3)
zqin , & ! ice layer enthalpy (J m-3)
Expand Down

0 comments on commit 1e6bed9

Please sign in to comment.