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

Jump to bottom

icepack_therm_shared: correct 'Tair' units in declaration comment #399

Merged
merged 1 commit into from
Aug 23, 2022
Merged

icepack_therm_shared: correct 'Tair' units in declaration comment #399

merged 1 commit into from
Aug 23, 2022

Conversation

phil-blain
Copy link
Member

PR checklist

  • Short (1 sentence) summary of your PR:
    title
  • Developer(s):
    me
  • Suggest PR reviewers from list in the column to the right.
  • How much do the PR code changes differ from the unmodified code?
    • bit for bit
    • different at roundoff level
    • more substantial
  • Does this PR create or have dependencies on CICE or any other models?
    • Yes
    • No
  • Does this PR add any new test cases?
    • Yes
    • No
  • Is the documentation being updated? ("Documentation" includes information on the wiki or in the .rst files from doc/source/, which are used to create the online technical docs at https://readthedocs.org/projects/cice-consortium-cice/.)
    • Yes
    • No, does the documentation need to be updated at a later time?
      • Yes
      • No
  • Please provide any additional information or relevant details below:

In subroutine icepack_therm_shared::icepack_init_trcr, 'Tair' is
documented as having units 'C' (degrees Celsius), but this is incorrect,
this variable is in Kelvins. This can be seen a few lines below where we
compute Tsfc:

Tsfc = min(Tsmelt, Tair - Tffresh) ! deg C

where 'Tffresh' is the freezing point of fresh ice in Kelvins, 273.15,
as defined in icepack_parameters.

Fix the units in the declaration comment.

Reported-by: Frederic Dupont [email protected]

@phil-blain
icepack_therm_shared: correct 'Tair' units in declaration comment
09bec50 
In subroutine icepack_therm_shared::icepack_init_trcr, 'Tair' is
documented as having units 'C' (degrees Celsius), but this is incorrect,
this variable is in Kelvins. This can be seen a few lines below where we
compute Tsfc:

    Tsfc = min(Tsmelt, Tair - Tffresh) ! deg C

where 'Tffresh' is the freezing point of fresh ice in Kelvins, 273.15,
as defined in icepack_parameters.

Fix the units in the declaration comment.

Reported-by: Frederic Dupont <[email protected]>
eclare108213
eclare108213 approved these changes Aug 23, 2022
View reviewed changes
Copy link
Contributor

@eclare108213 eclare108213 left a comment

Choose a reason for hiding this comment

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

good catch. glad the error is only in a comment statement.

@apcraig apcraig merged commit 4c7b9b5 into CICE-Consortium:main Aug 23, 2022
@phil-blain phil-blain deleted the init-trcr-tair-units branch February 13, 2024 16:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@apcraig apcraig apcraig approved these changes

@eclare108213 eclare108213 eclare108213 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@phil-blain @eclare108213 @apcraig