Merge pull request #11 from junwang-noaa/upp_doc

update post document

io/post_fv3.F90

@@ -33,22 +33,22 @@ module post_fv3
 
   implicit none
 
-  public post_run_fv3 !< ???
+  public post_run_fv3 !< Interface to run inline post
 
   contains
 
-    !> ???
+    !> Interface to run inline post
     !>
-    !> @param[in] wrt_int_state ???
-    !> @param[in] grid_id ???
-    !> @param[in] mype ???
-    !> @param[in] mpicomp ???
-    !> @param[in] lead_write ???
-    !> @param[in] itasks ???
-    !> @param[in] jtasks ???
-    !> @param[in] mynfhr ???
-    !> @param[in] mynfmin ???
-    !> @param[in] mynfsec
+    !> @param[in] wrt_int_state write grid component internal state
+    !> @param[in] grid_id id number of the output grid
+    !> @param[in] mype MPI rank
+    !> @param[in] mpicomp MPI communicator of the write grid component
+    !> @param[in] lead_write lead task of the write group
+    !> @param[in] itasks number of MPI tasks in i direction of output domain
+    !> @param[in] jtasks number of MPI tasks in j direction of output domain
+    !> @param[in] mynfhr output forecast hours on the write grid component
+    !> @param[in] mynfmin output forecast minutes on the write grid component
+    !> @param[in] mynfsec output forecast secondson the write grid component
     !>
     !> @author Jun Wang @date Jul, 2019 
     subroutine post_run_fv3(wrt_int_state,grid_id,mype,mpicomp,lead_write, &
@@ -230,10 +230,10 @@ subroutine post_run_fv3(wrt_int_state,grid_id,mype,mpicomp,lead_write, &
 
     end subroutine post_run_fv3
 
-    !> ???
+    !> Subroutine to get attributes for post processing
     !>
-    !> @param[in] wrt_int_state ???
-    !> @param[in] grid_id ???
+    !> @param[in] wrt_int_state write grid component internal state
+    !> @param[in] grid_id id number of the output grid
     !>
     !> @author Jun Wang @date Jul, 2019 
     subroutine post_getattr_fv3(wrt_int_state,grid_id)
@@ -504,12 +504,12 @@ subroutine post_getattr_fv3(wrt_int_state,grid_id)
 !
     end subroutine post_getattr_fv3
 
-    !> ???
+    !> Subroutine to set post variables
     !>
-    !> @param[in] wrt_int_state ???
-    !> @param[in] grid_id ???
-    !> @param[in] mype ???
-    !> @param[in] mpicomp
+    !> @param[in] wrt_int_state write grid component internal state
+    !> @param[in] grid_id id number of the output grid
+    !> @param[in] mype MPI rank
+    !> @param[in] mpicomp MPI communicator of the write grid component
     !>
     !> @author Jun Wang @date Jul 2019 
     subroutine set_postvars_fv3(wrt_int_state,grid_id,mype,mpicomp)

io/post_nems_routines.F90

@@ -1,5 +1,5 @@
 !> @file
-!> @brief ???
+!> @brief miscellaneous subroutines to support inline post
 !> @author Jun Wang @date Oct 8, 2019 
 
 !> Allocate post variables.
@@ -11,21 +11,21 @@
 !> Jul 2019 | Jun Wang | allocate arrays for post processing
 !> Feb 2022 | J. Meng/B. Cui | create interface to run inline post with post_2d_decomp
 !>
-!> @param[in] imi ???
-!> @param[in] jmi ???
-!> @param[in] lmi ???
-!> @param[in] mype ???
-!> @param[in] nwtlpes ???
-!> @param[in] lead_write ???
-!> @param[in] mpicomp ???
-!> @param[in] jts ???
-!> @param[in] jte ???
-!> @param[in] jtsgrp ???
-!> @param[in] jtegrp ???
-!> @param[in] its ???
-!> @param[in] ite ???
-!> @param[in] itsgrp ???
-!> @param[in] itegrp ???
+!> @param[in] imi i dimension size of the output grid
+!> @param[in] jmi j dimension size of the output grid
+!> @param[in] lmi l (layer) dimension size of the output grid
+!> @param[in] mype MPI rank
+!> @param[in] nwtlpes number of write tasks in the write group
+!> @param[in] lead_write lead task of the write group
+!> @param[in] mpicomp MPI communicator of the write grid component
+!> @param[in] jts start index in j dimention in a task subdomain
+!> @param[in] jte end index in j dimention in a task subdomain
+!> @param[in] jtsgrp start index in j dimention of all write tasks
+!> @param[in] jtegrp end idex in j dimention of all write tasks
+!> @param[in] its start index in i dimention in a task subdomain
+!> @param[in] ite end index in j dimention in a task subdomain
+!> @param[in] itsgrp start index in i dimention of all write tasks
+!> @param[in] itegrp end idex in i dimention of all write tasks
 !>
 !> @author Jun Wang @date Oct 8 2019 
 subroutine post_alctvars(imi,jmi,lmi,mype,nwtlpes,lead_write, mpicomp,  &
@@ -234,13 +234,13 @@ end subroutine post_alctvars
 
   !> Read post namelist.
   !>
-  !> @param[in] kpo ???
-  !> @param[in] kth ???
-  !> @param[in] kpv ???
-  !> @param[in] po ???
-  !> @param[in] th ???
-  !> @param[in] pv ???
-  !> @param[in] post_namelist ???
+  !> @param[in] kpo number of pressure levels
+  !> @param[in] kth number of isentropic levels
+  !> @param[in] kpv number of potential vorticity levels
+  !> @param[in] po pressure levels to output
+  !> @param[in] th isentropic levels to output
+  !> @param[in] pv potential vorticity levels to output
+  !> @param[in] post_namelist post namelist array
   !>
   !> @author Jun Wang @date Jul 2019
   subroutine read_postnmlt(kpo,kth,kpv,po,th,pv,post_namelist)
@@ -357,7 +357,7 @@ end subroutine read_postnmlt
 
     !> Finalize post step.
     !>
-    !> @param[in] post_gribversion ???
+    !> @param[in] post_gribversion grib version(1 or 2) used in post
     !>
     !> @author Jun Wang @date Jul 2019
     subroutine post_finalize(post_gribversion)