Skip to content

Commit

Permalink
improved docs in write_data (#306)
Browse files Browse the repository at this point in the history
* improved docs in write_data

* Update author in chgres_cube.fd/write_data.F90

Fixes #305
Part of #191

Co-authored-by: George Gayno <George.Gayno@noaa.gov>
  • Loading branch information
edwardhartnett and GeorgeGayno-NOAA committed Feb 19, 2021
1 parent 6579ed6 commit 111566e
Showing 1 changed file with 14 additions and 15 deletions.
29 changes: 14 additions & 15 deletions sorc/chgres_cube.fd/write_data.F90
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
!> @file
!! @brief Write model coldstart files.
!!
!! @author gayno NCEP/EMC
!! @author George Gayno NCEP/EMC
!!
!! Write out target grid data into appropriate files for
!! the forecast model.
!!

!> @brief Writes atmospheric header file in netcdf format
!!
!! @author gayno NCEP/EMC
!> Writes atmospheric header file in netcdf format.
!!
!! @param[in] localpet ESMF local persistent execution thread
!! @author George Gayno NCEP/EMC
subroutine write_fv3_atm_header_netcdf(localpet)

use esmf
Expand Down Expand Up @@ -79,12 +79,11 @@ subroutine write_fv3_atm_header_netcdf(localpet)

end subroutine write_fv3_atm_header_netcdf

!> @brief
!! Writes atmospheric fields along the lateral boundary.
!! For regional grids only. Output in netcdf format.
!> Writes atmospheric fields along the lateral boundary.
!! For regional grids only. Output in netcdf format.
!!
!! @author gayno NCEP/EMC
!!
!! @param[in] localpet ESMF local persistent execution thread
!! @author George Gayno NCEP/EMC
subroutine write_fv3_atm_bndy_data_netcdf(localpet)

!---------------------------------------------------------------------------
Expand Down Expand Up @@ -1183,14 +1182,14 @@ subroutine write_fv3_atm_bndy_data_netcdf(localpet)

end subroutine write_fv3_atm_bndy_data_netcdf

!> @brief Write atmospheric coldstart files (netcdf format).
!!
!! @author gayno NCEP/EMC
!> Write atmospheric coldstart files (netcdf format).
!!
!! Routine writes tiled files in parallel. Tile 1 is written by
!! localpet 0; tile 2 by localpet 1, etc. The number of pets
!! must be equal to or greater than the number of tiled files.
!!
!! @param[in] localpet ESMF local persistent execution thread
!! @author George Gayno NCEP/EMC
subroutine write_fv3_atm_data_netcdf(localpet)

use esmf
Expand Down Expand Up @@ -1800,10 +1799,10 @@ subroutine write_fv3_atm_data_netcdf(localpet)

end subroutine write_fv3_atm_data_netcdf

!> @brief Writes surface and nst data into a 'coldstart' file (netcdf).
!> Writes surface and nst data into a 'coldstart' file (netcdf).
!!
!! @author gayno NCEP/EMC
!!
!! @param[in] localpet ESMF local persistent execution thread
!! @author George Gayno NCEP/EMC
subroutine write_fv3_sfc_data_netcdf(localpet)

use esmf
Expand Down

0 comments on commit 111566e

Please sign in to comment.