From 6585a867bff31f651b5b1597783e67164dce6c2f Mon Sep 17 00:00:00 2001 From: alex-huth Date: Tue, 11 May 2021 15:20:55 -0400 Subject: [PATCH] more documentation --- src/icebergs.F90 | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/src/icebergs.F90 b/src/icebergs.F90 index fda6ebb..266f10e 100644 --- a/src/icebergs.F90 +++ b/src/icebergs.F90 @@ -1018,7 +1018,7 @@ subroutine calculate_force_land_contact(bergs, berg, grd, i, j, IA_x, IA_y, & ! Arguments type(icebergs), pointer :: bergs !< Container for all types and memory type(iceberg), pointer :: berg !< Primary berg - type(icebergs_gridded), pointer :: grd + type(icebergs_gridded), pointer :: grd !< Container for gridded fields integer, intent(in) :: i !< Grid cell i to contact integer, intent(in) :: j !< Grid cell j to contact real, intent(inout) :: IA_x !< Net zonal acceleration of berg due to interactions (m/s2) @@ -3393,13 +3393,14 @@ subroutine swap_variables(x,y) end subroutine swap_variables end subroutine rolling -!> Estimate the dimenstions of a representative FL berg that will give roughly the same -!! freshwater flux as the actual group of FL bergs of all different sizes: -!! this may not be appropriate for very small FL bergs or dense sea ice cover +!> Estimate the dimensions of a footloose berg that represents the footloose bits. +!! The goal is that the meltwater flux from this representative berg, multiplied by +!! (the mass of all footloose bits)/(mass of the representative berg), matches the meltwater +!! flux of all footloose bits (which if they were individually tracked, could vary in size). subroutine fl_bits_dimensions(bergs,this,L_fl,W_fl,T_fl) ! Arguments type(icebergs), pointer :: bergs !< Container for all types and memory - type(iceberg), pointer :: this + type(iceberg), pointer :: this !< Parent berg to the footloose bits real :: L_fl !< Footloose berg bits length real :: W_fl !< Footloose berg bits width real :: T_fl !< Footloose berg bits thickness @@ -6399,7 +6400,7 @@ subroutine calve_fl_icebergs(bergs,pberg,k,l_b,fl_disp_x,fl_disp_y,berg_from_bit type(real),intent(in) :: l_b !< The width, and 1/3 the length, of a child berg type(real) :: fl_disp_x !< Child berg x-displacement from parent berg type(real) :: fl_disp_y !< Child berg x-displacement from parent berg - logical, optional, intent(in) :: berg_from_bits + logical, optional, intent(in) :: berg_from_bits !< True to create new berg from footloose bits ! Local variables type(iceberg) :: cberg ! The new child berg type(icebergs_gridded), pointer :: grd