Doxygen markup for MOM_KPP #3
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
o Also enabled MathJAX in .doxygen to process formulas
o Inadvertently add .swp and ~ files when adding doxygen comments.
adcroft
pushed a commit
that referenced
this pull request
May 10, 2016
nikizadehgfdl
referenced
this pull request
in nikizadehgfdl/MOM6
Oct 9, 2017
- NOAA-GFDL/MOM6@ae22a0f Merge pull request mom-ocean#578 from NCAR/dev/ncar - NOAA-GFDL/MOM6@f4f882f Merge pull request mom-ocean#23 from gustavo-marques/combine_mct_modules - NOAA-GFDL/MOM6@a85b728 Merge MCT modules - NOAA-GFDL/MOM6@ba5b5ba Merge pull request mom-ocean#22 from gustavo-marques/check_fluxes - NOAA-GFDL/MOM6@f5a8483 Adds option to write restart files - NOAA-GFDL/MOM6@8745b4b Fills additional IOB fluxes - NOAA-GFDL/MOM6@f6b22ff Merge branch 'dev/ncar' into check_fluxes - NOAA-GFDL/MOM6@369d5d6 Merge pull request mom-ocean#21 from alperaltuntas/dev/ncar - NOAA-GFDL/MOM6@2582e0a Adds run paramaters to control SW decomposition - NOAA-GFDL/MOM6@58f78b9 Fill IOB, some fluxes still need to be checked - NOAA-GFDL/MOM6@06a30ab Fixed clock and timing - NOAA-GFDL/MOM6@1bca79b Merge pull request mom-ocean#20 from gustavo-marques/fix_merge - NOAA-GFDL/MOM6@fb89b08 Adds code that got lost during merge - NOAA-GFDL/MOM6@7480492 Merge pull request mom-ocean#19 from gustavo-marques/new_merge - NOAA-GFDL/MOM6@be1e6cf Merge branch 'dev/master' into dev/ncar - NOAA-GFDL/MOM6@76565cb Merge pull request mom-ocean#17 from gustavo-marques/fix_ssh_slopes - NOAA-GFDL/MOM6@c04f081 Fix ssh slope calculation - NOAA-GFDL/MOM6@17d4586 Merge pull request mom-ocean#16 from adcroft/ncar-cherry-picked-fixes - NOAA-GFDL/MOM6@be46fee (*)Fixes gprime(1) when no layer coordinates are set - NOAA-GFDL/MOM6@fccb7ae Avoids a SEGV when OBC are not in use with bi-harmonic friction - NOAA-GFDL/MOM6@f42c970 Merge pull request mom-ocean#15 from gustavo-marques/small_fixes - NOAA-GFDL/MOM6@31787c2 Adds reference to set_time that was lost during a conflict handling - NOAA-GFDL/MOM6@d77936e Fix intent(inout) in ice_ocean_boundary - NOAA-GFDL/MOM6@b403edd Merge pull request mom-ocean#14 from gustavo-marques/docs - NOAA-GFDL/MOM6@4d346ca Merge branch 'dev/ncar' into docs - NOAA-GFDL/MOM6@f7c26a5 Clean the module and start doxygenizing it - NOAA-GFDL/MOM6@cd58e2a Merge pull request mom-ocean#13 from alperaltuntas/dev/ncar - NOAA-GFDL/MOM6@37a53bc reorganize file structure - NOAA-GFDL/MOM6@e6c5ddd Merge pull request mom-ocean#12 from gustavo-marques/fill_ice_ocean_bnd - NOAA-GFDL/MOM6@6b6289a Remove trailing whitespace - NOAA-GFDL/MOM6@7ce40e5 Fix undefined reference to fill_ice_ocean_bnd - NOAA-GFDL/MOM6@d517719 Merge branch 'dev/ncar' into fill_ice_ocean_bnd - NOAA-GFDL/MOM6@b69ab33 Filling ice_ocean_bnd - Draft - NOAA-GFDL/MOM6@a306c90 Merge pull request mom-ocean#11 from adcroft/use-ocn-public-for-surface - NOAA-GFDL/MOM6@c83e238 Correct indexing when using ocean_public_type - NOAA-GFDL/MOM6@1f39c84 Replaces use of "surface" with "ocean_public_type" - NOAA-GFDL/MOM6@5cd8d7a Filling ice_ocean_bnd, still needs work - NOAA-GFDL/MOM6@3ceef26 Merge pull request mom-ocean#10 from adcroft/sketch-out-mct-run - NOAA-GFDL/MOM6@714e8d6 Adds placeholders for stepping foward MOM - NOAA-GFDL/MOM6@7f2207c Merge pull request #7 from adcroft/fix-mct-whitespace - NOAA-GFDL/MOM6@a1db77f Cleans up white space - NOAA-GFDL/MOM6@5700d67 Merge pull request #6 from adcroft/add-use-only-for-imports - NOAA-GFDL/MOM6@beac3ed Adds "only" for all use statements - NOAA-GFDL/MOM6@231d19e Merge pull request #5 from alperaltuntas/dev/ncar - NOAA-GFDL/MOM6@3a923a2 Got initialization working - NOAA-GFDL/MOM6@8b38141 Wrapped global data - NOAA-GFDL/MOM6@970f848 added debugging - NOAA-GFDL/MOM6@2540ed8 Filled empty subroutines in ocn_comp_mct.F90 - NOAA-GFDL/MOM6@ed3ed30 Added ocn_import_export module - NOAA-GFDL/MOM6@aba7dc2 Completed ocn_init_mct - NOAA-GFDL/MOM6@5df3bc3 Added method to point ponters to members of ocean_state_type - NOAA-GFDL/MOM6@57e6086 Added methods to return domain/grid shape - NOAA-GFDL/MOM6@37e7356 Added ocn_import_export.F90 - NOAA-GFDL/MOM6@2b794da Merge pull request #4 from alperaltuntas/dev/ncar - NOAA-GFDL/MOM6@fbd405b Added coupler indices module - NOAA-GFDL/MOM6@fa86163 Merge pull request #3 from NCAR/dev/gfdl - NOAA-GFDL/MOM6@e8f2999 Merge pull request #2 from gustavo-marques/temp_salt_z_init_file - NOAA-GFDL/MOM6@86936ba Adds option to read initial temp and salt from separate files - NOAA-GFDL/MOM6@54f7976 Most initialization working - NOAA-GFDL/MOM6@426357c Time and calendar initialization in ocn_comp_mct.F90 - NOAA-GFDL/MOM6@346097d Moved blank ocn_comp_mct.F90 - NOAA-GFDL/MOM6@405fecb Merge pull request #1 from gustavo-marques/ice_shelf - NOAA-GFDL/MOM6@711a613 Removes frazil's contribution to evaporation
nikizadehgfdl
referenced
this pull request
in nikizadehgfdl/MOM6
Oct 9, 2017
- Updates MOM_parameter_doc files. - NOAA-GFDL/MOM6@cde6d3f Merge branch 'dev/master' into dev/gfdl - NOAA-GFDL/MOM6@ae22a0f Merge pull request mom-ocean#578 from NCAR/dev/ncar - NOAA-GFDL/MOM6@f4f882f Merge pull request mom-ocean#23 from gustavo-marques/combine_mct_modules - NOAA-GFDL/MOM6@a85b728 Merge MCT modules - NOAA-GFDL/MOM6@ba5b5ba Merge pull request mom-ocean#22 from gustavo-marques/check_fluxes - NOAA-GFDL/MOM6@f5a8483 Adds option to write restart files - NOAA-GFDL/MOM6@8745b4b Fills additional IOB fluxes - NOAA-GFDL/MOM6@f6b22ff Merge branch 'dev/ncar' into check_fluxes - NOAA-GFDL/MOM6@369d5d6 Merge pull request mom-ocean#21 from alperaltuntas/dev/ncar - NOAA-GFDL/MOM6@2582e0a Adds run paramaters to control SW decomposition - NOAA-GFDL/MOM6@58f78b9 Fill IOB, some fluxes still need to be checked - NOAA-GFDL/MOM6@06a30ab Fixed clock and timing - NOAA-GFDL/MOM6@1bca79b Merge pull request mom-ocean#20 from gustavo-marques/fix_merge - NOAA-GFDL/MOM6@fb89b08 Adds code that got lost during merge - NOAA-GFDL/MOM6@7480492 Merge pull request mom-ocean#19 from gustavo-marques/new_merge - NOAA-GFDL/MOM6@be1e6cf Merge branch 'dev/master' into dev/ncar - NOAA-GFDL/MOM6@76565cb Merge pull request mom-ocean#17 from gustavo-marques/fix_ssh_slopes - NOAA-GFDL/MOM6@c04f081 Fix ssh slope calculation - NOAA-GFDL/MOM6@17d4586 Merge pull request mom-ocean#16 from adcroft/ncar-cherry-picked-fixes - NOAA-GFDL/MOM6@be46fee (*)Fixes gprime(1) when no layer coordinates are set - NOAA-GFDL/MOM6@fccb7ae Avoids a SEGV when OBC are not in use with bi-harmonic friction - NOAA-GFDL/MOM6@f42c970 Merge pull request mom-ocean#15 from gustavo-marques/small_fixes - NOAA-GFDL/MOM6@31787c2 Adds reference to set_time that was lost during a conflict handling - NOAA-GFDL/MOM6@d77936e Fix intent(inout) in ice_ocean_boundary - NOAA-GFDL/MOM6@b403edd Merge pull request mom-ocean#14 from gustavo-marques/docs - NOAA-GFDL/MOM6@4d346ca Merge branch 'dev/ncar' into docs - NOAA-GFDL/MOM6@f7c26a5 Clean the module and start doxygenizing it - NOAA-GFDL/MOM6@cd58e2a Merge pull request mom-ocean#13 from alperaltuntas/dev/ncar - NOAA-GFDL/MOM6@37a53bc reorganize file structure - NOAA-GFDL/MOM6@e6c5ddd Merge pull request mom-ocean#12 from gustavo-marques/fill_ice_ocean_bnd - NOAA-GFDL/MOM6@6b6289a Remove trailing whitespace - NOAA-GFDL/MOM6@7ce40e5 Fix undefined reference to fill_ice_ocean_bnd - NOAA-GFDL/MOM6@d517719 Merge branch 'dev/ncar' into fill_ice_ocean_bnd - NOAA-GFDL/MOM6@b69ab33 Filling ice_ocean_bnd - Draft - NOAA-GFDL/MOM6@a306c90 Merge pull request mom-ocean#11 from adcroft/use-ocn-public-for-surface - NOAA-GFDL/MOM6@c83e238 Correct indexing when using ocean_public_type - NOAA-GFDL/MOM6@1f39c84 Replaces use of "surface" with "ocean_public_type" - NOAA-GFDL/MOM6@5cd8d7a Filling ice_ocean_bnd, still needs work - NOAA-GFDL/MOM6@3ceef26 Merge pull request mom-ocean#10 from adcroft/sketch-out-mct-run - NOAA-GFDL/MOM6@714e8d6 Adds placeholders for stepping foward MOM - NOAA-GFDL/MOM6@7f2207c Merge pull request #7 from adcroft/fix-mct-whitespace - NOAA-GFDL/MOM6@a1db77f Cleans up white space - NOAA-GFDL/MOM6@5700d67 Merge pull request #6 from adcroft/add-use-only-for-imports - NOAA-GFDL/MOM6@beac3ed Adds "only" for all use statements - NOAA-GFDL/MOM6@231d19e Merge pull request #5 from alperaltuntas/dev/ncar - NOAA-GFDL/MOM6@3a923a2 Got initialization working - NOAA-GFDL/MOM6@8b38141 Wrapped global data - NOAA-GFDL/MOM6@970f848 added debugging - NOAA-GFDL/MOM6@2540ed8 Filled empty subroutines in ocn_comp_mct.F90 - NOAA-GFDL/MOM6@ed3ed30 Added ocn_import_export module - NOAA-GFDL/MOM6@aba7dc2 Completed ocn_init_mct - NOAA-GFDL/MOM6@5df3bc3 Added method to point ponters to members of ocean_state_type - NOAA-GFDL/MOM6@57e6086 Added methods to return domain/grid shape - NOAA-GFDL/MOM6@37e7356 Added ocn_import_export.F90 - NOAA-GFDL/MOM6@2b794da Merge pull request #4 from alperaltuntas/dev/ncar - NOAA-GFDL/MOM6@fbd405b Added coupler indices module - NOAA-GFDL/MOM6@fa86163 Merge pull request #3 from NCAR/dev/gfdl - NOAA-GFDL/MOM6@e8f2999 Merge pull request #2 from gustavo-marques/temp_salt_z_init_file - NOAA-GFDL/MOM6@86936ba Adds option to read initial temp and salt from separate files - NOAA-GFDL/MOM6@54f7976 Most initialization working - NOAA-GFDL/MOM6@426357c Time and calendar initialization in ocn_comp_mct.F90 - NOAA-GFDL/MOM6@346097d Moved blank ocn_comp_mct.F90 - NOAA-GFDL/MOM6@405fecb Merge pull request #1 from gustavo-marques/ice_shelf - NOAA-GFDL/MOM6@711a613 Removes frazil's contribution to evaporation
Hallberg-NOAA
pushed a commit
that referenced
this pull request
Apr 12, 2019
Merge dev/gfdl from NOAA-GFDL repository
AndrewWittenberg
pushed a commit
to AndrewWittenberg/MOM6
that referenced
this pull request
Feb 6, 2020
Updating dev/gfdl to Aug 30th 2019
marshallward
pushed a commit
that referenced
this pull request
Feb 1, 2021
MOM_domain_infra: Document FMS passthroughs
marshallward
pushed a commit
to herrwang0/MOM6
that referenced
this pull request
Dec 5, 2021
* reads in porous topography parameters from CHANNEL_LIST_FILE *new module to compute curve fit for porous topography *porous constraints used to modify continuity_PPM, CoriolisAdv, and Rayleigh bottom channel drag
marshallward
pushed a commit
to herrwang0/MOM6
that referenced
this pull request
Dec 5, 2021
(+) porous topography implementation
Hallberg-NOAA
referenced
this pull request
in breichl/MOM6
Dec 30, 2021
Use the por_face_area[UV] in the effective thickness calculations in zonal_face_thickness and merid_face_thickness, so that they are more consistent with their use elsewhere in the code for the relative weights in calculating the barotropic accelerations. Because these por_face_area arrays are still 1 in all test cases, the answers are unchanged in any test cases from before a few weeks ago, but there could be answer changes in cases that are using the very recently added capability (in PR #3) to set fractional face areas. This change was discussed with Sam Ditkovsky, and agreed that there is no reason to keep the ability to recover the previous answers in any cases that use the recently added partial face width option. This commit also expanded the comments describing the h_u and h_v arguments to btcalc(), zonal_face_thickness(), and merid_face_thickness() routines, the diag_h[uv] elements of the accel_diag_ptrs type and the h_u and h_v elements of the BT_cont_type. All answers and output are bitwise identical in the MOM6-examples test suite and TC tests, but answer changes are possible in cases using a very recently added code option.
alex-huth
pushed a commit
to alex-huth/MOM6
that referenced
this pull request
Jan 28, 2025
* Removed second registration of sfc_mass_flux with register_diag_field. * Registered sfc_mass_flux to runs with static and dynamic ice sheets.
herrwang0
pushed a commit
to herrwang0/MOM6
that referenced
this pull request
Feb 20, 2025
* Commit for coupling of land to ocean adot * Remove unused ice sheet enabled flag * add adot to Shelf restart * Register sfc mass flux outside of initialize fluxes * Gfdl cryo merge (mom-ocean#3) * Removed second registration of sfc_mass_flux with register_diag_field. * Registered sfc_mass_flux to runs with static and dynamic ice sheets. * This commit removed the second registration of 'sfc_mass_flux' in 'register_diag_field()' * Testing shelf_sfc_mass_flux restart. * The earlier removed 'register_diag_field()' for 'mass_flux' has been added back and 'register_restart_field()' of 'fluxes_in%shelf_sfc_mass_flux' is moved before 'restore_state()' * Corrected the line length error. * Added back 'CS%id_mass_flux = register_diag_field()' --------- Co-authored-by: NJSchlegel <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
These comment updates were tested on a branch in case we weren't going to adopt doxygen. We ARE going to use doxygen for in-code API documentation so we now should pull in these comments.
The web pages generated by doxygen look like this:
While the comments in the code only need !<, !> modifiers:
In-line equations are LaTeX surrounding by \f$ pairs. We will try to minimize obfuscation of comment with LaTeX but should use it in the module documentation.