Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doxygen updates for two io files #33

Open
wants to merge 4 commits into
base: ejh_doxygen
Choose a base branch
from
Open

Doxygen updates for two io files #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
55f88da
Documentation updates for sfc_io routines.
LarissaReames-NOAA Feb 21, 2025
1b8662e
Doxygen updates for rrfs_sd_io and sfc_io modules
LarissaReames-NOAA Feb 21, 2025
4034274
Merge branch 'ejh_doxygen' of https://github.com/edwardhartnett/fv3at…
LarissaReames-NOAA Feb 25, 2025
8c6d7d2
More updates for ./io/ file doxygen.
LarissaReames-NOAA Feb 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 29 additions & 29 deletions io/fv3atm_clm_lake_io.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,8 @@ module fv3atm_clm_lake_io
!> This subroutine is clm_lake%alocate_data. It deallocates all
!> data, and reallocate to the size specified in Model.
!>
!> @param clm_lake ???
!> @param Model ???
!> @param clm_lake Temporary storage for CLM Lake restart data.
!> @param Model Model control parameters input from a nml and/or derived from others.
!>
!> @author Samuel Trahan @date Jun 20, 2023
subroutine clm_lake_allocate_data(clm_lake,Model)
Expand Down Expand Up @@ -152,9 +152,9 @@ end subroutine clm_lake_allocate_data
!> This is clm_lake%register_axes. It registers all five axes needed
!> by CLM Lake restart data.
!>
!> @param clm_lake ???
!> @param[in] Model ???
!> @param Sfc_restart ???
!> @param clm_lake Temporary storage for CLM Lake restart data.
!> @param[in] Model Model control parameters input from a nml and/or derived from others.
!> @param Sfc_restart FMS NetCDF object containing surface restart data.
!>
!> @author Samuel Trahan @date Jun 20, 2023
subroutine clm_lake_register_axes(clm_lake,Model,Sfc_restart)
Expand All @@ -172,9 +172,9 @@ end subroutine clm_lake_register_axes
!> name as each clm_lake axis, and fills the variable with the
!> appropriate indices.
!>
!> @param clm_lake ???
!> @param[in] Model ???
!> @param Sfc_restart ???
!> @param clm_lake Temporary storage for CLM Lake restart data.
!> @param[in] Model Model control parameters input from a nml and/or derived from others.
!> @param Sfc_restart FMS NetCDF object containing surface restart data.
!>
!> @author Samuel Trahan @date Jun 20, 2023
subroutine clm_lake_write_axes(clm_lake, Model, Sfc_restart)
Expand All @@ -201,10 +201,10 @@ end subroutine clm_lake_write_axes
!> Terrible things will happen if you don't call
!> clm_lake%allocate_data first.
!>
!> @param clm_lake ???
!> @param[in] Model ???
!> @param[in] Atm_block ???
!> @param[in] Sfcprop ???
!> @param clm_lake Temporary storage for CLM Lake restart data.
!> @param[in] Model Model control parameters input from a nml and/or derived from others.
!> @param[in] Atm_block Physics block layout information.
!> @param[in] Sfcprop Surface properties that may be read in and/or updated by climatology or observations .
!>
!> @author Samuel Trahan @date Jun 20, 2023
subroutine clm_lake_fill_data(clm_lake, Model, Atm_block, Sfcprop)
Expand Down Expand Up @@ -256,10 +256,10 @@ end subroutine clm_lake_fill_data
!> Terrible things will happen if you don't call
!> clm_lake%allocate_data first.
!>
!> @param clm_lake ???
!> @param[in] Model ???
!> @param[in] Atm_block ???
!> @param[in] Sfcprop ???
!> @param clm_lake Temporary storage for CLM Lake restart data.
!> @param[in] Model Model control parameters input from a nml and/or derived from others.
!> @param[in] Atm_block Physics block layout information.
!> @param[in] Sfcprop Surface properties that may be read in and/or updated by climatology or observations .
!>
!> @author Samuel Trahan @date Jun 20, 2023
subroutine clm_lake_copy_from_grid(clm_lake, Model, Atm_block, Sfcprop)
Expand Down Expand Up @@ -310,10 +310,10 @@ end subroutine clm_lake_copy_from_grid
!> variables to the corresponding Sfcprop variables. Terrible
!> things will happen if you don't call data%allocate_data first.
!>
!> @param clm_lake ???
!> @param[in] Model ???
!> @param[in] Atm_block ???
!> @param[in] Sfcprop ???
!> @param clm_lake Temporary storage for CLM Lake restart data.
!> @param[in] Model Model control parameters input from a nml and/or derived from others.
!> @param[in] Atm_block Physics block layout information.
!> @param[in] Sfcprop Surface properties that may be read in and/or updated by climatology or observations .
!>
!> @author Samuel Trahan @date Jun 20, 2023
subroutine clm_lake_copy_to_grid(clm_lake, Model, Atm_block, Sfcprop)
Expand Down Expand Up @@ -365,8 +365,8 @@ end subroutine clm_lake_copy_to_grid
!> CLM Lake Model. Terrible things will happen if you don't call
!> clm_lake%allocate_data and clm_lake%register_axes first.
!>
!> @param clm_lake ???
!> @param[in] Sfc_restart ???
!> @param clm_lake Temporary storage for CLM Lake restart data.
!> @param[in] Sfc_restart FMS NetCDF object containing surface restart data.
!>
!> @author Samuel Trahan @date Jun 20, 2023
subroutine clm_lake_register_fields(clm_lake, Sfc_restart)
Expand Down Expand Up @@ -440,11 +440,11 @@ end subroutine clm_lake_register_fields
!> Terrible things will happen if you don't call
!> clm_lake%allocate_data and clm_lake%register_axes first.
!>
!> @param clm_lake ???
!> @param[inout] bundle ???
!> @param[inout] grid ???
!> @param[in] Model ???
!> @param[in] outputfile ???
!> @param clm_lake Temporary storage for CLM Lake restart data.
!> @param[inout] bundle ESMF field bundle containing fields for writing CLM Lake Model restarts.
!> @param[inout] grid ESMF output grid for writing CLM Lake Model restarts.
!> @param[in] Model Model control parameters input from a nml and/or derived from others.
!> @param[in] outputfile Full path to the output restart file.
!>
!> @author Samuel Trahan @date Jun 20, 2023
subroutine clm_lake_bundle_fields(clm_lake, bundle, grid, Model, outputfile)
Expand Down Expand Up @@ -499,7 +499,7 @@ end subroutine Clm_lake_bundle_fields
!> automatically when an object of that type goes out of scope. This
!> is simply a wrapper around clm_lake%deallocate_data().
!>
!> @param clm_lake ???
!> @param clm_lake Temporary storage for CLM Lake restart data.
!>
!> @author Samuel Trahan @date Jun 20, 2023
subroutine clm_lake_final(clm_lake)
Expand All @@ -513,7 +513,7 @@ end subroutine clm_lake_final
!> used again after this call. This is also the implementation of
!> the clm_lake_data_type final routine.
!>
!> @param clm_lake ???
!> @param clm_lake Temporary storage for CLM Lake restart data.
!>
!> @author Samuel Trahan @date Jun 20, 2023
subroutine clm_lake_deallocate_data(clm_lake)
Expand Down
Loading