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.

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

Modified the documentation for the revised EVP. #229

Merged
merged 3 commits into from
Nov 14, 2018

Conversation

JFLemieux73
Copy link
Contributor

The documentation is now in line with revpv4 (PR 226).

I also did a few other minor modifications to the classic EVP and the basal stress sections. Elizabeth feel free to keep these or not. I thought it was a good idea to include the discretized (in time) equations for the stresses (as it is done for the u and v momentum equations). By doing so it is easier to introduce the revised EVP equations.

  • Developer(s): JF Lemieux

  • Please suggest code Pull Request reviewers in the column at

@eclare108213

  • Are the code changes bit for bit, different at roundoff level, or more substantial? N.A.

  • Please include the link to test results or paste the summary block from the bottom of the testing output below.

  • Does this PR create or have dependencies on Icepack or any other models? No

  • Is the documentation being updated with this PR? (Y/N) Y
    If not, does the documentation need to be updated separately at a later time? (Y/N)

Note: "Documentation" includes information on the wiki and .rst files in doc/source/,
which are used to create the online technical docs at https://readthedocs.org/projects/cice-consortium-cice/.

  • Other Relevant Details:

… minor modifications to the classic EVP and the basal stress sections.
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.

I'm a little concerned about the factors of e^2 that appear to be in the description of the original model. Is the original model changing? Or maybe I'm misinterpreting the differences.
Is there a readthedocs page where I can look at the new changes on this branch in compiled form?

@JFLemieux73
Copy link
Contributor Author

Yes I think at one point you modified the original model following Bouillon et al. 2013.

url = {http://dx.doi.org/10.1016/j.jcp.2015.04.051}
}

@Article{Lemieux12
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you make sure to add these both sequentially (e.g. 2012 before 2015) and alphabetically?

Copy link
Contributor

Choose a reason for hiding this comment

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

@duvivier
Copy link
Contributor

duvivier commented Nov 7, 2018

@JFLemieux73 @phil-blain
I also noticed that some of the fixes I've had to implement to get readthedocs building properly haven't been pulled yet to your branch. Once you pull those from the consortium master branch and merge them then readthedocs should work properly.

I can help you test this in readthedocs if you don't have an account yet.

@duvivier duvivier self-assigned this Nov 7, 2018
@JFLemieux73
Copy link
Contributor Author

Here is a document that explains the e^2 factor. Following Bouillon 2013 the subcycling of stressm and stress12 are now slightly different (compared to the evp in CICE4). I just verified the code (in fact revpv4) and it is consistent with the literature.
CICE4_6_dynEqs.pdf

@duvivier
Copy link
Contributor

@TillRasmussen I didn't see any comments, though this says you left a comment. just to be clear.

Put the following new reference before the Roberts15 reference:
@Article{Kimmritz15
author = "M. Kimmritz and S. Danilov and M. Losch",
title = "{On the convergence of the modified elastic-viscous-plastic method for solving the sea ice momentum equation}",
journal = JCP,
year = {2015},
volume = {296},
pages = {90-100},
url = {http://dx.doi.org/10.1016/j.jcp.2015.04.051}
}

and put the following new reference before the Lepparanta12 reference:
@Article{Lemieux12
author = "J.F. Lemieux and D.A. Knoll and B. Tremblay and D.M. Holland and M. Losch",
title = "{A comparison of the {J}acobian-free {N}ewton {K}rylov method and the {EVP} model for solving the sea ice momentum equation with a
viscous-plastic formulation: a serial algorithm study}",
journal = JCP,
year = {2012},
volume = {231},
pages = {5926-5944},
url = {http://dx.doi.org/10.1016/j.jcp.2012.05.024}
}

Take out the extra lines between references too please.

Once these changes have been made I'll grab JF's branch and test it in readthedocs.

@TillRasmussen
Copy link
Contributor

In section 2.2.3.4 just after the first two equation alpha,beta < 1. This should be the other way around alpa, beta > 1.

@duvivier
Copy link
Contributor

@JFLemieux73 @phil-blain
I was able to get this to build (https://dummy-for-others-rtd.readthedocs.io/en/latest/), but had to make changes to the master_list.bib file that are currently in the consortium master to do so.

The issue seems to be that you haven't pulled the latest consortium mods to the branch Doc_REVP. The top of your Doc_REVP branch says: "This branch is 2 commits ahead, 8 commits behind CICE-Consortium:master." If you pull the consortium master to your branch master that should take care of these updates. I'll test it again once you've done this and then I think it will be ready to merge.

Thanks!

… Doc_REVP

Pull to be in line with master code.
@JFLemieux73
Copy link
Contributor Author

Hi Alice,

I just tried what you wrote above...I hope it worked. Let me know. Thanks.

@duvivier
Copy link
Contributor

@JFLemieux73 Thanks! I just tested it an it looks like the docs build just fine and the branch is now up to date with the consortium master.

Docs: https://dummy-for-others-rtd.readthedocs.io/en/latest/

@duvivier duvivier merged commit 08a0b49 into CICE-Consortium:master Nov 14, 2018
@JFLemieux73 JFLemieux73 mentioned this pull request Nov 20, 2018
@JFLemieux73 JFLemieux73 deleted the Doc_REVP branch October 26, 2020 20:30
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.

5 participants