Skip to content

Motification of doc for C-grid remapping#1034

Merged
eclare108213 merged 6 commits into
CICE-Consortium:mainfrom
JFLemieux73:EFAdoc
Jul 9, 2025
Merged

Motification of doc for C-grid remapping#1034
eclare108213 merged 6 commits into
CICE-Consortium:mainfrom
JFLemieux73:EFAdoc

Conversation

@JFLemieux73
Copy link
Copy Markdown
Contributor

For detailed information about submitting Pull Requests (PRs) to the CICE-Consortium,
please refer to: https://github.com/CICE-Consortium/About-Us/wiki/Resource-Index#information-for-developers

PR checklist

  • Short (1 sentence) summary of your PR:
    Minor modifications to the documentation for C-grid remapping and edge flux adjustment method (EFA).
  • Developer(s):
    @JFLemieux73
  • Suggest PR reviewers from list in the column to the right. @eclare108213, @apcraig
  • Please copy the PR test results link or provide a summary of testing completed below.
    BFB for B and C-grid gbox80 tests (with ktranposrt=kridge=1)
  • 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 Icepack or any other models?
    • Yes
    • No
  • Does this PR update the Icepack submodule? If so, the Icepack submodule must point to a hash on Icepack's main branch.
    • 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/. A test build of the technical docs will be performed as part of the PR testing.)
    • Yes
    • No, does the documentation need to be updated at a later time?
      • Yes
      • No
  • Please document the changes in detail, including why the changes are made. This will become part of the PR commit log.
    People from SI3 are interested in our C-grid remapping and edge flux adjustment method (EFA). They had a look at the code and the documentation. It was not clear in the code (and the doc) that the EFA method is used when setting l_fixed_area=.true. I have changed the name l_fixed_area to l_EFA, modified the doc and added the reference for the C-grid paper.

Copy link
Copy Markdown
Contributor

@apcraig apcraig left a comment

Choose a reason for hiding this comment

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

It looks like the code uses l_EFA while the documentation suggests the variable name is l_EFA_area. Should these be consistent?

@JFLemieux73
Copy link
Copy Markdown
Contributor Author

It looks like the code uses l_EFA while the documentation suggests the variable name is l_EFA_area. Should these be consistent?

Thanks @apcraig. I just modified the doc.

Copy link
Copy Markdown
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.

I'm not crazy about l_EFA, would prefer l_edge_flux_adj to be more immediately recognizable. But okay. Thanks for clarifying this parameter for users!

@JFLemieux73
Copy link
Copy Markdown
Contributor Author

It is true that it is more easily recognizable. I will change it. No problem.

@JFLemieux73
Copy link
Copy Markdown
Contributor Author

I just changed the name of the variable. I redid the gbox80 tests and it is BFB for both B and C-grid (with ktransport=kridge=1). Thanks for your help!

@eclare108213 eclare108213 self-assigned this Jul 9, 2025
@eclare108213
Copy link
Copy Markdown
Contributor

Thank you for fixing that!

@eclare108213 eclare108213 merged commit 49cc480 into CICE-Consortium:main Jul 9, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants