Skip to content

Minor cleanup in cnvc90.f #1201

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

Open
matusmartini wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −15
Open

Minor cleanup in cnvc90.f #1201

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 7 additions & 14 deletions physics/Interstitials/UFS_SCM_NEPTUNE/cnvc90.f
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
!>\file cnvc90.f
!! This file contains the calculation of fraction of convective cloud,
!! pressure at bottom of convective cloud and at top of convective
!! cloud.
!! This module computes the convective cloud fraction, as well as
Copy link
Collaborator

@grantfirl grantfirl Mar 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mzhangw May want to revert this change because it affects the Doxygen output. Even though it's repetitive, I think that Doxygen wants description for the file and the module because these descriptions show up in different contexts.

Copy link
Contributor Author

@matusmartini matusmartini Mar 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@grantfirl Would you mind pointing me to a file/module that I can follow? I can revert, but it would be nice to follow preferred template.

Copy link
Collaborator

@grantfirl grantfirl Mar 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@matusmartini It may be a moot point because I haven't been intimately involved with the scientific documentation in a while. Perhaps this repetition truly isn't needed anymore. Regardless, I'd like @mzhangw (who has led this effort most recently) to OK this because I don't want to break any existing documentation functionality.

Copy link
Contributor Author

@matusmartini matusmartini Mar 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems to be inconsistent. Some files do not have duplicated entries.

Examples of the use:

!!  Contains code to...
!! This module contains code...
!! This file contains <empty, nothing>

Ideally, should the information be duplicated as in the following?

!! This file contains <information about the scheme>
...
!! This module contains <information about the scheme>

Copy link
Contributor

@mzhangw mzhangw Mar 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@matusmartini, please feel free to revise the document as appropriate. We usually debug Doxygen prior to a CCPP release if it breaks the SciDoc.

!! the pressure at the base and top of the convective cloud.
module cnvc90

contains
Expand All @@ -11,9 +10,6 @@ end subroutine cnvc90_init

!>\defgroup GFS_cnvc90 GFS Convective Cloud Diagnostics Module
!> @{
!! This module contains the calculation of fraction of convective cloud,
!! pressure at bottom of convective cloud and at top of convective
!! cloud.
!> \section arg_table_cnvc90_run Argument Table
!! \htmlinclude cnvc90_run.html
!!
Expand Down Expand Up @@ -43,23 +39,23 @@ SUBROUTINE cnvc90_run(CLSTP,IM,RN,KBOT,KTOP,KM,PRSI, &

! Local variables
integer :: i,ibot,itop,lc,lz,n,ncc
real(kind=kind_phys) :: ah,cc1,cc2,cvb0,p1,p2,rkbot,rktop,val
real(kind=kind_phys) :: ah,cc1,cc2,cvb0,p1,p2
integer :: NMD(IM)
real(kind=kind_phys) :: PMD(IM)
!

real (kind=kind_phys), parameter :: cons_100=100.0
real(kind=kind_phys) :: R_KBOT_I, R_KTOP_I
!

PARAMETER(NCC=9)
real(kind=kind_phys) :: CC(NCC),P(NCC)
DATA CC/0.,0.1,0.2,0.3,0.4,0.5,0.6,0.7,0.8/
DATA P/.14,.31,.70,1.6,3.4,7.7,17.,38.,85./
DATA CVB0/100./
!

! Initialize CCPP error handling variables
errmsg = ''
errflg = 0
!

LZ=0
LC=0
IF(CLSTP.GE.1000.) LZ=1
Expand Down Expand Up @@ -123,9 +119,6 @@ SUBROUTINE cnvc90_run(CLSTP,IM,RN,KBOT,KTOP,KM,PRSI, &
ENDIF
ENDDO
ENDIF
RETURN
END SUBROUTINE cnvc90_run
!> @}

end module cnvc90

1 change: 0 additions & 1 deletion physics/Interstitials/UFS_SCM_NEPTUNE/cnvc90.meta
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,4 +122,3 @@
dimensions = ()
type = integer
intent = out