New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
Changeset 6436 for branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles – NEMO

Ignore:
Timestamp:
2016-04-07T15:33:32+02:00 (8 years ago)
Author:
timgraham
Message:

Updated to r6424 of nemo_v3_6_STABLE

Location:
branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles
Files:
9 deleted
48 edited
16 copied

Legend:

Unmodified
Added
Removed
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Biblio/Biblio.bib

    r5120 r6436  
    149149  volume = {36}, 
    150150  pages = {1502--1522} 
     151} 
     152 
     153@ARTICLE{Artale_al_JGR02, 
     154  author={V. Artale and D. Iudicone and R. Santoleri and V. Rupolo and S. Marullo 
     155          and F. {D'O}rtenzio}, 
     156  title={Role of surface fluxes in ocean general circulation models using satellite 
     157          sea surface temperature: Validation of and sensitivity to the forcing 
     158          frequency of the Mediterranean thermohaline circulation}, 
     159  journal=JGR, 
     160  year={2002}, 
     161  volume={107}, 
     162  pages={1978-2012}, 
     163  doi = {10.1029/2000JC000452}, 
    151164} 
    152165 
     
    276289  author = {A. Beckmann and H. Goosse}, 
    277290  title = {A parameterization of ice shelf-ocean interaction for climate models}, 
    278   journal = OM 
    279   year = {2003} 
    280   volume = {5} 
     291  journal = OM, 
     292  year = {2003}, 
     293  volume = {5}, 
    281294  pages = {157--170} 
    282295} 
     
    459472} 
    460473 
     474@article{bouffard_Boegman_DAO2013, 
     475   author = {D. Bouffard and L. Boegman}, 
     476   title = {A diapycnal diffusivity model for stratified environmental flows}, 
     477   volume = {61-62}, 
     478   issn = {03770265}, 
     479   url = {http://dx.doi.org/10.1016/j.dynatmoce.2013.02.002}, 
     480   doi = {10.1016/j.dynatmoce.2013.02.002}, 
     481   journal = DAO, 
     482   year = {2013}, 
     483   pages = {14--34}, 
     484} 
     485 
    461486@ARTICLE{Bougeault1989, 
    462487  author = {P. Bougeault and P. Lacarrere}, 
     
    489514  volume = {28},  number = {8}, 
    490515  pages = {1603--1606} 
     516} 
     517 
     518@article{Brankart_OM2013, 
     519author = "J.-M. Brankart", 
     520title = "Impact of uncertainties in the horizontal density gradient upon low resolution global ocean modelling ", 
     521journal = OM, 
     522year = "2013", 
     523volume = "66", pages = "64--76", 
     524issn = "1463-5003", 
     525doi = "http://dx.doi.org/10.1016/j.ocemod.2013.02.004", 
     526url = "http://www.sciencedirect.com/science/article/pii/S1463500313000309", 
     527} 
     528 
     529@Article{Brankart_al_GMD2015, 
     530AUTHOR = {Brankart, J.-M. and Candille, G. and Garnier, F. and Calone, C. and Melet, A. and Bouttier, P.-A. and Brasseur, P. and Verron, J.}, 
     531TITLE = {A generic approach to explicit simulation of uncertainty in the NEMO ocean model}, 
     532JOURNAL = {Geoscientific Model Development}, 
     533VOLUME = {8}, 
     534YEAR = {2015}, 
     535NUMBER = {5}, 
     536PAGES = {1285--1297}, 
     537URL = {http://www.geosci-model-dev.net/8/1285/2015/}, 
     538DOI = {10.5194/gmd-8-1285-2015} 
    491539} 
    492540 
     
    753801} 
    754802 
     803@article{de_lavergne_JPO2016_efficiency, 
     804   title = {The impact of a variable mixing efficiency on the abyssal overturning}, 
     805   issn = {0022-3670}, 
     806   url = {http://dx.doi.org//10.1175/JPO-D-14-0259.1}, 
     807   doi = {10.1175/JPO-D-14-0259.1}, 
     808   abstract = {In studies of ocean mixing, it is generally assumed that small-scale turbulent overturns lose 15-20 \% of their energy in eroding the background stratification. Accumulating evidence that this energy fraction, or mixing efficiency Rf, significantly varies depending on flow properties challenges this assumption, however. Here, we examine the implications of a varying mixing efficiency for ocean energetics and deep water mass transformation. Combining current parameterizations of internal wave-driven mixing with a recent model expressing Rf as a function of a turbulence intensity parameter Reb = εν/νN2, we show that accounting for reduced mixing efficiencies in regions of weak stratification or energetic turbulence (high Reb) strongly limits the ability of breaking internal waves to supply oceanic potential energy and drive abyssal upwelling. Moving from a fixed Rf = 1/6 to a variable efficiency Rf(Reb) causes Antarctic Bottom Water upwelling induced by locally-dissipating internal tides and lee waves to fall from 9 to 4 Sv, and the corresponding potential energy source to plunge from 97 to 44 GW. When adding the contribution of remotely-dissipating internal tides under idealized distributions of energy dissipation, the total rate of Antarctic Bottom Water upwelling is reduced by about a factor of 2, reaching 5-15 Sv compared to 10-33 Sv for a fixed efficiency. Our results suggest that distributed mixing, overflow-related boundary processes and geothermal heating are more effective in consuming abyssal waters than topographically-enhanced mixing by breaking internal waves. Our calculations also point to the importance of accurately constraining Rf(Reb) and including the effect in ocean models.}, 
     809   journal = {Journal of Physical Oceanography}, 
     810   author = {C. de Lavergne and G. Madec and J. Le Sommer and A. J. G. Nurser and A. C. Naveira Garabato }, 
     811   year = {2016}, 
     812   volume = {46},  pages = {663-–681} 
     813} 
     814 
    755815@ARTICLE{Delecluse_Madec_Bk00, 
    756816  author = {P. Delecluse and G. Madec}, 
     
    763823} 
    764824 
     825@PHDTHESIS{Demange_PhD2014, 
     826  author = {J. Demange}, 
     827  title = {Sch\'{e}́mas num\'{e}́riques d'advection et de propagation d’ondes de gravit\'{e}́  
     828           dans les mod\`{e}les de circulation oc\'{e}́anique.}, 
     829  school = {Doctorat es Applied Mathematiques, Grenoble University, France}, 
     830  year = {2014}, 
     831  pages = {138pp} 
     832} 
    765833 
    766834@ARTICLE{Dobricic_al_OS07, 
     
    9831051  author = {M. Farge}, 
    9841052  title = {Dynamique non lineaire des ondes et des tourbillons dans les equations de Saint Venant}, 
    985   school = {Doctorat es Mathematiques, Paris VI University}, 
     1053  school = {Doctorat es Mathematiques, Paris VI University, France}, 
    9861054  year = {1987}, 
    9871055  pages = {401pp} 
     
    10591127  volume = {20},  number = {1}, 
    10601128  pages = {150--155}, 
     1129} 
     1130 
     1131@Article{Gentemann_al_JGR09, 
     1132  author =   {C. L. Gentemann  and P. J. Minnett and B. Ward}, 
     1133  title =        {Profiles of Ocean Surface heating ({POSH}): A new model  
     1134                  of upper ocean diurnal warming}, 
     1135  journal =     JGR, 
     1136  year =     {2009}, 
     1137  Volume =   {114}, 
     1138  Pages =    {C07017}, 
     1139  doi =   {10.1029/2008JC004825}, 
     1140  OPTannote =   {} 
    10611141} 
    10621142 
     
    11041184} 
    11051185 
     1186@article{goff_JGR2010, 
     1187   author = {J. A. Goff}, 
     1188   title = {Global prediction of abyssal hill root-mean-square heights from small-scale altimetric gravity variability}, 
     1189   issn = {2156-2202}, 
     1190   url = {http://dx.doi.org/10.1029/2010JB007867}, 
     1191   doi = {10.1029/2010JB007867}, 
     1192   abstract = {Abyssal hills, which are pervasive landforms on the seafloor of the Earth's oceans, represent a potential tectonic record of the history of mid-ocean ridge spreading. However, the most detailed global maps of the seafloor, derived from the satellite altimetry-based gravity field, cannot be used to deterministically characterize such small-scale ({\textless}10 km) morphology. Nevertheless, the small-scale variability of the gravity field can be related to the statistical properties of abyssal hill morphology using the upward continuation formulation. In this paper, I construct a global prediction of abyssal hill root-mean-square (rms) heights from the small-scale variability of the altimetric gravity field. The abyssal hill-related component of the gravity field is derived by first masking distinct features, such as seamounts, mid-ocean ridges, and continental margins, and then applying a newly designed adaptive directional filter algorithm to remove fracture zone/discontinuity fabric. A noise field is derived empirically by correlating the rms variability of the small-scale gravity field to the altimetric noise field in regions of very low relief, and the noise variance is subtracted from the small-scale gravity variance. Suites of synthetically derived, abyssal hill formed gravity fields are generated as a function of water depth, basement rms heights, and sediment thickness and used to predict abyssal hill seafloor rms heights from corrected small-scale gravity rms height. The resulting global prediction of abyssal hill rms heights is validated qualitatively by comparing against expected variations in abyssal hill morphology and quantitatively by comparing against actual measurements of rms heights. Although there is scatter, the prediction appears unbiased.}, 
     1193   volume = {115}, 
     1194   number = {B12}, 
     1195   journal = {Journal of Geophysical Research: Solid Earth}, 
     1196   year = {2010}, 
     1197   pages = {B12104}, 
     1198} 
     1199 
    11061200@ARTICLE{Goosse_al_JGR99, 
    11071201  author = {H. Goosse and E. Deleersnijder and T. Fichefet and M. England}, 
     
    11221216  doi = {10.1029/2006GL028210}, 
    11231217  url = {http://dx.doi.org/10.1029/2006GL028210} 
     1218} 
     1219 
     1220@ARTICLE{Graham_McDougall_JPO13, 
     1221  author = {F.S. Graham and T.J. McDougall}, 
     1222  title = {Quantifying the nonconservative production of conservative temperature, potential temperature, and entropy}, 
     1223  journal = JPO, 
     1224  year = {2013}, 
     1225  volume = {43}, 
     1226  pages = {838--862}, 
     1227  url ={http://dx.doi.org/10.1175/JPO-D-11-0188.1} 
    11241228} 
    11251229 
     
    11971301} 
    11981302 
     1303@ARTICLE{Griffies_Hallberg_MWR00, 
     1304  author = {S.M. Griffies and R.H. Hallberg}, 
     1305  title = {Biharmonic friction with a Smagorinsky-like viscosity for use in large-scale eddy-permitting ocean models}, 
     1306  journal = MWR, 
     1307  year = {2000}, 
     1308  volume = {128},   
     1309  pages = {2935–-2946}, 
     1310 url = {http://dx.doi.org/10.1175/1520-0493(2000)128} 
     1311} 
     1312 
    11991313@ARTICLE{Guilyardi_al_JC04, 
    12001314  author = {E. Guilyardi and S. Gualdi and J. M. Slingo and A. Navarra and P. Delecluse  
     
    13471461} 
    13481462 
     1463@ARTICLE{Holland1999,  
     1464  author = {D. Holland and A. Jenkins}, 
     1465  title = {Modeling Thermodynamic Ice-Ocean Interactions at the Base of an Ice Shelf}, 
     1466  journal = JPO, 
     1467  year = {1999}, 
     1468  volume = {29},   
     1469  pages = {1787--1800}, 
     1470} 
     1471 
    13491472@ARTICLE{HollowayOM86, 
    13501473  author = {Greg Holloway}, 
     
    14301553} 
    14311554 
     1555@TechReport{Hunter2006, 
     1556  Title                    = {Specification for Test Models of Ice Shelf Cavities}, 
     1557  Author                   = {J. R. Hunter}, 
     1558  Institution              = {Antarctic Climate \& Ecosystems Cooperative Research Centre Private Bag 80, Hobart, Tasmania 7001}, 
     1559  Year                     = {2006}, 
     1560} 
     1561 
     1562@TECHREPORT{TEOS10, 
     1563  author = {IOC and SCOR and IAPSO}, 
     1564  title = {The international thermodynamic equation of seawater - 2010: Calculation and use of thermodynamic properties}, 
     1565  institution = {Intergovernmental Oceanographic Commission}, 
     1566  publisher = {Manuals and Guides No. 56, UNESCO (English)}, 
     1567  year = {2010}, 
     1568  pages = {196pp}, 
     1569  url = {http://www.teos-10.org/pubs/TEOS-10_Manual.pdf} 
     1570} 
     1571 
    14321572@ARTICLE{Iudicone_al_JPO08b, 
    14331573  author = {D. Iudicone and G. Madec and B. Blanke and S. Speich}, 
     
    14861626} 
    14871627 
     1628@article{Jackson_Rehmann_JPO2014, 
     1629   author = {P. R. Jackson and C. R. Rehmann}, 
     1630   title = {Experiments on differential scalar mixing in turbulence in a sheared, stratified flow}, 
     1631   journal = JPO, 
     1632   volume = {44}, 
     1633   issn = {0022-3670}, 
     1634   url = {http://dx.doi.org/10.1175/JPO-D-14-0027.1}, 
     1635   doi = {10.1175/JPO-D-14-0027.1}, 
     1636   number = {10}, 
     1637   year = {2014}, 
     1638   pages = {2661--2680}, 
     1639} 
     1640 
    14881641@ARTICLE{Jayne_St_Laurent_GRL01, 
    14891642  author = {S.R. Jayne and L.C. {St. Laurent}}, 
     
    14911644  journal = GRL, 
    14921645  pages = {811--814} 
     1646} 
     1647 
     1648@ARTICLE{Jenkins1991, 
     1649  author = {A. Jenkins}, 
     1650  title = {A one-dimensional model of ice shelf-ocean interaction}, 
     1651  journal = JGR, 
     1652  year = {1991}, 
     1653  volume = {96},  number = {C11}, 
     1654  pages = {2298--2312} 
     1655} 
     1656 
     1657@ARTICLE{Jenkins2001, 
     1658  author = {A. Jenkins}, 
     1659  title = {The Role of Meltwater Advection in the Formulation of Conservative Boundary Conditions at an Ice-Ocean Interface}, 
     1660  journal = JPO, 
     1661  year = {2001}, 
     1662  volume = {31}, 
     1663  pages = {285--296} 
     1664} 
     1665 
     1666@ARTICLE{Jenkins2010, 
     1667  author = {A. Jenkins}, 
     1668  title = {observation and parameterization of ablation at the base of Ronne Ice Shelf, Antarctica}, 
     1669  journal = JPO, 
     1670  year = {2010}, 
     1671  volume = {40},  number = {10}, 
     1672  pages = {2298--2312} 
    14931673} 
    14941674 
     
    16431823} 
    16441824 
     1825@article{Lemarie_OM2012, 
     1826author = "F. Lemari\'{e} and L. Debreu and A.F. Shchepetkin and J.C. McWilliams", 
     1827title = "On the stability and accuracy of the harmonic and biharmonic isoneutral mixing operators in ocean models ", 
     1828journal = OM, 
     1829year = "2012", 
     1830volume = "52–53", pages = "9--35", 
     1831issn = "1463-5003", 
     1832doi = "http://dx.doi.org/10.1016/j.ocemod.2012.04.007", 
     1833url = "http://www.sciencedirect.com/science/article/pii/S1463500312000674", 
     1834} 
     1835 
     1836 
     1837@ARTICLE{Lemarie_OM2015, 
     1838  author = {F. Lemari\'{e} and L. Debreu and J. Demange and  G. Madec and J.M. Molines and M. Honnorat}, 
     1839  title = {Stability Constraints for Oceanic Numerical Models:  
     1840           Implications for the Formulation of time and space Discretizations}, 
     1841  journal = OM, 
     1842  year = {2015}, 
     1843  volume = {92},  
     1844  pages = {124--148}, 
     1845  doi = {10.1016/j.ocemod.2015.06.006}, 
     1846  url = {http://dx.doi.org/10.1016/j.ocemod.2015.06.006} 
     1847} 
     1848 
    16451849@ARTICLE{Lermusiaux2001, 
    16461850  author = {P. F. J. Lermusiaux}, 
     
    16551859  author = {M. L\'{e}vy}, 
    16561860  title = {Mod\'{e}lisation des processus biog\'{e}ochimiques en M\'{e}diterran\'{e}e 
    1657    nord-occidentale. Cycle saisonnier et variabilit\'{e} m\'{e}so\'{e}chelle}, 
     1861           nord-occidentale. Cycle saisonnier et variabilit\'{e} m\'{e}so\'{e}chelle}, 
    16581862  school = {Universit\'{e} Pierre et Marie Curie, Paris, France, 207pp}, 
    16591863  year = {1996} 
     
    17831987  year = {2009}, 
    17841988  volume = {30},  number = {2-3}, 
    1785   pages = {88-94}, 
     1989  pages = {88--94}, 
    17861990  doi = {10.1016/j.ocemod.2009.06.006}, 
    1787   url = {http://dx.doi.org/} 
    1788 } 
    1789  
    1790 @ARTICLE{Leclair_Madec_OM10s, 
     1991  url = {http://dx.doi.org/10.1016/j.ocemod.2009.06.006} 
     1992} 
     1993 
     1994@ARTICLE{Leclair_Madec_OM11, 
    17911995  author = {M. Leclair and G. Madec}, 
    17921996  title = {$\tilde{z}$-coordinate, an Arbitrary Lagrangian-Eulerian coordinate separating high and low frequency}, 
    17931997  journal = OM, 
    1794   year = {2010}, 
    1795   pages = {submitted}, 
     1998  year = {2011}, 
     1999  volume = {37},  pages = {139--152},  
     2000  doi = {10.1016/j.ocemod.2011.02.001}, 
     2001  url = {http://dx.doi.org/10.1016/j.ocemod.2011.02.001} 
     2002} 
     2003 
     2004@ARTICLE{Lele_JCP1992, 
     2005  author = {S.K. Lele}, 
     2006  title = {Compact finite difference schemes with spectral-like resolution}, 
     2007  journal = JCP, 
     2008  year = {1992}, 
     2009  volume = {103}, pages = {16--42} 
    17962010} 
    17972011 
     
    18032017  journal = JC, 
    18042018  year = {2003}, 
    1805   volume = {16},  number = {20}, 
    1806   pages = {3330--3343} 
     2019  volume = {16},  number = {20}, pages = {3330--3343} 
    18072020} 
    18082021 
     
    19002113} 
    19012114 
     2115@ARTICLE{Losch2008, 
     2116  author = {M. Losch}, 
     2117  title = {Modeling ice shelf cavities in a z coordinate ocean general circulation model}, 
     2118  journal = JGR, 
     2119  year = {2008}, 
     2120  volume = {113},  number = {C13}, 
     2121} 
     2122 
    19022123@TECHREPORT{Lott1989, 
    19032124  author = {F. Lott and G. Madec}, 
     
    20742295  volume = {3}, 
    20752296  pages = {1--20} 
    2076 } 
    2077  
    2078  
    2079 @article{Martin_Adcroft_OM10, 
    2080 author = {T. Martin and A. Adcroft}, 
    2081 title = {Parameterizing the fresh-water flux from land ice to ocean with interactive icebergs in a coupled climate model}, 
    2082 journal = OM, 
    2083 year = {2010}, 
    2084 volume = {34}, number = {3--4}, 
    2085 pages = {111--124}, 
    2086 issn = {1463-5003}, 
    2087 doi = {10.1016/j.ocemod.2010.05.001}, 
    2088 url = {http://dx.doi.org/10.1016/j.ocemod.2010.05.001} 
    20892297} 
    20902298 
     
    21002308  doi = {10.1016/j.ocemod.2007.07.005}, 
    21012309  url = {http://dx.doi.org/10.1016/j.ocemod.2007.07.005} 
     2310} 
     2311 
     2312@Article{Marsh_GMD2015, 
     2313AUTHOR = {R. Marsh and V. O. Ivchenko and N. Skliris and S. Alderson and G. R. Bigg and G. Madec and A. T. Blaker and Y. Aksenov and B. Sinha and A. C. Coward and J. Le Sommer and N. Merino and V. B. Zalesny}, 
     2314TITLE = {NEMO-ICB (v1.0): interactive icebergs in the NEMO ocean model globally configured at eddy-permitting resolution}, 
     2315JOURNAL = {Geoscientific Model Development}, 
     2316VOLUME = {8}, 
     2317YEAR = {2015}, 
     2318NUMBER = {5}, 
     2319PAGES = {1547--1562}, 
     2320url = {HTTP://www.geosci-model-dev.net/8/1547/2015/}, 
     2321DOI = {10.5194/gmd-8-1547-2015} 
     2322} 
     2323 
     2324@article{Martin_Adcroft_OM10, 
     2325author = {T. Martin and A. Adcroft}, 
     2326title = {Parameterizing the fresh-water flux from land ice to ocean with interactive icebergs in a coupled climate model}, 
     2327journal = OM, 
     2328year = {2010}, 
     2329volume = {34}, number = {3--4}, 
     2330pages = {111--124}, 
     2331issn = {1463-5003}, 
     2332doi = {10.1016/j.ocemod.2010.05.001}, 
     2333url = {http://dx.doi.org/10.1016/j.ocemod.2010.05.001} 
    21022334} 
    21032335 
     
    22492481} 
    22502482 
     2483 
     2484@ARTICLE{Morel_Berthon_LO89, 
     2485  author = {A. Morel and J.-F. Berthon}, 
     2486  title = {Surface pigments, algal biomass profiles, and potential production of the euphotic layer:  
     2487           Relationships reinvestigated in view of remote-sensing applications}, 
     2488  journal = {Limnol. Oceanogr.}, 
     2489  year = {1989}, 
     2490  volume = {34(8)}, 
     2491  pages = {1545--1562} 
     2492} 
     2493 
    22512494@ARTICLE{Morel_Maritorena_JGR01, 
    22522495  author = {A. Morel and S. Maritorena}, 
     
    22972540  title = {Estimates of the local rate of vertical diffusion from dissipation measurements}, 
    22982541  journal = JPO, 
     2542  year = {1980}, 
    22992543  volume = {10}, 
    23002544  pages = {83--89} 
     
    24702714} 
    24712715 
     2716@Article{Rodgers_2014, 
     2717AUTHOR = {Rodgers, K. B. and Aumont, O. and Mikaloff Fletcher, S. E. and Plancherel, Y. and Bopp, L. and de Boyer Mont\'egut, C. and Iudicone, D. and Keeling, R. F. and Madec, G. and Wanninkhof, R.}, 
     2718TITLE = {Strong sensitivity of Southern Ocean carbon uptake and nutrient cycling to wind stirring}, 
     2719JOURNAL = {Biogeosciences}, 
     2720VOLUME = {11}, 
     2721YEAR = {2014}, 
     2722NUMBER = {15}, 
     2723PAGES = {4077--4098}, 
     2724URL = {HTTP://www.biogeosciences.net/11/4077/2014/}, 
     2725DOI = {10.5194/bg-11-4077-2014} 
     2726} 
     2727 
    24722728@ARTICLE{Rodi_1987, 
    24732729  author = {W. Rodi}, 
     
    24862742  year = {1986}, 
    24872743  editor = {J.J. O'Brien} 
     2744} 
     2745 
     2746@article{Roquet_OM2015, 
     2747author = "F. Roquet and G. Madec and T.J. McDougall and P.M. Barker", 
     2748title = "Accurate polynomial expressions for the density and specific volume of seawater using the TEOS-10 standard ", 
     2749journal = OM, 
     2750volume = "90", 
     2751pages = "29--43", 
     2752year = "2015", 
     2753issn = "1463-5003", 
     2754doi = "10.1016/j.ocemod.2015.04.002", 
     2755url = "http://dx.doi.org/10.1016/j.ocemod.2015.04.002" 
     2756} 
     2757 
     2758@article{Roquet_JPO2015, 
     2759author = "F. Roquet and G. Madec and L. Brodeau and J. Nycander", 
     2760title = "Defining a Simplified Yet Realistic Equation of State for Seawater", 
     2761journal = JPO, 
     2762volume = "45", 
     2763pages = "2564--2579", 
     2764year = "2015", 
     2765doi = "10.1175/JPO-D-15-0080.1", 
     2766url = "http://dx.doi.org/10.1175/JPO-D-15-0080.1" 
    24882767} 
    24892768 
     
    24982777} 
    24992778 
     2779@ARTICLE{Rousset_GMD2015, 
     2780  author = {C. Rousset and M. Vancoppenolle and G. Madec and T. Fichefet and S. Flavoni  
     2781            and A. Barth\'{e}lemy and R. Benshila and J. Chanut and C. L\'{e}vy and S. Masson and F. Vivier }, 
     2782  title  = {The Louvain-La-Neuve sea-ice model LIM3.6: Global and regional capabilities}, 
     2783  journal= {Geoscientific Model Development}, 
     2784  year = {2015}, 
     2785  volume = {8}, pages={2991--3005}, 
     2786  doi = {10.5194/gmd-8-2991-2015}, 
     2787  url = {http://dx.doi.org/10.5194/gmd-8-2991-2015} 
     2788} 
     2789 
    25002790@ARTICLE{Sadourny1975, 
    25012791  author = {R. Sadourny}, 
     
    25142804  volume = {87}, 
    25152805  pages = {394--409} 
     2806} 
     2807 
     2808@ARTICLE{Saunders_JAS82, 
     2809  author={P. M. Saunders}, 
     2810  title={{The Temperature at the Ocean-air Interface}}, 
     2811  journal=JAS, 
     2812  year={1967}, 
     2813  volume={24}, 
     2814  pages={269-273}, 
     2815  doi = {10.1175/1520-0469(1967)024<0269:TTATOA>2.0.CO;2}, 
    25162816} 
    25172817 
     
    25702870} 
    25712871 
     2872@INBOOK{Smagorinsky_93, 
     2873  author = {Smagorinsky, J.}, 
     2874  chapter = {Some historical remarks on the use of non-linear viscosities}, 
     2875  title = {Large Eddy Simulation of Complex Engineering and Geophysical Flows}, 
     2876  pages = {3--36}, 
     2877  year = {1993}, 
     2878  publisher = {Cambridge University Press, B. Galperin and S. A. Orszag (eds.)}, 
     2879} 
     2880 
    25722881@ARTICLE{Song_Haidvogel_JCP94, 
    25732882  author = {Y. Song and D. Haidvogel}, 
     
    26882997  volume = {359}, 
    26892998  pages = {123--129} 
     2999} 
     3000 
     3001@ARTICLE{Takaya_al_JGR10, 
     3002  author = {Y. Takaya and J-R. Bidlot and A. C. M. Beljaars and  
     3003                  P. A. E. M. Janssen}, 
     3004  title = {Refinements to a prognostic scheme of sea surface skin temperature}, 
     3005  journal = JGR, 
     3006  year   =   {2010}, 
     3007  Volume =   {115}, 
     3008  Pages  =   {C06009}, 
     3009  doi    = {10.1029/2009JC005985}, 
    26903010} 
    26913011 
     
    27933113} 
    27943114 
     3115@ARTICLE{Tu_Tsuang_GRL05, 
     3116  title={{Cool-skin simulation by a one-column ocean model}}, 
     3117  author={{C-Y}. Tu  and {B-J}. Tsuang}, 
     3118  journal=GRL, 
     3119  year={2005}, 
     3120  volume={32}, 
     3121  pages={L22602}, 
     3122  doi = {10.1029/2005GL024252}, 
     3123} 
     3124 
    27953125@ARTICLE{Umlauf_Burchard_JMS03, 
    27963126  author = {L. Umlauf and H. Burchard}, 
     
    28423172  volume = {27}, 
    28433173  pages = {54--69} 
     3174} 
     3175 
     3176@book{Vallis06, 
     3177author = {Vallis, G. K.}, 
     3178title = {Atmospheric and Oceanic Fluid Dynamics}, 
     3179publisher = {Cambridge University Press}, 
     3180address = {Cambridge, U.K.}, 
     3181year = {2006}, 
     3182pages = {745}, 
    28443183} 
    28453184 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Chapters/Abstracts_Foreword.tex

    r3294 r6436  
    1313be a flexible tool for studying the ocean and its interactions with the others components of  
    1414the earth climate system over a wide range of space and time scales.  
    15 Prognostic variables are the three-dimensional velocity field, a linear  
    16 or non-linear sea surface height, the temperature and the salinity. In the horizontal direction,  
    17 the model uses a curvilinear orthogonal grid and in the vertical direction, a full or partial step  
    18 $z$-coordinate, or $s$-coordinate, or a mixture of the two. The distribution of variables is a  
    19 three-dimensional Arakawa C-type grid. Various physical choices are available to describe  
    20 ocean physics, including TKE, GLS and KPP vertical physics. Within NEMO, the ocean is  
    21 interfaced with a sea-ice model (LIM v2 and v3), passive tracer and biogeochemical models (TOP)  
    22 and, via the OASIS coupler, with several atmospheric general circulation models. It also  
    23 support two-way grid embedding via the AGRIF software. 
     15Prognostic variables are the three-dimensional velocity field, a non-linear sea surface height,  
     16the \textit{Conservative} Temperature and the \textit{Absolute} Salinity.  
     17In the horizontal direction, the model uses a curvilinear orthogonal grid and in the vertical direction,  
     18a full or partial step $z$-coordinate, or $s$-coordinate, or a mixture of the two.  
     19The distribution of variables is a three-dimensional Arakawa C-type grid.  
     20Various physical choices are available to describe ocean physics, including TKE, and GLS vertical physics.  
     21Within NEMO, the ocean is interfaced with a sea-ice model (LIM or CICE), passive tracer and  
     22biogeochemical models (TOP) and, via the OASIS coupler, with several atmospheric general circulation models.  
     23It also support two-way grid embedding via the AGRIF software. 
    2424 
    2525% ================================================================ 
     
    3131interactions avec les autres composantes du syst\`{e}me climatique terrestre.  
    3232Les variables pronostiques sont le champ tridimensionnel de vitesse, une hauteur de la mer  
    33 lin\'{e}aire ou non, la temperature et la salinit\'{e}.  
     33lin\'{e}aire, la Temp\'{e}rature Conservative et la Salinit\'{e} Absolue.  
    3434La distribution des variables se fait sur une grille C d'Arakawa tridimensionnelle utilisant une  
    3535coordonn\'{e}e verticale $z$ \`{a} niveaux entiers ou partiels, ou une coordonn\'{e}e s, ou encore  
    3636une combinaison des deux. Diff\'{e}rents choix sont propos\'{e}s pour d\'{e}crire la physique  
    37 oc\'{e}anique, incluant notamment des physiques verticales TKE, GLS et KPP. A travers l'infrastructure  
    38 NEMO, l'oc\'{e}an est interfac\'{e} avec des mod\`{e}les de glace de mer, de biog\'{e}ochimie  
    39 et de traceurs passifs, et, via le coupleur OASIS, \`{a} plusieurs mod\`{e}les de circulation  
    40 g\'{e}n\'{e}rale atmosph\'{e}rique. Il supporte \'{e}galement l'embo\^{i}tement interactif de  
    41 maillages via le logiciel AGRIF. 
     37oc\'{e}anique, incluant notamment des physiques verticales TKE et GLS. A travers l'infrastructure  
     38NEMO, l'oc\'{e}an est interfac\'{e} avec des mod\`{e}les de glace de mer (LIM ou CICE),  
     39de biog\'{e}ochimie marine et de traceurs passifs, et, via le coupleur OASIS, \`{a} plusieurs  
     40mod\`{e}les de circulation g\'{e}n\'{e}rale atmosph\'{e}rique.  
     41Il supporte \'{e}galement l'embo\^{i}tement interactif de maillages via le logiciel AGRIF. 
    4242}  
    4343 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Chapters/Annex_C.tex

    r3294 r6436  
    410410\end{aligned}   } \right. 
    411411\end{equation}  
    412 where the indices $i_p$ and $k_p$ take the following value:  
     412where the indices $i_p$ and $j_p$ take the following value:  
    413413$i_p = -1/2$ or $1/2$ and $j_p = -1/2$ or $1/2$, 
    414414and the vorticity triads, ${^i_j}\mathbb{Q}^{i_p}_{j_p}$, defined at $T$-point, are given by:  
     
    11031103The discrete formulation of the horizontal diffusion of momentum ensures the  
    11041104conservation of potential vorticity and the horizontal divergence, and the  
    1105 dissipation of the square of these quantities (i.e. enstrophy and the  
     1105dissipation of the square of these quantities ($i.e.$ enstrophy and the  
    11061106variance of the horizontal divergence) as well as the dissipation of the  
    11071107horizontal kinetic energy. In particular, when the eddy coefficients are  
     
    11271127&\int \limits_D \frac{1} {e_3 } \textbf{k} \cdot \nabla \times  
    11281128   \Bigl[    \nabla_h  \left( A^{\,lm}\;\chi  \right) 
    1129              - \nabla_h \times \left( A^{\,lm}\;\zeta \; \textbf{k} \right)    \Bigr]\;dv  = 0 
    1130 \end{flalign*} 
     1129           - \nabla_h \times \left( A^{\,lm}\;\zeta \; \textbf{k} \right)    \Bigr]\;dv   \\  
     1130%\end{flalign*} 
    11311131%%%%%%%%%%  recheck here....  (gm) 
    1132 \begin{flalign*} 
    1133 = \int \limits_D  -\frac{1} {e_3 } \textbf{k} \cdot \nabla \times  
    1134    \Bigl[ \nabla_h \times \left( A^{\,lm}\;\zeta \; \textbf{k} \right)  \Bigr]\;dv &&& \\  
    1135 \end{flalign*} 
    1136 \begin{flalign*} 
     1132%\begin{flalign*} 
     1133=& \int \limits_D  -\frac{1} {e_3 } \textbf{k} \cdot \nabla \times  
     1134   \Bigl[ \nabla_h \times \left( A^{\,lm}\;\zeta \; \textbf{k} \right)  \Bigr]\;dv \\  
     1135%\end{flalign*} 
     1136%\begin{flalign*} 
    11371137\equiv& \sum\limits_{i,j} 
    11381138   \left\{ 
    1139    \delta_{i+1/2}  
    1140    \left[  
    1141    \frac {e_{2v}} {e_{1v}\,e_{3v}}  \delta_i 
    1142       \left[ A_f^{\,lm} e_{3f} \zeta  \right] 
    1143     \right] 
    1144    + \delta_{j+1/2}  
    1145    \left[  
    1146    \frac {e_{1u}} {e_{2u}\,e_{3u}} \delta_j  
    1147       \left[ A_f^{\,lm} e_{3f} \zeta  \right] 
    1148    \right] 
    1149    \right\}  
    1150    && \\  
     1139     \delta_{i+1/2} \left[  \frac {e_{2v}} {e_{1v}\,e_{3v}}  \delta_i \left[ A_f^{\,lm} e_{3f} \zeta  \right]  \right] 
     1140   + \delta_{j+1/2} \left[  \frac {e_{1u}} {e_{2u}\,e_{3u}}  \delta_j \left[ A_f^{\,lm} e_{3f} \zeta  \right]  \right] 
     1141   \right\}     \\  
    11511142% 
    11521143\intertext{Using \eqref{DOM_di_adj}, it follows:} 
     
    11541145\equiv& \sum\limits_{i,j,k}  
    11551146   -\,\left\{ 
    1156       \frac{e_{2v}} {e_{1v}\,e_{3v}}  \delta_i 
    1157       \left[ A_f^{\,lm} e_{3f} \zeta  \right]\;\delta_i \left[ 1\right] 
    1158    + \frac{e_{1u}} {e_{2u}\,e_{3u}} \delta_j  
    1159       \left[ A_f^{\,lm} e_{3f} \zeta  \right]\;\delta_j \left[ 1\right] 
     1147      \frac{e_{2v}} {e_{1v}\,e_{3v}}  \delta_i  \left[ A_f^{\,lm} e_{3f} \zeta  \right]\;\delta_i \left[ 1\right] 
     1148    + \frac{e_{1u}} {e_{2u}\,e_{3u}}  \delta_j  \left[ A_f^{\,lm} e_{3f} \zeta  \right]\;\delta_j \left[ 1\right] 
    11601149   \right\} \quad \equiv 0  
    1161    && \\  
     1150    \\  
    11621151\end{flalign*} 
    11631152 
     
    11671156\subsection{Dissipation of Horizontal Kinetic Energy} 
    11681157\label{Apdx_C.3.2} 
    1169  
    11701158 
    11711159The lateral momentum diffusion term dissipates the horizontal kinetic energy: 
     
    12211209\label{Apdx_C.3.3} 
    12221210 
    1223  
    12241211The lateral momentum diffusion term dissipates the enstrophy when the eddy  
    12251212coefficients are horizontally uniform: 
     
    12281215   \left[   \nabla_h \left( A^{\,lm}\;\chi  \right) 
    12291216          - \nabla_h \times \left( A^{\,lm}\;\zeta \; \textbf{k} \right)   \right]\;dv &&&\\ 
    1230 &= A^{\,lm} \int \limits_D \zeta \textbf{k} \cdot \nabla \times  
     1217&\quad = A^{\,lm} \int \limits_D \zeta \textbf{k} \cdot \nabla \times  
    12311218   \left[    \nabla_h \times \left( \zeta \; \textbf{k} \right)   \right]\;dv &&&\\ 
    1232 &\equiv A^{\,lm} \sum\limits_{i,j,k}  \zeta \;e_{3f}  
     1219&\quad \equiv A^{\,lm} \sum\limits_{i,j,k}  \zeta \;e_{3f}  
    12331220   \left\{     \delta_{i+1/2} \left[  \frac{e_{2v}} {e_{1v}\,e_{3v}} \delta_i \left[ e_{3f} \zeta  \right]   \right] 
    12341221             + \delta_{j+1/2} \left[  \frac{e_{1u}} {e_{2u}\,e_{3u}} \delta_j \left[ e_{3f} \zeta  \right]   \right]      \right\}   &&&\\  
     
    12361223\intertext{Using \eqref{DOM_di_adj}, it follows:} 
    12371224% 
    1238 &\equiv  - A^{\,lm} \sum\limits_{i,j,k}  
     1225&\quad \equiv  - A^{\,lm} \sum\limits_{i,j,k}  
    12391226   \left\{    \left(  \frac{1} {e_{1v}\,e_{3v}}  \delta_i \left[ e_{3f} \zeta  \right]  \right)^2   b_v 
    1240             + \left(  \frac{1} {e_{2u}\,e_{3u}}  \delta_j \left[ e_{3f} \zeta  \right] \right)^2   b_u  \right\}      &&&\\ 
    1241 & \leq \;0       &&&\\  
     1227            + \left(  \frac{1} {e_{2u}\,e_{3u}}  \delta_j \left[ e_{3f} \zeta  \right] \right)^2   b_u  \right\}  \quad \leq \;0    &&&\\ 
    12421228\end{flalign*} 
    12431229 
     
    12501236When the horizontal divergence of the horizontal diffusion of momentum  
    12511237(discrete sense) is taken, the term associated with the vertical curl of the  
    1252 vorticity is zero locally, due to (!!! II.1.8  !!!!!). The resulting term conserves the  
    1253 $\chi$ and dissipates $\chi^2$ when the eddy coefficients are  
    1254 horizontally uniform. 
     1238vorticity is zero locally, due to \eqref{Eq_DOM_div_curl}.  
     1239The resulting term conserves the $\chi$ and dissipates $\chi^2$  
     1240when the eddy coefficients are horizontally uniform. 
    12551241\begin{flalign*} 
    12561242& \int\limits_D  \nabla_h \cdot  
    12571243   \Bigl[     \nabla_h \left( A^{\,lm}\;\chi \right) 
    12581244             - \nabla_h \times \left( A^{\,lm}\;\zeta \;\textbf{k} \right)    \Bigr]  dv 
    1259 = \int\limits_D  \nabla_h \cdot \nabla_h \left( A^{\,lm}\;\chi  \right)   dv   &&&\\ 
     1245= \int\limits_D  \nabla_h \cdot \nabla_h \left( A^{\,lm}\;\chi  \right)   dv   \\ 
    12601246% 
    12611247&\equiv \sum\limits_{i,j,k}  
    12621248   \left\{   \delta_i \left[ A_u^{\,lm} \frac{e_{2u}\,e_{3u}} {e_{1u}}  \delta_{i+1/2} \left[ \chi \right]  \right] 
    1263            + \delta_j \left[ A_v^{\,lm} \frac{e_{1v}\,e_{3v}} {e_{2v}}  \delta_{j+1/2} \left[ \chi \right]  \right]    \right\}    &&&\\  
     1249           + \delta_j \left[ A_v^{\,lm} \frac{e_{1v}\,e_{3v}} {e_{2v}}  \delta_{j+1/2} \left[ \chi \right]  \right]    \right\}    \\  
    12641250% 
    12651251\intertext{Using \eqref{DOM_di_adj}, it follows:} 
     
    12671253&\equiv \sum\limits_{i,j,k}  
    12681254   - \left\{   \frac{e_{2u}\,e_{3u}} {e_{1u}}  A_u^{\,lm} \delta_{i+1/2} \left[ \chi \right] \delta_{i+1/2} \left[ 1 \right]  
    1269              + \frac{e_{1v}\,e_{3v}}  {e_{2v}}  A_v^{\,lm} \delta_{j+1/2} \left[ \chi \right] \delta_{j+1/2} \left[ 1 \right]    \right\}  
    1270    \qquad \equiv 0     &&& \\  
     1255             + \frac{e_{1v}\,e_{3v}} {e_{2v}}  A_v^{\,lm} \delta_{j+1/2} \left[ \chi \right] \delta_{j+1/2} \left[ 1 \right]    \right\}  
     1256   \quad \equiv 0      \\  
    12711257\end{flalign*} 
    12721258 
     
    12811267   \left[    \nabla_h              \left( A^{\,lm}\;\chi                    \right) 
    12821268           - \nabla_h   \times  \left( A^{\,lm}\;\zeta \;\textbf{k} \right)    \right]\;  dv 
    1283  = A^{\,lm}   \int\limits_D \chi \;\nabla_h \cdot \nabla_h \left( \chi \right)\;  dv    &&&\\  
     1269 = A^{\,lm}   \int\limits_D \chi \;\nabla_h \cdot \nabla_h \left( \chi \right)\;  dv    \\  
    12841270% 
    12851271&\equiv A^{\,lm}  \sum\limits_{i,j,k}  \frac{1} {e_{1t}\,e_{2t}\,e_{3t}}  \chi  
     
    12871273      \delta_i  \left[   \frac{e_{2u}\,e_{3u}} {e_{1u}}  \delta_{i+1/2} \left[ \chi \right]   \right] 
    12881274   + \delta_j  \left[   \frac{e_{1v}\,e_{3v}} {e_{2v}}   \delta_{j+1/2} \left[ \chi \right]   \right] 
    1289    \right\} \;   e_{1t}\,e_{2t}\,e_{3t}    &&&\\  
     1275   \right\} \;   e_{1t}\,e_{2t}\,e_{3t}    \\  
    12901276% 
    12911277\intertext{Using \eqref{DOM_di_adj}, it turns out to be:} 
     
    12931279&\equiv - A^{\,lm} \sum\limits_{i,j,k} 
    12941280   \left\{    \left(  \frac{1} {e_{1u}}  \delta_{i+1/2}  \left[ \chi \right]  \right)^2  b_u 
    1295                  + \left(  \frac{1} {e_{2v}}  \delta_{j+1/2}  \left[ \chi \right]  \right)^2  b_v    \right\} \;    &&&\\ 
    1296 % 
    1297 &\leq 0              &&&\\ 
     1281            + \left(  \frac{1} {e_{2v}}  \delta_{j+1/2}  \left[ \chi \right]  \right)^2  b_v    \right\}     
     1282\quad \leq 0             \\ 
    12981283\end{flalign*} 
    12991284 
     
    13031288\section{Conservation Properties on Vertical Momentum Physics} 
    13041289\label{Apdx_C_4} 
    1305  
    13061290 
    13071291As for the lateral momentum physics, the continuous form of the vertical diffusion  
     
    13191303   \left(   \frac{A^{\,vm}} {e_3 }\; \frac{\partial \textbf{U}_h } {\partial k}   \right)\; dv    \quad &\leq 0     \\ 
    13201304\end{align*} 
     1305 
    13211306The first property is obvious. The second results from: 
    1322  
    13231307\begin{flalign*} 
    13241308\int\limits_D  
     
    13591343   e_{1f}\,e_{2f}\,e_{3f} \; \equiv 0   && \\ 
    13601344\end{flalign*} 
     1345 
    13611346If the vertical diffusion coefficient is uniform over the whole domain, the  
    13621347enstrophy is dissipated, $i.e.$ 
     
    13661351      \left( \frac{A^{\,vm}} {e_3 }\; \frac{\partial \textbf{U}_h } {\partial k}   \right)   \right)\; dv = 0   &&&\\ 
    13671352\end{flalign*} 
     1353 
    13681354This property is only satisfied in $z$-coordinates: 
    1369  
    13701355\begin{flalign*} 
    13711356\int\limits_D \zeta \, \textbf{k} \cdot \nabla \times  
     
    14771462 
    14781463The numerical schemes used for tracer subgridscale physics are written such  
    1479 that the heat and salt contents are conserved (equations in flux form, second  
    1480 order centered finite differences). Since a flux form is used to compute the  
    1481 temperature and salinity, the quadratic form of these quantities (i.e. their variance)  
    1482 globally tends to diminish. As for the advection term, there is generally no strict  
    1483 conservation of mass, even if in practice the mass is conserved to a very high  
    1484 accuracy.  
     1464that the heat and salt contents are conserved (equations in flux form).  
     1465Since a flux form is used to compute the temperature and salinity,  
     1466the quadratic form of these quantities ($i.e.$ their variance) globally tends to diminish.  
     1467As for the advection term, there is conservation of mass only if the Equation Of Seawater is linear.  
    14851468 
    14861469% ------------------------------------------------------------------------------------------------------------- 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Chapters/Annex_D.tex

    r3294 r6436  
    120120\hline 
    121121public  \par or  \par module variable&  
    122 \textbf{m n} \par \textit{but not} \par \textbf{nn\_}&  
     122\textbf{m n} \par \textit{but not} \par \textbf{nn\_ np\_}&  
    123123\textbf{a b e f g h o q r} \par \textbf{t} \textit{to} \textbf{x} \par but not \par \textbf{fs rn\_}&  
    124124\textbf{l} \par \textit{but not} \par \textbf{lp ld} \par \textbf{ ll ln\_}&  
     
    156156\hline 
    157157parameter&  
    158 \textbf{jp}&  
     158\textbf{jp np\_}&  
    159159\textbf{pp}&  
    160160\textbf{lp}&  
     
    190190%-------------------------------------------------------------------------------------------------------------- 
    191191 
     192N.B.   Parameter here, in not only parameter in the \textsc{Fortran} acceptation, it is also used for code variables  
     193that are read in namelist and should never been modified during a simulation.  
     194It is the case, for example, for the size of a domain (jpi,jpj,jpk). 
     195 
    192196\newpage 
    193197% ================================================================ 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Chapters/Chap_DIA.tex

    r5515 r6436  
    22% Chapter I/O & Diagnostics 
    33% ================================================================ 
    4 \chapter{Ouput and Diagnostics (IOM, DIA, TRD, FLO)} 
     4\chapter{Output and Diagnostics (IOM, DIA, TRD, FLO)} 
    55\label{DIA} 
    66\minitoc 
    77 
    88\newpage 
    9 $\ $\newline    % force a new ligne 
     9$\ $\newline    % force a new line 
    1010 
    1111% ================================================================ 
     
    4848 
    4949 
    50 Since version 3.2, iomput is the NEMO output interface of choice. It has been designed to be simple to use, flexible and efficient. The two main purposes of iomput are:  
     50Since version 3.2, iomput is the NEMO output interface of choice.  
     51It has been designed to be simple to use, flexible and efficient.  
     52The two main purposes of iomput are:  
    5153\begin{enumerate} 
    5254\item The complete and flexible control of the output files through external XML files adapted by the user from standard templates.  
     
    11161118% ------------------------------------------------------------------------------------------------------------- 
    11171119\section[Tracer/Dynamics Trends (TRD)] 
    1118                   {Tracer/Dynamics Trends  (\key{trdtra}, \key{trddyn},    \\  
    1119                                                              \key{trddvor}, \key{trdmld})} 
     1120                  {Tracer/Dynamics Trends  (\ngn{namtrd})} 
    11201121\label{DIA_trd} 
    11211122 
     
    11241125%------------------------------------------------------------------------------------------------------------- 
    11251126 
    1126 When \key{trddyn} and/or \key{trddyn} CPP variables are defined, each  
    1127 trend of the dynamics and/or temperature and salinity time evolution equations  
    1128 is stored in three-dimensional arrays just after their computation ($i.e.$ at the end  
    1129 of each $dyn\cdots.F90$ and/or $tra\cdots.F90$ routines). Options are defined by 
    1130 \ngn{namtrd} namelist variables. These trends are then  
    1131 used in \mdl{trdmod} (see TRD directory) every \textit{nn\_trd } time-steps. 
    1132  
    1133 What is done depends on the CPP keys defined: 
     1127Each trend of the dynamics and/or temperature and salinity time evolution equations  
     1128can be send to \mdl{trddyn} and/or \mdl{trdtra} modules (see TRD directory) just after their computation  
     1129($i.e.$ at the end of each $dyn\cdots.F90$ and/or $tra\cdots.F90$ routines).  
     1130This capability is controlled by options offered in \ngn{namtrd} namelist.  
     1131Note that the output are done with xIOS, and therefore the \key{IOM} is required. 
     1132 
     1133What is done depends on the \ngn{namtrd} logical set to \textit{true}: 
    11341134\begin{description} 
    1135 \item[\key{trddyn}, \key{trdtra}] : a check of the basin averaged properties of the momentum  
    1136 and/or tracer equations is performed ;  
    1137 \item[\key{trdvor}] : a vertical summation of the moment tendencies is performed,  
    1138 then the curl is computed to obtain the barotropic vorticity tendencies which are output ; 
    1139 \item[\key{trdmld}] : output of the tracer tendencies averaged vertically   
    1140 either over the mixed layer (\np{nn\_ctls}=0),  
    1141 or       over a fixed number of model levels (\np{nn\_ctls}$>$1 provides the number of level),  
    1142 or       over a spatially varying but temporally fixed number of levels (typically the base  
    1143 of the winter mixed layer) read in \ifile{ctlsurf\_idx} (\np{nn\_ctls}=1) ; 
     1135\item[\np{ln\_glo\_trd}] : at each \np{nn\_trd} time-step a check of the basin averaged properties  
     1136of the momentum and tracer equations is performed. This also includes a check of $T^2$, $S^2$,  
     1137$\tfrac{1}{2} (u^2+v2)$, and potential energy time evolution equations properties ;  
     1138\item[\np{ln\_dyn\_trd}] : each 3D trend of the evolution of the two momentum components is output ;  
     1139\item[\np{ln\_dyn\_mxl}] : each 3D trend of the evolution of the two momentum components averaged  
     1140                           over the mixed layer is output  ;  
     1141\item[\np{ln\_vor\_trd}] : a vertical summation of the moment tendencies is performed,  
     1142                           then the curl is computed to obtain the barotropic vorticity tendencies which are output ; 
     1143\item[\np{ln\_KE\_trd}]  : each 3D trend of the Kinetic Energy equation is output ; 
     1144\item[\np{ln\_tra\_trd}] : each 3D trend of the evolution of temperature and salinity is output ; 
     1145\item[\np{ln\_tra\_mxl}] : each 2D trend of the evolution of temperature and salinity averaged  
     1146                           over the mixed layer is output ; 
    11441147\end{description} 
    1145  
    1146 The units in the output file can be changed using the \np{nn\_ucf} namelist parameter.  
    1147 For example, in case of salinity tendency the units are given by PSU/s/\np{nn\_ucf}. 
    1148 Setting \np{nn\_ucf}=86400 ($i.e.$ the number of second in a day) provides the tendencies in PSU/d. 
    1149  
    1150 When \key{trdmld} is defined, two time averaging procedure are proposed. 
    1151 Setting \np{ln\_trdmld\_instant} to \textit{true}, a simple time averaging is performed,  
    1152 so that the resulting tendency is the contribution to the change of a quantity between  
    1153 the two instantaneous values taken at the extremities of the time averaging period. 
    1154 Setting \np{ln\_trdmld\_instant} to \textit{false}, a double time averaging is performed,  
    1155 so that the resulting tendency is the contribution to the change of a quantity between  
    1156 two \textit{time mean} values. The later option requires the use of an extra file, \ifile{restart\_mld}   
    1157 (\np{ln\_trdmld\_restart}=true), to restart a run. 
    1158  
    11591148 
    11601149Note that the mixed layer tendency diagnostic can also be used on biogeochemical models  
    11611150via the \key{trdtrc} and \key{trdmld\_trc} CPP keys. 
     1151 
     1152\textbf{Note that} in the current version (v3.6), many changes has been introduced but not fully tested.  
     1153In particular, options associated with \np{ln\_dyn\_mxl}, \np{ln\_vor\_trd}, and \np{ln\_tra\_mxl}  
     1154are not working, and none of the option have been tested with variable volume ($i.e.$ \key{vvl} defined). 
     1155 
    11621156 
    11631157% ------------------------------------------------------------------------------------------------------------- 
     
    12801274\label{DIA_diag_harm} 
    12811275 
    1282 A module is available to compute the amplitude and phase for tidal waves.  
    1283 This diagnostic is actived with \key{diaharm}. 
    1284  
    12851276%------------------------------------------namdia_harm---------------------------------------------------- 
    12861277\namdisplay{namdia_harm} 
    12871278%---------------------------------------------------------------------------------------------------------- 
    12881279 
    1289 Concerning the on-line Harmonic analysis, some parameters are available in namelist 
    1290 \ngn{namdia\_harm} : 
    1291  
    1292 - \texttt{nit000\_han} is the first time step used for harmonic analysis 
    1293  
    1294 - \texttt{nitend\_han} is the last time step used for harmonic analysis 
    1295  
    1296 - \texttt{nstep\_han} is the time step frequency for harmonic analysis 
    1297  
    1298 - \texttt{nb\_ana} is the number of harmonics to analyse 
    1299  
    1300 - \texttt{tname} is an array with names of tidal constituents to analyse 
    1301  
    1302 \texttt{nit000\_han} and \texttt{nitend\_han} must be between \texttt{nit000} and \texttt{nitend} of the simulation. 
     1280A module is available to compute the amplitude and phase of tidal waves.  
     1281This on-line Harmonic analysis is actived with \key{diaharm}. 
     1282Some parameters are available in namelist \ngn{namdia\_harm} : 
     1283 
     1284- \np{nit000\_han} is the first time step used for harmonic analysis 
     1285 
     1286- \np{nitend\_han} is the last time step used for harmonic analysis 
     1287 
     1288- \np{nstep\_han} is the time step frequency for harmonic analysis 
     1289 
     1290- \np{nb\_ana} is the number of harmonics to analyse 
     1291 
     1292- \np{tname} is an array with names of tidal constituents to analyse 
     1293 
     1294\np{nit000\_han} and \np{nitend\_han} must be between \np{nit000} and \np{nitend} of the simulation. 
    13031295The restart capability is not implemented. 
    13041296 
    1305 The Harmonic analysis solve this equation: 
     1297The Harmonic analysis solve the following equation: 
    13061298\begin{equation} 
    13071299h_{i} - A_{0} + \sum^{nb\_ana}_{j=1}[A_{j}cos(\nu_{j}t_{j}-\phi_{j})] = e_{i} 
     
    13241316\label{DIA_diag_dct} 
    13251317 
    1326 A module is available to compute the transport of volume, heat and salt through sections. This diagnostic 
    1327 is actived with \key{diadct}. 
     1318A module is available to compute the transport of volume, heat and salt through sections.  
     1319This diagnostic is actived with \key{diadct}. 
    13281320 
    13291321Each section is defined by the coordinates of its 2 extremities. The pathways between them are contructed 
     
    13471339%------------------------------------------------------------------------------------------------------------- 
    13481340 
    1349 \texttt{nn\_dct}: frequency of instantaneous transports computing 
    1350  
    1351 \texttt{nn\_dctwri}: frequency of writing ( mean of instantaneous transports ) 
    1352  
    1353 \texttt{nn\_debug}: debugging of the section 
     1341\np{nn\_dct}: frequency of instantaneous transports computing 
     1342 
     1343\np{nn\_dctwri}: frequency of writing ( mean of instantaneous transports ) 
     1344 
     1345\np{nn\_debug}: debugging of the section 
    13541346 
    13551347\subsubsection{ To create a binary file containing the pathway of each section } 
     
    14821474the \key{diahth} CPP key:  
    14831475 
    1484 - the mixed layer depth (based on a density criterion, \citet{de_Boyer_Montegut_al_JGR04}) (\mdl{diahth}) 
     1476- the mixed layer depth (based on a density criterion \citep{de_Boyer_Montegut_al_JGR04}) (\mdl{diahth}) 
    14851477 
    14861478- the turbocline depth (based on a turbulent mixing coefficient criterion) (\mdl{diahth}) 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Chapters/Chap_DOM.tex

    r5120 r6436  
    11% ================================================================ 
    2 % Chapter 2 Space and Time Domain (DOM) 
     2% Chapter 2 ——— Space and Time Domain (DOM) 
    33% ================================================================ 
    44\chapter{Space Domain (DOM) } 
     
    138138and $f$-points, and its divergence defined at $t$-points: 
    139139\begin{eqnarray}  \label{Eq_DOM_curl} 
    140  \nabla \times {\rm {\bf A}}\equiv & 
     140 \nabla \times {\rm{\bf A}}\equiv & 
    141141      \frac{1}{e_{2v}\,e_{3vw} } \ \left( \delta_{j +1/2} \left[e_{3w}\,a_3 \right] -\delta_{k+1/2} \left[e_{2v} \,a_2 \right] \right)  &\ \mathbf{i} \\  
    142142 +& \frac{1}{e_{2u}\,e_{3uw}} \ \left( \delta_{k+1/2} \left[e_{1u}\,a_1  \right] -\delta_{i +1/2} \left[e_{3w}\,a_3 \right] \right)  &\ \mathbf{j} \\ 
     
    183183Let $a$ and $b$ be two fields defined on the mesh, with value zero inside  
    184184continental area. Using integration by parts it can be shown that the differencing  
    185 operators ($\delta_i$, $\delta_j$ and $\delta_k$) are anti-symmetric linear  
    186 operators, and further that the averaging operators $\overline{\,\cdot\,}^{\,i}$,  
     185operators ($\delta_i$, $\delta_j$ and $\delta_k$) are skew-symmetric linear operators,  
     186and further that the averaging operators $\overline{\,\cdot\,}^{\,i}$,  
    187187$\overline{\,\cdot\,}^{\,k}$ and $\overline{\,\cdot\,}^{\,k}$) are symmetric linear  
    188188operators, $i.e.$ 
     
    364364For both grids here,  the same $w$-point depth has been chosen but in (a) the  
    365365$t$-points are set half way between $w$-points while in (b) they are defined from  
    366 an analytical function: $z(k)=5\,(i-1/2)^3 - 45\,(i-1/2)^2 + 140\,(i-1/2) - 150$.  
     366an analytical function: $z(k)=5\,(k-1/2)^3 - 45\,(k-1/2)^2 + 140\,(k-1/2) - 150$.  
    367367Note the resulting difference between the value of the grid-size $\Delta_k$ and  
    368368those of the scale factor $e_k$. } 
     
    425425 
    426426The choice of the grid must be consistent with the boundary conditions specified  
    427 by the parameter \np{jperio} (see {\S\ref{LBC}). 
     427by \np{jperio}, a parameter found in \ngn{namcfg} namelist (see {\S\ref{LBC}). 
    428428 
    429429% ------------------------------------------------------------------------------------------------------------- 
     
    481481%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    482482 
    483 The choice of a vertical coordinate, even if it is made through a namelist parameter,  
     483The choice of a vertical coordinate, even if it is made through \ngn{namzgr} namelist parameters,  
    484484must be done once of all at the beginning of an experiment. It is not intended as an  
    485485option which can be enabled or disabled in the middle of an experiment. Three main  
     
    494494bathymetry or $s$-coordinate (hybrid and partial step coordinates have not  
    495495yet been tested in NEMO v2.3). If using $z$-coordinate with partial step bathymetry 
    496 (\np{ln\_zps}~=~true), ocean cavity beneath ice shelves can be open (\np{ln\_isfcav}~=~true). 
     496(\np{ln\_zps}~=~true), ocean cavity beneath ice shelves can be open (\np{ln\_isfcav}~=~true)  
     497and partial step are also applied at the ocean/ice shelf interface.  
    497498 
    498499Contrary to the horizontal grid, the vertical grid is computed in the code and no  
    499500provision is made for reading it from a file. The only input file is the bathymetry  
    500 (in meters) (\ifile{bathy\_meter})  
     501(in meters) (\ifile{bathy\_meter}).  
    501502\footnote{N.B. in full step $z$-coordinate, a \ifile{bathy\_level} file can replace the  
    502503\ifile{bathy\_meter} file, so that the computation of the number of wet ocean point  
     
    540541 
    541542Three options are possible for defining the bathymetry, according to the  
    542 namelist variable \np{nn\_bathy}:  
     543namelist variable \np{nn\_bathy} (found in \ngn{namdom} namelist):  
    543544\begin{description} 
    544545\item[\np{nn\_bathy} = 0] a flat-bottom domain is defined. The total depth $z_w (jpk)$  
     
    548549domain width at the central latitude. This is meant for the "EEL-R5" configuration,  
    549550a periodic or open boundary channel with a seamount.  
    550 \item[\np{nn\_bathy} = 1] read a bathymetry. The \ifile{bathy\_meter} file (Netcdf format)  
    551 provides the ocean depth (positive, in meters) at each grid point of the model grid.  
    552 The bathymetry is usually built by interpolating a standard bathymetry product  
     551\item[\np{nn\_bathy} = 1] read a bathymetry and ice shelf draft (if needed). 
     552 The \ifile{bathy\_meter} file (Netcdf format) provides the ocean depth (positive, in meters) 
     553 at each grid point of the model grid. The bathymetry is usually built by interpolating a standard bathymetry product  
    553554($e.g.$ ETOPO2) onto the horizontal ocean mesh. Defining the bathymetry also  
    554555defines the coastline: where the bathymetry is zero, no model levels are defined  
    555556(all levels are masked). 
     557 
     558The \ifile{isfdraft\_meter} file (Netcdf format) provides the ice shelf draft (positive, in meters) 
     559 at each grid point of the model grid. This file is only needed if \np{ln\_isfcav}~=~true.  
     560Defining the ice shelf draft will also define the ice shelf edge and the grounding line position. 
    556561\end{description} 
    557562 
     
    610615(Fig.~\ref{Fig_zgr}). 
    611616 
     617If the ice shelf cavities are opened (\np{ln\_isfcav}=~true~}), the definition of $z_0$ is the same.  
     618However, definition of $e_3^0$ at $t$- and $w$-points is respectively changed to: 
     619\begin{equation} \label{DOM_zgr_ana} 
     620\begin{split} 
     621 e_3^T(k) &= z_W (k+1) - z_W (k)   \\ 
     622 e_3^W(k) &= z_T (k)   - z_T (k-1) \\ 
     623\end{split} 
     624\end{equation} 
     625This formulation decrease the self-generated circulation into the ice shelf cavity  
     626(which can, in extreme case, leads to blow up).\\ 
     627 
     628  
    612629The most used vertical grid for ORCA2 has $10~m$ ($500~m)$ resolution in the  
    613630surface (bottom) layers and a depth which varies from 0 at the sea surface to a  
     
    721738usually 10\%, of the default thickness $e_{3t}(jk)$). 
    722739 
    723  \colorbox{yellow}{Add a figure here of pstep especially at last ocean level } 
     740\gmcomment{ \colorbox{yellow}{Add a figure here of pstep especially at last ocean level } } 
    724741 
    725742% ------------------------------------------------------------------------------------------------------------- 
     
    860877gives the number of ocean levels ($i.e.$ those that are not masked) at each  
    861878$t$-point. mbathy is computed from the meter bathymetry using the definiton of  
    862 gdept as the number of $t$-points which gdept $\leq$ bathy.  
     879gdept as the number of $t$-points which gdept $\leq$ bathy. 
    863880 
    864881Modifications of the model bathymetry are performed in the \textit{bat\_ctl}  
    865882routine (see \mdl{domzgr} module) after mbathy is computed. Isolated grid points  
    866 that do not communicate with another ocean point at the same level are eliminated. 
     883that do not communicate with another ocean point at the same level are eliminated.\\ 
     884 
     885As for the representation of bathymetry, a 2D integer array, misfdep, is created.  
     886misfdep defines the level of the first wet $t$-point. All the cells between $k=1$ and $misfdep(i,j)-1$ are masked.  
     887By default, misfdep(:,:)=1 and no cells are masked. 
     888 
     889In case of ice shelf cavities (\np{ln\_isfcav}~=~true), modifications of the model bathymetry and ice shelf draft in  
     890the cavities are performed through the \textit{zgr\_isf} routine. The compatibility between ice shelf draft and bathymetry is checked:  
     891if only one cell on the water column is opened at $t$-, $u$- or $v$-points, the bathymetry or the ice shelf draft is dug to have a 2-level water column  
     892(i.e. two unmasked levels). If the incompatibility is too strong (i.e. need to dig more than one cell), the entire water column is masked.\\  
    867893 
    868894From the \textit{mbathy} array, the mask fields are defined as follows: 
    869895\begin{align*} 
    870 tmask(i,j,k) &= \begin{cases}   \; 1&   \text{ if $k\leq mbathy(i,j)$  }    \\ 
    871                                                 \; 0&   \text{ if $k\leq mbathy(i,j)$  }    \end{cases}     \\ 
     896tmask(i,j,k) &= \begin{cases}   \; 0&   \text{ if $k < misfdep(i,j) $ } \\ 
     897                                \; 1&   \text{ if $misfdep(i,j) \leq k\leq mbathy(i,j)$  }    \\ 
     898                                \; 0&   \text{ if $k > mbathy(i,j)$  }    \end{cases}     \\ 
    872899umask(i,j,k) &=         \; tmask(i,j,k) \ * \ tmask(i+1,j,k)   \\ 
    873900vmask(i,j,k) &=         \; tmask(i,j,k) \ * \ tmask(i,j+1,k)   \\ 
    874901fmask(i,j,k) &=         \; tmask(i,j,k) \ * \ tmask(i+1,j,k)   \\ 
    875                    & \ \ \, * tmask(i,j,k) \ * \ tmask(i+1,j,k) 
     902                   & \ \ \, * tmask(i,j,k) \ * \ tmask(i+1,j,k) \\ 
     903wmask(i,j,k) &=         \; tmask(i,j,k) \ * \ tmask(i,j,k-1) \text{ with } wmask(i,j,1) = tmask(i,j,1)  
    876904\end{align*} 
    877905 
    878 Note that \textit{wmask} is not defined as it is exactly equal to \textit{tmask} with  
    879 the numerical indexing used (\S~\ref{DOM_Num_Index}). Moreover, the  
    880 specification of closed lateral boundaries requires that at least the first and last  
     906Note, wmask is now defined. It allows, in case of ice shelves,  
     907to deal with the top boundary (ice shelf/ocean interface) exactly in the same way as for the bottom boundary.  
     908 
     909The specification of closed lateral boundaries requires that at least the first and last  
    881910rows and columns of the \textit{mbathy} array are set to zero. In the particular  
    882911case of an east-west cyclical boundary condition, \textit{mbathy} has its last  
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Chapters/Chap_DYN.tex

    r5120 r6436  
    11% ================================================================ 
    2 % Chapter Ocean Dynamics (DYN) 
     2% Chapter ——— Ocean Dynamics (DYN) 
    33% ================================================================ 
    44\chapter{Ocean Dynamics (DYN)} 
    55\label{DYN} 
    66\minitoc 
    7  
    8 % add a figure for  dynvor ens, ene latices 
    97 
    108%\vspace{2.cm} 
     
    165163%------------------------------------------------------------------------------------------------------------- 
    166164 
    167 The vector invariant form of the momentum equations is the one most  
    168 often used in applications of the \NEMO ocean model. The flux form option  
    169 (see next section) has been present since version $2$. Options are defined 
    170 through the \ngn{namdyn\_adv} namelist variables 
    171 Coriolis and momentum advection terms are evaluated using a leapfrog  
    172 scheme, $i.e.$ the velocity appearing in these expressions is centred in  
    173 time (\textit{now} velocity).  
     165The vector invariant form of the momentum equations (\np{ln\_dynhpg\_vec}~=~true) is the one most  
     166often used in applications of the \NEMO ocean model. The flux form option (\np{ln\_dynhpg\_vec}~=false) 
     167(see next section) has been present since version $2$.  
     168Options are defined through the \ngn{namdyn\_adv} namelist variables. 
     169Coriolis and momentum advection terms are evaluated using a leapfrog scheme,  
     170$i.e.$ the velocity appearing in these expressions is centred in time (\textit{now} velocity).  
    174171At the lateral boundaries either free slip, no slip or partial slip boundary  
    175172conditions are applied following Chap.\ref{LBC}. 
     
    303300%>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    304301 
    305 Note that a key point in \eqref{Eq_een_e3f} is that the averaging in the \textbf{i}- and  
    306 \textbf{j}- directions uses the masked vertical scale factor but is always divided by  
    307 $4$, not by the sum of the masks at the four $T$-points. This preserves the continuity of  
    308 $e_{3f}$ when one or more of the neighbouring $e_{3t}$ tends to zero and  
    309 extends by continuity the value of $e_{3f}$ into the land areas. This feature is essential for  
    310 the $z$-coordinate with partial steps. 
     302A key point in \eqref{Eq_een_e3f} is how the averaging in the \textbf{i}- and \textbf{j}- directions is made.  
     303It uses the sum of masked t-point vertical scale factor divided either  
     304by the sum of the four t-point masks (\np{ln\_dynvor\_een\_old}~=~false),  
     305or  just by $4$ (\np{ln\_dynvor\_een\_old}~=~true). 
     306The latter case preserves the continuity of $e_{3f}$ when one or more of the neighbouring $e_{3t}$  
     307tends to zero and extends by continuity the value of $e_{3f}$ into the land areas.  
     308This case introduces a sub-grid-scale topography at f-points (with a systematic reduction of $e_{3f}$  
     309when a model level intercept the bathymetry) that tends to reinforce the topostrophy of the flow  
     310($i.e.$ the tendency of the flow to follow the isobaths) \citep{Penduff_al_OS07}.  
    311311 
    312312Next, the vorticity triads, $ {^i_j}\mathbb{Q}^{i_p}_{j_p}$ can be defined at a $T$-point as  
     
    374374\end{aligned}         \right. 
    375375\end{equation}  
     376When \np{ln\_dynzad\_zts}~=~\textit{true}, a split-explicit time stepping with 5 sub-timesteps is used  
     377on the vertical advection term. 
     378This option can be useful when the value of the timestep is limited by vertical advection \citep{Lemarie_OM2015}.  
     379Note that in this case, a similar split-explicit time stepping should be used on  
     380vertical advection of tracer to ensure a better stability,  
     381an option which is only available with a TVD scheme (see \np{ln\_traadv\_tvd\_zts} in \S\ref{TRA_adv_tvd}). 
     382 
    376383 
    377384% ================================================================ 
     
    491498those in the centred second order method. As the scheme already includes  
    492499a diffusion component, it can be used without explicit  lateral diffusion on momentum  
    493 ($i.e.$ \np{ln\_dynldf\_lap}=\np{ln\_dynldf\_bilap}=false), and it is recommended to do so. 
     500($i.e.$ setting both \np{ln\_dynldf\_lap} and \np{ln\_dynldf\_bilap} to \textit{false}),  
     501and it is recommended to do so. 
    494502 
    495503The UBS scheme is not used in all directions. In the vertical, the centred $2^{nd}$  
     
    629637($e_{3w}$). 
    630638  
    631 $\bullet$ Traditional coding with adaptation for ice shelf cavities (\np{ln\_dynhpg\_isf}=true). 
    632 This scheme need the activation of ice shelf cavities (\np{ln\_isfcav}=true). 
    633  
    634639$\bullet$ Pressure Jacobian scheme (prj) (a research paper in preparation) (\np{ln\_dynhpg\_prj}=true) 
    635640 
     
    646651pressure Jacobian method is used to solve the horizontal pressure gradient. This method can provide 
    647652a more accurate calculation of the horizontal pressure gradient than the standard scheme. 
     653 
     654\subsection{Ice shelf cavity} 
     655\label{DYN_hpg_isf} 
     656Beneath an ice shelf, the total pressure gradient is the sum of the pressure gradient due to the ice shelf load and 
     657 the pressure gradient due to the ocean load. If cavities are present (\np{ln\_isfcav}~=~true) these two terms can be 
     658 calculated by setting \np{ln\_dynhpg\_isf}~=~true. No other scheme is working with ice shelves.\\ 
     659 
     660$\bullet$ The main hypothesis to compute the ice shelf load is that the ice shelf is in isostatic equilibrium. 
     661 The top pressure is computed integrating a reference density profile (prescribed as density of a water at 34.4  
     662PSU and -1.9$\degres C$) from the sea surface to the ice shelf base, which corresponds to the load of the water 
     663column in which the ice shelf is floatting. This top pressure is constant over time. A detailed description of  
     664this method is described in \citet{Losch2008}.\\ 
     665 
     666$\bullet$ The ocean load is computed using the expression \eqref{Eq_dynhpg_sco} described in \ref{DYN_hpg_sco}.  
     667A treatment of the top and bottom partial cells similar to the one described in \ref{DYN_hpg_zps} is done  
     668to reduce the residual circulation generated by the top partial cell.  
    648669 
    649670%-------------------------------------------------------------------------------------------------------------- 
     
    718739$\ $\newline      %force an empty line 
    719740 
    720 %%% 
    721741Options are defined through the \ngn{namdyn\_spg} namelist variables. 
    722 The surface pressure gradient term is related to the representation of the free surface (\S\ref{PE_hor_pg}). The main distinction is between the fixed volume case (linear free surface) and the variable volume case (nonlinear free surface, \key{vvl} is defined). In the linear free surface case (\S\ref{PE_free_surface}) the vertical scale factors $e_{3}$ are fixed in time, while they are time-dependent in the nonlinear case (\S\ref{PE_free_surface}). With both linear and nonlinear free surface, external gravity waves are allowed in the equations, which imposes a very small time step when an explicit time stepping is used. Two methods are proposed to allow a longer time step for the three-dimensional equations: the filtered free surface, which is a modification of the continuous equations (see \eqref{Eq_PE_flt}), and the split-explicit free surface described below. The extra term introduced in the filtered method is calculated implicitly, so that the update of the next velocities is done in module \mdl{dynspg\_flt} and not in \mdl{dynnxt}. 
    723  
    724 %%% 
     742The surface pressure gradient term is related to the representation of the free surface (\S\ref{PE_hor_pg}).  
     743The main distinction is between the fixed volume case (linear free surface) and the variable volume case  
     744(nonlinear free surface, \key{vvl} is defined). In the linear free surface case (\S\ref{PE_free_surface})  
     745the vertical scale factors $e_{3}$ are fixed in time, while they are time-dependent in the nonlinear case  
     746(\S\ref{PE_free_surface}).  
     747With both linear and nonlinear free surface, external gravity waves are allowed in the equations,  
     748which imposes a very small time step when an explicit time stepping is used.  
     749Two methods are proposed to allow a longer time step for the three-dimensional equations:  
     750the filtered free surface, which is a modification of the continuous equations (see \eqref{Eq_PE_flt}),  
     751and the split-explicit free surface described below.  
     752The extra term introduced in the filtered method is calculated implicitly,  
     753so that the update of the next velocities is done in module \mdl{dynspg\_flt} and not in \mdl{dynnxt}. 
    725754 
    726755 
     
    736765implicitly, so that a solver is used to compute it. As a consequence the update of the $next$  
    737766velocities is done in module \mdl{dynspg\_flt} and not in \mdl{dynnxt}. 
    738  
    739767 
    740768 
     
    779807$\rdt_e = \rdt / nn\_baro$. This parameter can be optionally defined automatically (\np{ln\_bt\_nn\_auto}=true)  
    780808considering that the stability of the barotropic system is essentially controled by external waves propagation.  
    781 Maximum allowed Courant number is in that case time independent, and easily computed online from the input bathymetry. 
     809Maximum Courant number is in that case time independent, and easily computed online from the input bathymetry. 
     810Therefore, $\rdt_e$ is adjusted so that the Maximum allowed Courant number is smaller than \np{rn\_bt\_cmax}. 
    782811 
    783812%%% 
     
    802831Schematic of the split-explicit time stepping scheme for the external  
    803832and internal modes. Time increases to the right. In this particular exemple,  
    804 a boxcar averaging window over $nn\_baro$ barotropic time steps is used ($nn\_bt\_filt=1$) and $nn\_baro=5$. 
     833a boxcar averaging window over $nn\_baro$ barotropic time steps is used ($nn\_bt\_flt=1$) and $nn\_baro=5$. 
    805834Internal mode time steps (which are also the model time steps) are denoted  
    806835by $t-\rdt$, $t$ and $t+\rdt$. Variables with $k$ superscript refer to instantaneous barotropic variables,  
     
    808837The former are used to obtain time filtered quantities at $t+\rdt$ while the latter are used to obtain time averaged  
    809838transports to advect tracers. 
    810 a) Forward time integration: \np{ln\_bt\_fw}=true, \np{ln\_bt\_ave}=true.  
    811 b) Centred time integration: \np{ln\_bt\_fw}=false, \np{ln\_bt\_ave}=true.  
    812 c) Forward time integration with no time filtering (POM-like scheme): \np{ln\_bt\_fw}=true, \np{ln\_bt\_ave}=false. } 
     839a) Forward time integration: \np{ln\_bt\_fw}=true, \np{ln\_bt\_av}=true.  
     840b) Centred time integration: \np{ln\_bt\_fw}=false, \np{ln\_bt\_av}=true.  
     841c) Forward time integration with no time filtering (POM-like scheme): \np{ln\_bt\_fw}=true, \np{ln\_bt\_av}=false. } 
    813842\end{center}    \end{figure} 
    814843%>   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   > 
     
    816845In the default case (\np{ln\_bt\_fw}=true), the external mode is integrated  
    817846between \textit{now} and  \textit{after} baroclinic time-steps (Fig.~\ref{Fig_DYN_dynspg_ts}a). To avoid aliasing of fast barotropic motions into three dimensional equations, time filtering is eventually applied on barotropic  
    818 quantities (\np{ln\_bt\_ave}=true). In that case, the integration is extended slightly beyond  \textit{after} time step to provide time filtered quantities.  
     847quantities (\np{ln\_bt\_av}=true). In that case, the integration is extended slightly beyond  \textit{after} time step to provide time filtered quantities.  
    819848These are used for the subsequent initialization of the barotropic mode in the following baroclinic step.  
    820849Since external mode equations written at baroclinic time steps finally follow a forward time stepping scheme,  
     
    837866%%% 
    838867 
    839 One can eventually choose to feedback instantaneous values by not using any time filter (\np{ln\_bt\_ave}=false).  
     868One can eventually choose to feedback instantaneous values by not using any time filter (\np{ln\_bt\_av}=false).  
    840869In that case, external mode equations are continuous in time, ie they are not re-initialized when starting a new  
    841870sub-stepping sequence. This is the method used so far in the POM model, the stability being maintained by refreshing at (almost)  
     
    11581187 
    11591188Besides the surface and bottom stresses (see the above section) which are  
    1160 introduced as boundary conditions on the vertical mixing, two other forcings  
    1161 enter the dynamical equations.  
    1162  
    1163 One is the effect of atmospheric pressure on the ocean dynamics. 
    1164 Another forcing term is the tidal potential. 
    1165 Both of which will be introduced into the reference version soon.  
    1166  
    1167 \gmcomment{atmospheric pressure is there!!!!    include its description } 
     1189introduced as boundary conditions on the vertical mixing, three other forcings  
     1190may enter the dynamical equations by affecting the surface pressure gradient.  
     1191 
     1192(1) When \np{ln\_apr\_dyn}~=~true (see \S\ref{SBC_apr}), the atmospheric pressure is taken  
     1193into account when computing the surface pressure gradient. 
     1194 
     1195(2) When \np{ln\_tide\_pot}~=~true and \key{tide} is defined (see \S\ref{SBC_tide}),  
     1196the tidal potential is taken into account when computing the surface pressure gradient. 
     1197 
     1198(3) When \np{nn\_ice\_embd}~=~2 and LIM or CICE is used ($i.e.$ when the sea-ice is embedded in the ocean),  
     1199the snow-ice mass is taken into account when computing the surface pressure gradient. 
     1200 
     1201 
     1202\gmcomment{ missing : the lateral boundary condition !!!   another external forcing 
     1203 } 
    11681204 
    11691205% ================================================================ 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Chapters/Chap_LBC.tex

    r4147 r6436  
    11% ================================================================ 
    2 % Chapter Lateral Boundary Condition (LBC)  
     2% Chapter Lateral Boundary Condition (LBC)  
    33% ================================================================ 
    44\chapter{Lateral Boundary Condition (LBC) } 
     
    204204%        North fold (\textit{jperio = 3 }to $6)$  
    205205% ------------------------------------------------------------------------------------------------------------- 
    206 \subsection{North-fold (\textit{jperio = 3 }to $6)$ } 
     206\subsection{North-fold (\textit{jperio = 3 }to $6$) } 
    207207\label{LBC_north_fold} 
    208208 
    209209The north fold boundary condition has been introduced in order to handle the north  
    210 boundary of a three-polar ORCA grid. Such a grid has two poles in the northern hemisphere.  
    211 \colorbox{yellow}{to be completed...} 
     210boundary of a three-polar ORCA grid. Such a grid has two poles in the northern hemisphere  
     211(Fig.\ref{Fig_MISC_ORCA_msh}, and thus requires a specific treatment illustrated in Fig.\ref{Fig_North_Fold_T}.  
     212Further information can be found in \mdl{lbcnfd} module which applies the north fold boundary condition. 
    212213 
    213214%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
     
    250251ocean model. Second order finite difference schemes lead to local discrete  
    251252operators that depend at the very most on one neighbouring point. The only  
    252 non-local computations concern the vertical physics (implicit diffusion, 1.5  
     253non-local computations concern the vertical physics (implicit diffusion,  
    253254turbulent closure scheme, ...) (delocalization over the whole water column),  
    254255and the solving of the elliptic equation associated with the surface pressure  
    255256gradient computation (delocalization over the whole horizontal domain).  
    256257Therefore, a pencil strategy is used for the data sub-structuration  
    257 \gmcomment{no idea what this means!} 
    258258: the 3D initial domain is laid out on local processor  
    259259memories following a 2D horizontal topological splitting. Each sub-domain  
     
    264264phase starts: each processor sends to its neighbouring processors the update  
    265265values of the points corresponding to the interior overlapping area to its  
    266 neighbouring sub-domain (i.e. the innermost of the two overlapping rows).  
    267 The communication is done through message passing. Usually the parallel virtual  
    268 language, PVM, is used as it is a standard language available on  nearly  all  
    269 MPP computers. More specific languages (i.e. computer dependant languages)  
    270 can be easily used to speed up the communication, such as SHEM on a T3E  
    271 computer. The data exchanges between processors are required at the very  
     266neighbouring sub-domain ($i.e.$ the innermost of the two overlapping rows).  
     267The communication is done through the Message Passing Interface (MPI).  
     268The data exchanges between processors are required at the very  
    272269place where lateral domain boundary conditions are set in the mono-domain  
    273 computation (\S III.10-c): the lbc\_lnk routine which manages such conditions  
    274 is substituted by mpplnk.F or mpplnk2.F routine when running on an MPP  
    275 computer (\key{mpp\_mpi} defined). It has to be pointed out that when using  
    276 the MPP version of the model, the east-west cyclic boundary condition is done  
    277 implicitly, whilst the south-symmetric boundary condition option is not available. 
     270computation : the \rou{lbc\_lnk} routine (found in \mdl{lbclnk} module)  
     271which manages such conditions is interfaced with routines found in \mdl{lib\_mpp} module  
     272when running on an MPP computer ($i.e.$ when \key{mpp\_mpi} defined).  
     273It has to be pointed out that when using the MPP version of the model,  
     274the east-west cyclic boundary condition is done implicitly,  
     275whilst the south-symmetric boundary condition option is not available. 
    278276 
    279277%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
     
    285283%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    286284 
    287 In the standard version of the OPA model, the splitting is regular and arithmetic. 
    288  the i-axis is divided by \jp{jpni} and the j-axis by \jp{jpnj} for a number of processors  
    289  \jp{jpnij} most often equal to $jpni \times jpnj$ (model parameters set in  
    290  \mdl{par\_oce}). Each processor is independent and without message passing  
    291  or synchronous process  
    292  \gmcomment{how does a synchronous process relate to this?},  
    293  programs run alone and access just its own local memory. For this reason, the  
    294  main model dimensions are now the local dimensions of the subdomain (pencil)  
     285In the standard version of \NEMO, the splitting is regular and arithmetic. 
     286The i-axis is divided by \jp{jpni} and the j-axis by \jp{jpnj} for a number of processors  
     287\jp{jpnij} most often equal to $jpni \times jpnj$ (parameters set in  
     288 \ngn{nammpp} namelist). Each processor is independent and without message passing  
     289 or synchronous process, programs run alone and access just its own local memory.  
     290 For this reason, the main model dimensions are now the local dimensions of the subdomain (pencil)  
    295291 that are named \jp{jpi}, \jp{jpj}, \jp{jpk}. These dimensions include the internal  
    296292 domain and the overlapping rows. The number of rows to exchange (known as  
     
    304300where \jp{jpni}, \jp{jpnj} are the number of processors following the i- and j-axis. 
    305301 
    306 \colorbox{yellow}{Figure IV.3: example of a domain splitting with 9 processors and  
    307 no east-west cyclic boundary conditions.} 
    308  
    309 One also defines variables nldi and nlei which correspond to the internal  
    310 domain bounds, and the variables nimpp and njmpp which are the position  
    311 of the (1,1) grid-point in the global domain. An element of $T_{l}$, a local array  
    312 (subdomain) corresponds to an element of $T_{g}$, a global array  
    313 (whole domain) by the relationship:  
     302One also defines variables nldi and nlei which correspond to the internal domain bounds,  
     303and the variables nimpp and njmpp which are the position of the (1,1) grid-point in the global domain.  
     304An element of $T_{l}$, a local array (subdomain) corresponds to an element of $T_{g}$,  
     305a global array (whole domain) by the relationship:  
    314306\begin{equation} \label{Eq_lbc_nimpp} 
    315307T_{g} (i+nimpp-1,j+njmpp-1,k) = T_{l} (i,j,k), 
     
    320312nproc. In the standard version, a processor has no more than four neighbouring  
    321313processors named nono (for north), noea (east), noso (south) and nowe (west)  
    322 and two variables, nbondi and nbondj, indicate the relative position of the processor  
    323 \colorbox{yellow}{(see Fig.IV.3)}: 
     314and two variables, nbondi and nbondj, indicate the relative position of the processor : 
    324315\begin{itemize} 
    325316\item       nbondi = -1    an east neighbour, no west processor, 
     
    332323processor on its overlapping row, and sends the data issued from internal  
    333324domain corresponding to the overlapping row of the other processor. 
    334         
    335 \colorbox{yellow}{Figure IV.4: pencil splitting with the additional outer halos } 
    336325 
    337326 
     
    343332global ocean where more than 50 \% of points are land points. For this reason, a  
    344333pre-processing tool can be used to choose the mpp domain decomposition with a  
    345 maximum number of only land points processors, which can then be eliminated.  
    346 (For example, the mpp\_optimiz tools, available from the DRAKKAR web site.)  
     334maximum number of only land points processors, which can then be eliminated (Fig. \ref{Fig_mppini2}) 
     335(For example, the mpp\_optimiz tools, available from the DRAKKAR web site).  
    347336This optimisation is dependent on the specific bathymetry employed. The user  
    348337then chooses optimal parameters \jp{jpni}, \jp{jpnj} and \jp{jpnij} with  
    349338$jpnij < jpni \times jpnj$, leading to the elimination of $jpni \times jpnj - jpnij$  
    350 land processors. When those parameters are specified in module \mdl{par\_oce},  
     339land processors. When those parameters are specified in \ngn{nammpp} namelist,  
    351340the algorithm in the \rou{inimpp2} routine sets each processor's parameters (nbound,  
    352341nono, noea,...) so that the land-only processors are not taken into account.  
    353342 
    354 \colorbox{yellow}{Note that the inimpp2 routine is general so that the original inimpp  
     343\gmcomment{Note that the inimpp2 routine is general so that the original inimpp  
    355344routine should be suppressed from the code.} 
    356345 
    357346When land processors are eliminated, the value corresponding to these locations in  
    358 the model output files is zero. Note that this is a problem for a mesh output file written  
    359 by such a model configuration, because model users often divide by the scale factors  
    360 ($e1t$, $e2t$, etc) and do not expect the grid size to be zero, even on land. It may be  
    361 best not to eliminate land processors when running the model especially to write the  
    362 mesh files as outputs (when \np{nn\_msh} namelist parameter differs from 0). 
    363 %% 
    364 \gmcomment{Steven : dont understand this, no land processor means no output file  
    365 covering this part of globe; its only when files are stitched together into one that you  
    366 can leave a hole} 
    367 %% 
     347the model output files is undefined. Note that this is a problem for the meshmask file  
     348which requires to be defined over the whole domain. Therefore, user should not eliminate  
     349land processors when creating a meshmask file ($i.e.$ when setting a non-zero value to \np{nn\_msh}). 
    368350 
    369351%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
     
    380362%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    381363 
    382  
    383 % ================================================================ 
    384 % Open Boundary Conditions  
    385 % ================================================================ 
    386 \section{Open Boundary Conditions (\key{obc}) (OBC)} 
    387 \label{LBC_obc} 
    388 %-----------------------------------------nam_obc  ------------------------------------------- 
    389 %-    nobc_dta    =    0     !  = 0 the obc data are equal to the initial state 
    390 %-                           !  = 1 the obc data are read in 'obc   .dta' files 
    391 %-    rn_dpein      =    1.    !  ??? 
    392 %-    rn_dpwin      =    1.    !  ??? 
    393 %-    rn_dpnin      =   30.    !  ??? 
    394 %-    rn_dpsin      =    1.    !  ??? 
    395 %-    rn_dpeob      = 1500.    !  time relaxation (days) for the east  open boundary 
    396 %-    rn_dpwob      =   15.    !    "        "           for the west  open boundary 
    397 %-    rn_dpnob      =  150.    !    "        "           for the north open boundary 
    398 %-    rn_dpsob      =   15.    !    "        "           for the south open boundary 
    399 %-    ln_obc_clim = .true.   !  climatological obc data files (default T) 
    400 %-    ln_vol_cst  = .true.   !  total volume conserved 
    401 \namdisplay{namobc}  
    402  
    403 It is often necessary to implement a model configuration limited to an oceanic  
    404 region or a basin, which communicates with the rest of the global ocean through  
    405 ''open boundaries''. As stated by \citet{Roed1986}, an open boundary is a  
    406 computational border where the aim of the calculations is to allow the perturbations  
    407 generated inside the computational domain to leave it without deterioration of the  
    408 inner model solution. However, an open boundary also has to let information from  
    409 the outer ocean enter the model and should support inflow and outflow conditions.  
    410  
    411 The open boundary package OBC is the first open boundary option developed in  
    412 NEMO (originally in OPA8.2). It allows the user to  
    413 \begin{itemize} 
    414 \item tell the model that a boundary is ''open'' and not closed by a wall, for example  
    415 by modifying the calculation of the divergence of velocity there; 
    416 \item impose values of tracers and velocities at that boundary (values which may  
    417 be taken from a climatology): this is the``fixed OBC'' option.  
    418 \item calculate boundary values by a sophisticated algorithm combining radiation  
    419 and relaxation (``radiative OBC'' option) 
    420 \end{itemize} 
    421  
    422 Options are defined through the \ngn{namobc} namelist variables. 
    423 The package resides in the OBC directory. It is described here in four parts: the  
    424 boundary geometry (parameters to be set in \mdl{obc\_par}), the forcing data at  
    425 the boundaries (module \mdl{obcdta}),  the radiation algorithm involving the  
    426 namelist and module \mdl{obcrad}, and a brief presentation of boundary update  
    427 and restart files. 
    428  
    429 %---------------------------------------------- 
    430 \subsection{Boundary geometry} 
    431 \label{OBC_geom} 
    432 % 
    433 First one has to realize that open boundaries may not necessarily be located  
    434 at the extremities of the computational domain. They may exist in the middle  
    435 of the domain, for example at Gibraltar Straits if one wants to avoid including  
    436 the Mediterranean in an Atlantic domain. This flexibility has been found necessary  
    437 for the CLIPPER project \citep{Treguier_al_JGR01}. Because of the complexity of the  
    438 geometry of ocean basins, it may even be necessary to have more than one  
    439 ''west'' open boundary, more than one ''north'', etc. This is not possible with  
    440 the OBC option: only one open boundary of each kind, west, east, south and  
    441 north is allowed; these names refer to the grid geometry (not to the direction  
    442 of the geographical ''west'', ''east'', etc). 
    443  
    444 The open boundary geometry is set by a series of parameters in the module  
    445 \mdl{obc\_par}. For an eastern open boundary, parameters are \jp{lp\_obc\_east}  
    446 (true if an east open boundary exists), \jp{jpieob} the $i$-index along which  
    447 the eastern open boundary (eob) is located, \jp{jpjed} the $j$-index at which  
    448 it starts, and \jp{jpjef} the $j$-index where it ends (note $d$ is for ''d\'{e}but''  
    449 and $f$ for ''fin'' in French). Similar parameters exist for the west, south and  
    450 north cases (Table~\ref{Tab_obc_param}). 
    451  
    452  
    453 %--------------------------------------------------TABLE-------------------------------------------------- 
    454 \begin{table}[htbp]     \begin{center}    \begin{tabular}{|l|c|c|c|} 
    455 \hline 
    456 Boundary and  & Constant index  & Starting index (d\'{e}but) & Ending index (fin) \\ 
    457 Logical flag  &                 &                            &                     \\ 
    458 \hline 
    459 West          & \jp{jpiwob} $>= 2$         &  \jp{jpjwd}$>= 2$          &  \jp{jpjwf}<= \np{jpjglo}-1 \\ 
    460 lp\_obc\_west & $i$-index of a $u$ point   & $j$ of a $T$ point   &$j$ of a $T$ point \\ 
    461 \hline 
    462 East            & \jp{jpieob}$<=$\np{jpiglo}-2&\jp{jpjed} $>= 2$         & \jp{jpjef}$<=$ \np{jpjglo}-1 \\ 
    463  lp\_obc\_east  & $i$-index of a $u$ point    & $j$ of a $T$ point & $j$ of a $T$ point \\ 
    464 \hline 
    465 South           & \jp{jpjsob} $>= 2$         & \jp{jpisd} $>= 2$          & \jp{jpisf}$<=$\np{jpiglo}-1 \\ 
    466 lp\_obc\_south  & $j$-index of a $v$ point   & $i$ of a $T$ point   & $i$ of a $T$ point \\ 
    467 \hline 
    468 North           & \jp{jpjnob} $<=$ \np{jpjglo}-2& \jp{jpind} $>= 2$        & \jp{jpinf}$<=$\np{jpiglo}-1 \\ 
    469 lp\_obc\_north  & $j$-index of a $v$ point      & $i$  of a $T$ point & $i$ of a $T$ point \\ 
    470 \hline 
    471 \end{tabular}    \end{center} 
    472 \caption{     \label{Tab_obc_param} 
    473 Names of different indices relating to the open boundaries. In the case  
    474 of a completely open ocean domain with four ocean boundaries, the parameters  
    475 take exactly the values indicated.} 
    476 \end{table} 
    477 %------------------------------------------------------------------------------------------------------------ 
    478  
    479 The open boundaries must be along coordinate lines. On the C-grid, the boundary  
    480 itself is along a line of normal velocity points: $v$ points for a zonal open boundary  
    481 (the south or north one), and $u$ points for a meridional open boundary (the west  
    482 or east one). Another constraint is that there still must be a row of masked points  
    483 all around the domain, as if the domain were a closed basin (unless periodic conditions  
    484 are used together with open boundary conditions). Therefore, an open boundary  
    485 cannot be located at the first/last index, namely, 1, \jp{jpiglo} or \jp{jpjglo}. Also,  
    486 the open boundary algorithm involves calculating the normal velocity points situated  
    487 just on the boundary, as well as the tangential velocity and temperature and salinity  
    488 just outside the boundary. This means that for a west/south boundary, normal  
    489 velocities and temperature are calculated at the same index \jp{jpiwob} and  
    490 \jp{jpjsob}, respectively. For an east/north boundary, the normal velocity is  
    491 calculated at index \jp{jpieob} and \jp{jpjnob}, but the ``outside'' temperature is  
    492 at index \jp{jpieob}+1 and \jp{jpjnob}+1. This means that \jp{jpieob}, \jp{jpjnob}  
    493 cannot be bigger than \jp{jpiglo}-2, \jp{jpjglo}-2.  
    494  
    495  
    496 The starting and ending indices are to be thought of as $T$ point indices: in many  
    497 cases they indicate the first land $T$-point, at the extremity of an open boundary  
    498 (the coast line follows the $f$ grid points, see Fig.~\ref{Fig_obc_north} for an example  
    499 of a northern open boundary). All indices are relative to the global domain. In the  
    500 free surface case it is possible to have ``ocean corners'', that is, an open boundary  
    501 starting and ending in the ocean. 
    502  
    503 %>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    504 \begin{figure}[!t]     \begin{center} 
    505 \includegraphics[width=0.70\textwidth]{./TexFiles/Figures/Fig_obc_north.pdf} 
    506 \caption{    \label{Fig_obc_north} 
    507 Localization of the North open boundary points.} 
    508 \end{center}     \end{figure} 
    509 %>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    510  
    511 Although not compulsory, it is highly recommended that the bathymetry in the  
    512 vicinity of an open boundary follows the following rule: in the direction perpendicular  
    513 to the open line, the water depth should be constant for 4 grid points. This is in  
    514 order to ensure that the radiation condition, which involves model variables next  
    515 to the boundary, is calculated in a consistent way. On Fig.\ref{Fig_obc_north} we  
    516 indicate by an $=$ symbol, the points which should have the same depth. It means  
    517 that at the 4 points near the boundary, the bathymetry is cylindrical \gmcomment{not sure  
    518 why cylindrical}. The line behind the open $T$-line must be 0 in the bathymetry file  
    519 (as shown on Fig.\ref{Fig_obc_north} for example). 
    520  
    521 %---------------------------------------------- 
    522 \subsection{Boundary data} 
    523 \label{OBC_data} 
    524  
    525 It is necessary to provide information at the boundaries. The simplest case is  
    526 when this information does not change in time and is equal to the initial conditions  
    527 (namelist variable \np{nn\_obcdta}=0). This is the case for the standard configuration  
    528 EEL5 with open boundaries. When (\np{nn\_obcdta}=1), open boundary information  
    529 is read from netcdf files. For convenience the input files are supposed to be similar  
    530 to the ''history'' NEMO output files, for dimension names and variable names.  
    531 Open boundary arrays must be dimensioned according to the parameters of table~ 
    532 \ref{Tab_obc_param}: for example, at the western boundary, arrays have a  
    533 dimension of \jp{jpwf}-\jp{jpwd}+1 in the horizontal and \jp{jpk} in the vertical.  
    534  
    535 When ocean observations are used to generate the boundary data (a hydrographic  
    536 section for example, as in \citet{Treguier_al_JGR01}) it happens often that only the velocity  
    537 normal to the boundary is known, which is the reason why the initial OBC code  
    538 assumes that only $T$, $S$, and the normal velocity ($u$ or $v$) needs to be  
    539 specified. As more and more global model solutions and ocean analysis products  
    540 become available, it will be possible to provide information about all the variables  
    541 (including the tangential velocity) so that the specification of four variables at each  
    542 boundaries will become standard. For the sea surface height, one must distinguish  
    543 between the filtered free surface case and the time-splitting or explicit treatment of  
    544 the free surface. 
    545  In the first case, it is assumed that the user does not wish to represent high  
    546  frequency motions such as tides. The boundary condition is thus one of zero  
    547  normal gradient of sea surface height at the open boundaries, following \citet{Marchesiello2001}.  
    548 No information other than the total velocity needs to be provided at the open  
    549 boundaries in that case. In the other two cases (time splitting or explicit free surface),  
    550 the user must provide barotropic information (sea surface height and barotropic  
    551 velocities) and the use of the Flather algorithm for barotropic variables is  
    552 recommanded. However, this algorithm has not yet been fully tested and bugs  
    553 remain in NEMO v2.3. Users should read the code carefully before using it. Finally,  
    554 in the case of the rigid lid approximation the barotropic streamfunction must be  
    555 provided, as documented in \citet{Treguier_al_JGR01}). This option is no longer  
    556 recommended but remains in NEMO V2.3. 
    557  
    558 One frequently encountered case is when an open boundary domain is constructed  
    559 from a global or larger scale NEMO configuration. Assuming the domain corresponds  
    560 to indices $ib:ie$, $jb:je$ of the global domain, the bathymetry and forcing of the  
    561 small domain can be created by using the following netcdf utility on the global files:  
    562 ncks -F $-d\;x,ib,ie$ $-d\;y,jb,je$ (part of the nco series of utilities,  
    563 see their \href{http://nco.sourceforge.net}{website}).  
    564 The open boundary files can be constructed using ncks  
    565 commands, following table~\ref{Tab_obc_ind}.  
    566  
    567 %--------------------------------------------------TABLE-------------------------------------------------- 
    568 \begin{table}[htbp]     \begin{center}      \begin{tabular}{|l|c|c|c|c|c|} 
    569 \hline 
    570 OBC  & Variable   & file name      & Index  & Start  & end  \\ 
    571 West &  T,S       &   obcwest\_TS.nc &  $ib$+1     &   $jb$+1 &  $je-1$  \\ 
    572      &    U       &   obcwest\_U.nc  &  $ib$+1     &   $jb$+1 &  $je-1$  \\  
    573      &    V       &   obcwest\_V.nc  &  $ib$+1     &   $jb$+1 &  $je-1$  \\        
    574 \hline 
    575 East &  T,S       &   obceast\_TS.nc &  $ie$-1     &   $jb$+1 &  $je-1$  \\ 
    576      &    U       &   obceast\_U.nc  &  $ie$-2     &   $jb$+1 &  $je-1$  \\  
    577      &    V       &   obceast\_V.nc  &  $ie$-1     &   $jb$+1 &  $je-1$  \\        
    578 \hline          
    579 South &  T,S      &   obcsouth\_TS.nc &  $jb$+1     &  $ib$+1 &  $ie-1$  \\ 
    580       &    U      &   obcsouth\_U.nc  &  $jb$+1     &  $ib$+1 &  $ie-1$  \\  
    581       &    V      &   obcsouth\_V.nc  &  $jb$+1     &  $ib$+1 &  $ie-1$  \\     
    582 \hline 
    583 North &  T,S      &   obcnorth\_TS.nc &  $je$-1     &  $ib$+1 &  $ie-1$  \\ 
    584       &    U      &   obcnorth\_U.nc  &  $je$-1     &  $ib$+1 &  $ie-1$  \\  
    585       &    V      &   obcnorth\_V.nc  &  $je$-2     &  $ib$+1 &  $ie-1$  \\   
    586 \hline 
    587 \end{tabular}     \end{center} 
    588 \caption{    \label{Tab_obc_ind} 
    589 Requirements for creating open boundary files from a global configuration,  
    590 appropriate for the subdomain of indices $ib:ie$, $jb:je$. ``Index'' designates the  
    591 $i$ or $j$ index along which the $u$ of $v$ boundary point is situated in the global  
    592 configuration, starting and ending with the $j$ or $i$ indices indicated.  
    593 For example, to generate file obcnorth\_V.nc, use the command ncks  
    594 $-F$ $-d\;y,je-2$  $-d\;x,ib+1,ie-1$ }  
    595 \end{table} 
    596 %----------------------------------------------------------------------------------------------------------- 
    597  
    598 It is assumed that the open boundary files contain the variables for the period of  
    599 the model integration. If the boundary files contain one time frame, the boundary  
    600 data is held fixed in time. If the files contain 12 values, it is assumed that the input  
    601 is a climatology for a repeated annual cycle (corresponding to the case \np{ln\_obc\_clim}  
    602 =true). The case of an arbitrary number of time frames is not yet implemented  
    603 correctly; the user is required to write his own code in the module \mdl{obc\_dta}  
    604 to deal with this situation.  
    605  
    606 \subsection{Radiation algorithm} 
    607 \label{OBC_rad} 
    608  
    609 The art of open boundary management consists in applying a constraint strong  
    610 enough that the inner domain "feels" the rest of the ocean, but weak enough 
    611 that perturbations are allowed to leave the domain with minimum false reflections  
    612 of energy. The constraints are specified separately at each boundary as time  
    613 scales for ''inflow'' and ''outflow'' as defined below. The time scales are set (in days)  
    614 by namelist parameters such as \np{rn\_dpein}, \np{rn\_dpeob} for the eastern open  
    615 boundary for example. When both time scales are zero for a given boundary  
    616 ($e.g.$ for the western boundary, \jp{lp\_obc\_west}=true, \np{rn\_dpwob}=0 and  
    617 \np{rn\_dpwin}=0) this means that the boundary in question is a ''fixed '' boundary  
    618 where the solution is set exactly by the boundary data. This is not recommended,  
    619 except in combination with increased viscosity in a ''sponge'' layer next to the  
    620 boundary in order to avoid spurious reflections.   
    621  
    622  
    623 The radiation\/relaxation \gmcomment{the / doesnt seem to appear in the output}  
    624 algorithm is applied when either relaxation time (for ''inflow'' or ''outflow'') is  
    625 non-zero. It has been developed and tested in the SPEM model and its  
    626 successor ROMS \citep{Barnier1996, Marchesiello2001}, which is an  
    627 $s$-coordinate model on an Arakawa C-grid. Although the algorithm has  
    628 been numerically successful in the CLIPPER Atlantic models, the physics  
    629 do not work as expected \citep{Treguier_al_JGR01}. Users are invited to consider  
    630 open boundary conditions (OBC hereafter) with some scepticism  
    631 \citep{Durran2001, Blayo2005}. 
    632  
    633 The first part of the algorithm calculates a phase velocity to determine  
    634 whether perturbations tend to propagate toward, or away from, the  
    635 boundary. Let us consider a model variable $\phi$.  
    636 The phase velocities ($C_{\phi x}$,$C_{\phi y}$) for the variable $\phi$,  
    637 in the directions normal and tangential to the boundary are 
    638 \begin{equation} \label{Eq_obc_cphi} 
    639 C_{\phi x} = \frac{ -\phi_{t} }{ ( \phi_{x}^{2} + \phi_{y}^{2}) } \phi_{x}  
    640 \;\;\;\;\; \;\;\;  
    641 C_{\phi y} = \frac{ -\phi_{t} }{ ( \phi_{x}^{2} + \phi_{y}^{2}) } \phi_{y}.  
    642 \end{equation} 
    643 Following \citet{Treguier_al_JGR01} and \citet{Marchesiello2001} we retain only  
    644 the normal component of the velocity, $C_{\phi x}$, setting $C_{\phi y} =0$  
    645 (but unlike the original Orlanski radiation algorithm we retain $\phi_{y}$ in  
    646 the expression for $C_{\phi x}$).   
    647  
    648 The discrete form of (\ref{Eq_obc_cphi}), described by \citet{Barnier1998}, 
    649 takes into account the two rows of grid points situated inside the domain  
    650 next to the boundary, and the three previous time steps ($n$, $n-1$, 
    651 and $n-2$). The same equation can then be discretized at the boundary at 
    652 time steps $n-1$, $n$ and $n+1$ \gmcomment{since the original was three time-level}  
    653 in order to extrapolate for the new boundary value $\phi^{n+1}$.  
    654  
    655 In the open boundary algorithm as implemented in NEMO v2.3, the new boundary  
    656 values are updated differently depending on the sign of $C_{\phi x}$. Let us take  
    657 an eastern boundary as an example. The solution for variable $\phi$ at the  
    658 boundary is given by a generalized wave equation with phase velocity $C_{\phi}$,  
    659 with the addition of a relaxation term, as: 
    660 \begin{eqnarray} 
    661 \phi_{t} &  =  & -C_{\phi x} \phi_{x} + \frac{1}{\tau_{o}} (\phi_{c}-\phi)  
    662                         \;\;\; \;\;\; \;\;\; (C_{\phi x} > 0), \label{Eq_obc_rado} \\ 
    663 \phi_{t} &  =  & \frac{1}{\tau_{i}} (\phi_{c}-\phi)  
    664 \;\;\; \;\;\; \;\;\;\;\;\; (C_{\phi x} < 0), \label{Eq_obc_radi} 
    665 \end{eqnarray} 
    666 where $\phi_{c}$ is the estimate of $\phi$ at the boundary, provided as boundary  
    667 data. Note that in (\ref{Eq_obc_rado}), $C_{\phi x}$ is bounded by the ratio  
    668 $\delta x/\delta t$ for stability reasons. When $C_{\phi x}$ is eastward (outward  
    669 propagation), the radiation condition (\ref{Eq_obc_rado}) is used.  
    670 When  $C_{\phi x}$ is westward (inward propagation), (\ref{Eq_obc_radi}) is  
    671 used with a strong relaxation to climatology (usually $\tau_{i}=\np{rn\_dpein}=$1~day). 
    672 Equation (\ref{Eq_obc_radi}) is solved with a Euler time-stepping scheme. As a  
    673 consequence, setting $\tau_{i}$ smaller than, or equal to the time step is equivalent  
    674 to a fixed boundary condition. A time scale of one day is usually a good compromise  
    675 which guarantees that the inflow conditions remain close to climatology while ensuring  
    676 numerical stability.  
    677  
    678 In  the case of a western boundary located in the Eastern Atlantic, \citet{Penduff_al_JGR00}  
    679 have been able to implement the radiation algorithm without any boundary data,  
    680 using persistence from the previous time step instead. This solution has not worked  
    681 in other cases \citep{Treguier_al_JGR01}, so that the use of boundary data is recommended.  
    682 Even in the outflow condition (\ref{Eq_obc_rado}), we have found it desirable to  
    683 maintain a weak relaxation to climatology. The time step is usually chosen so as to  
    684 be larger than typical turbulent scales (of order 1000~days \gmcomment{or maybe seconds?}). 
    685  
    686 The radiation condition is applied to the model variables: temperature, salinity,  
    687 tangential and normal velocities. For normal and tangential velocities, $u$ and $v$,  
    688 radiation is applied with phase velocities calculated from $u$ and $v$ respectively.   
    689 For the radiation of tracers, we use the phase velocity calculated from the tangential  
    690 velocity in order to avoid calculating too many independent radiation velocities and  
    691 because tangential velocities and tracers have the same position along the boundary  
    692 on a C-grid.   
    693  
    694 \subsection{Domain decomposition (\key{mpp\_mpi})} 
    695 \label{OBC_mpp} 
    696 When \key{mpp\_mpi} is active in the code, the computational domain is divided  
    697 into rectangles that are attributed each to a different processor. The open boundary  
    698 code is ``mpp-compatible'' up to a certain point. The radiation algorithm will not  
    699 work if there is an mpp subdomain boundary parallel to the open boundary at the  
    700 index of the boundary, or the grid point after (outside), or three grid points before  
    701 (inside). On the other hand, there is no problem if an mpp subdomain boundary  
    702 cuts the open boundary perpendicularly. These geometrical limitations must be  
    703 checked for by the user (there is no safeguard in the code).   
    704 The general principle for the open boundary mpp code is that loops over the open  
    705 boundaries {not sure what this means} are performed on local indices (nie0,  
    706 nie1, nje0, nje1 for an eastern boundary for instance) that are initialized in module  
    707 \mdl{obc\_ini}. Those indices have relevant values on the processors that contain  
    708 a segment of an open boundary. For processors that do not include an open  
    709 boundary segment, the indices are such that the calculations within the loops are  
    710 not performed. 
    711 \gmcomment{I dont understand most of the last few sentences} 
    712   
    713 Arrays of climatological data that are read from files are seen by all processors  
    714 and have the same dimensions for all (for instance, for the eastern boundary,  
    715 uedta(jpjglo,jpk,2)). On the other hand, the arrays for the calculation of radiation  
    716 are local to each processor (uebnd(jpj,jpk,3,3) for instance).  This allowed the  
    717 CLIPPER model for example, to save on memory where the eastern boundary  
    718 crossed 8 processors so that \jp{jpj} was much smaller than (\jp{jpjef}-\jp{jpjed}+1).  
    719  
    720 \subsection{Volume conservation} 
    721 \label{OBC_vol} 
    722  
    723 It is necessary to control the volume inside a domain when using open boundaries.  
    724 With fixed boundaries, it is enough to ensure that the total inflow/outflow has  
    725 reasonable values (either zero or a value compatible with an observed volume  
    726 balance). When using radiative boundary conditions it is necessary to have a  
    727 volume constraint because each open boundary works independently from the  
    728 others. The methodology used to control this volume is identical to the one  
    729 coded in the ROMS model \citep{Marchesiello2001}. 
    730  
    731  
    732 %---------------------------------------- EXTRAS 
    733 \colorbox{yellow}{Explain obc\_vol{\ldots}} 
    734  
    735 \colorbox{yellow}{OBC algorithm for update, OBC restart, list of routines where obc key appears{\ldots}} 
    736  
    737 \colorbox{yellow}{OBC rigid lid? {\ldots}} 
    738364 
    739365% ==================================================================== 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Chapters/Chap_LDF.tex

    r4147 r6436  
    11 
    22% ================================================================ 
    3 % Chapter Lateral Ocean Physics (LDF) 
     3% Chapter ——— Lateral Ocean Physics (LDF) 
    44% ================================================================ 
    55\chapter{Lateral Ocean Physics (LDF)} 
     
    6868When none of the \textbf{key\_dynldf\_...} and \textbf{key\_traldf\_...} keys are  
    6969defined, a constant value is used over the whole ocean for momentum and  
    70 tracers, which is specified through the \np{rn\_ahm0} and \np{rn\_aht0} namelist  
     70tracers, which is specified through the \np{rn\_ahm\_0\_lap} and \np{rn\_aht\_0} namelist  
    7171parameters. 
    7272 
     
    7777mixing coefficients will require 3D arrays. In the 1D option, a hyperbolic variation  
    7878of the lateral mixing coefficient is introduced in which the surface value is  
    79 \np{rn\_aht0} (\np{rn\_ahm0}), the bottom value is 1/4 of the surface value,  
     79\np{rn\_aht\_0} (\np{rn\_ahm\_0\_lap}), the bottom value is 1/4 of the surface value,  
    8080and the transition takes place around z=300~m with a width of 300~m  
    8181($i.e.$ both the depth and the width of the inflection point are set to 300~m).  
     
    9393\end{equation} 
    9494where $e_{max}$ is the maximum of $e_1$ and $e_2$ taken over the whole masked  
    95 ocean domain, and $A_o^l$ is the \np{rn\_ahm0} (momentum) or \np{rn\_aht0} (tracer)  
     95ocean domain, and $A_o^l$ is the \np{rn\_ahm\_0\_lap} (momentum) or \np{rn\_aht\_0} (tracer)  
    9696namelist parameter. This variation is intended to reflect the lesser need for subgrid  
    9797scale eddy mixing where the grid size is smaller in the domain. It was introduced in  
     
    105105Other formulations can be introduced by the user for a given configuration.  
    106106For example, in the ORCA2 global ocean model (see Configurations), the laplacian  
    107 viscosity operator uses \np{rn\_ahm0}~= 4.10$^4$ m$^2$/s poleward of 20$^{\circ}$  
    108 north and south and decreases linearly to \np{rn\_aht0}~= 2.10$^3$ m$^2$/s  
     107viscosity operator uses \np{rn\_ahm\_0\_lap}~= 4.10$^4$ m$^2$/s poleward of 20$^{\circ}$  
     108north and south and decreases linearly to \np{rn\_aht\_0}~= 2.10$^3$ m$^2$/s  
    109109at the equator \citep{Madec_al_JPO96, Delecluse_Madec_Bk00}. This modification  
    110110can be found in routine \rou{ldf\_dyn\_c2d\_orca} defined in \mdl{ldfdyn\_c2d}.  
     
    120120\subsubsection{Space and Time Varying Mixing Coefficients} 
    121121 
    122 There is no default specification of space and time varying mixing coefficient.  
    123 The only case available is specific to the ORCA2 and ORCA05 global ocean  
    124 configurations. It provides only a tracer  
    125 mixing coefficient for eddy induced velocity (ORCA2) or both iso-neutral and  
    126 eddy induced velocity (ORCA05) that depends on the local growth rate of  
    127 baroclinic instability. This specification is actually used when an ORCA key  
     122There are no default specifications of space and time varying mixing coefficient.  One 
     123available case is specific to the ORCA2 and ORCA05 global ocean configurations. It 
     124provides only a tracer mixing coefficient for eddy induced velocity (ORCA2) or both 
     125iso-neutral and eddy induced velocity (ORCA05) that depends on the local growth rate of 
     126baroclinic instability. This specification is actually used when an ORCA key 
    128127and both \key{traldf\_eiv} and \key{traldf\_c2d} are defined. 
     128 
     129\subsubsection{Smagorinsky viscosity (\key{dynldf\_c3d} and \key{dynldf\_smag})} 
     130 
     131The \key{dynldf\_smag} key activates a 3D, time-varying viscosity that depends on the 
     132resolved motions. Following \citep{Smagorinsky_93} the viscosity coefficient is set 
     133proportional to a local deformation rate based on the horizontal shear and tension, 
     134namely: 
     135 
     136\begin{equation} 
     137A_{m_{Smag}} = \left(\frac{{\sf CM_{Smag}}}{\pi}\right)^2L^2\vert{D}\vert 
     138\end{equation} 
     139 
     140\noindent where the deformation rate $\vert{D}\vert$ is given by  
     141 
     142\begin{equation} 
     143\vert{D}\vert=\sqrt{\left({\frac{\partial{u}} {\partial{x}}} 
     144                         -{\frac{\partial{v}} {\partial{y}}}\right)^2 
     145                 +  \left({\frac{\partial{u}} {\partial{y}}} 
     146                         +{\frac{\partial{v}} {\partial{x}}}\right)^2}  
     147\end{equation} 
     148 
     149\noindent and $L$ is the local gridscale given by: 
     150 
     151\begin{equation} 
     152L^2 = \frac{2{e_1}^2 {e_2}^2}{\left ( {e_1}^2 + {e_2}^2 \right )} 
     153\end{equation} 
     154 
     155\citep{Griffies_Hallberg_MWR00} suggest values in the range 2.2 to 4.0 of the coefficient 
     156$\sf CM_{Smag}$ for oceanic flows. This value is set via the \np{rn\_cmsmag\_1} namelist 
     157parameter. An additional parameter: \np{rn\_cmsh} is included in NEMO for experimenting 
     158with the contribution of the shear term. A value of 1.0 (the default) calculates the 
     159deformation rate as above; a value of 0.0 will discard the shear term entirely. 
     160 
     161For numerical stability, the calculated viscosity is bounded according to the following: 
     162 
     163\begin{equation} 
     164{\rm MIN}\left ({ L^2\over {8\Delta{t}}}, rn\_ahm\_m\_lap\right ) \geq A_{m_{Smag}}  
     165                                                                  \geq rn\_ahm\_0\_lap 
     166\end{equation} 
     167 
     168\noindent with both parameters for the upper and lower bounds being provided via the 
     169indicated namelist parameters. 
     170 
     171\bigskip When $ln\_dynldf\_bilap = .true.$, a biharmonic version of the Smagorinsky 
     172viscosity is also available which sets a coefficient for the biharmonic viscosity as: 
     173 
     174\begin{equation} 
     175B_{m_{Smag}} = - \left(\frac{{\sf CM_{bSmag}}}{\pi}\right)^2 {L^4\over 8}\vert{D}\vert 
     176\end{equation} 
     177 
     178\noindent which is bounded according to: 
     179 
     180\begin{equation} 
     181{\rm MAX}\left (-{ L^4\over {64\Delta{t}}}, rn\_ahm\_m\_blp\right ) \leq B_{m_{Smag}}  
     182                                                                    \leq rn\_ahm\_0\_blp 
     183\end{equation} 
     184 
     185\noindent Note the reversal of the inequalities here because NEMO requires the biharmonic 
     186coefficients as negative numbers. $\sf CM_{bSmag}$ is set via the \np{rn\_cmsmag\_2} 
     187namelist parameter and the bounding values have corresponding entries in the namelist too. 
     188 
     189\bigskip The current implementation in NEMO also allows for 3D, time-varying diffusivities 
     190to be set using the Smagorinsky approach. Users should note that this option is not 
     191recommended for many applications since diffusivities will tend to be largest near 
     192boundaries (where shears are greatest) leading to spurious upwellings 
     193(\citep{Griffies_Bk04}, chapter 18.3.4). Nevertheless the option is there for those 
     194wishing to experiment. This choice requires both \key{traldf\_c3d} and \key{traldf\_smag} 
     195and uses the \np{rn\_chsmag} (${\sf CH_{Smag}}$), \np{rn\_smsh} and \np{rn\_aht\_m} 
     196namelist parameters in an analogous way to \np{rn\_cmsmag\_1}, \np{rn\_cmsh} and 
     197\np{rn\_ahm\_m\_lap} (see above) to set the diffusion coefficient: 
     198 
     199\begin{equation} 
     200A_{h_{Smag}} = \left(\frac{{\sf CH_{Smag}}}{\pi}\right)^2L^2\vert{D}\vert 
     201\end{equation} 
     202 
     203  
     204For numerical stability, the calculated diffusivity is bounded according to the following: 
     205 
     206\begin{equation} 
     207{\rm MIN}\left ({ L^2\over {8\Delta{t}}}, rn\_aht\_m\right ) \geq A_{h_{Smag}}  
     208                                                             \geq rn\_aht\_0 
     209\end{equation} 
     210 
     211 
    129212 
    130213$\ $\newline    % force a new ligne 
     
    144227(3) for isopycnal diffusion on momentum or tracers, an additional purely  
    145228horizontal background diffusion with uniform coefficient can be added by  
    146 setting a non zero value of \np{rn\_ahmb0} or \np{rn\_ahtb0}, a background horizontal  
     229setting a non zero value of \np{rn\_ahmb\_0} or \np{rn\_ahtb\_0}, a background horizontal  
    147230eddy viscosity or diffusivity coefficient (namelist parameters whose default  
    148231values are $0$). However, the technique used to compute the isopycnal  
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Chapters/Chap_MISC.tex

    r5118 r6436  
    3434has been made to set them in a generic way. However, examples of how  
    3535they can be set up is given in the ORCA 2\deg and 0.5\deg configurations. For example,  
    36 for details of implementation in ORCA2, search: 
    37 \vspace{-10pt}   
    38 \begin{alltt}   
    39 \tiny     
    40 \begin{verbatim} 
    41 IF( cp_cfg == "orca" .AND. jp_cfg == 2 ) 
    42 \end{verbatim}   
    43 \end{alltt} 
     36for details of implementation in ORCA2, search:  
     37\texttt{ IF( cp\_cfg == "orca" .AND. jp\_cfg == 2 ) } 
    4438 
    4539% ------------------------------------------------------------------------------------------------------------- 
     
    8983%-------------------------------------------------------------------------------------------------------------- 
    9084 
    91 \colorbox{yellow}{Add a short description of CLA staff here or in lateral boundary condition chapter?} 
    9285Options are defined through the  \ngn{namcla} namelist variables. 
     86This option is an obsolescent feature that will be removed in version 3.7 and followings.  
    9387 
    9488%The problem is resolved here by allowing the mixing of tracers and mass/volume between non-adjacent water columns at nominated regions within the model. Momentum is not mixed. The scheme conserves total tracer content, and total volume (the latter in $z*$- or $s*$-coordinate), and maintains compatibility between the tracer and mass/volume budgets.   
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Chapters/Chap_Model_Basics.tex

    r3294 r6436  
    247247sufficient to solve a linearized version of (\ref{Eq_PE_ssh}), which still allows  
    248248to take into account freshwater fluxes applied at the ocean surface \citep{Roullet_Madec_JGR00}. 
     249Nevertheless, with the linearization, an exact conservation of heat and salt contents is lost. 
    249250 
    250251The filtering of EGWs in models with a free surface is usually a matter of discretisation  
    251 of the temporal derivatives, using the time splitting method \citep{Killworth_al_JPO91, Zhang_Endoh_JGR92}  
    252 or the implicit scheme \citep{Dukowicz1994}. In \NEMO, we use a slightly different approach  
    253 developed by \citet{Roullet_Madec_JGR00}: the damping of EGWs is ensured by introducing an  
    254 additional force in the momentum equation. \eqref{Eq_PE_dyn} becomes:  
    255 \begin{equation} \label{Eq_PE_flt} 
    256 \frac{\partial {\rm {\bf U}}_h }{\partial t}= {\rm {\bf M}} 
    257 - g \nabla \left( \tilde{\rho} \ \eta \right)  
    258 - g \ T_c \nabla \left( \widetilde{\rho} \ \partial_t \eta \right)  
    259 \end{equation} 
    260 where $T_c$, is a parameter with dimensions of time which characterizes the force,  
    261 $\widetilde{\rho} = \rho / \rho_o$ is the dimensionless density, and $\rm {\bf M}$  
    262 represents the collected contributions of the Coriolis, hydrostatic pressure gradient,  
    263 non-linear and viscous terms in \eqref{Eq_PE_dyn}. 
    264  
    265 The new force can be interpreted as a diffusion of vertically integrated volume flux divergence.  
    266 The time evolution of $D$ is thus governed by a balance of two terms, $-g$ \textbf{A} $\eta$  
    267 and $g \, T_c \,$ \textbf{A} $D$, associated with a propagative regime and a diffusive regime  
    268 in the temporal spectrum, respectively. In the diffusive regime, the EGWs no longer propagate,  
    269 $i.e.$ they are stationary and damped. The diffusion regime applies to the modes shorter than  
    270 $T_c$. For longer ones, the diffusion term vanishes. Hence, the temporally unresolved EGWs  
    271 can be damped by choosing $T_c > \rdt$. \citet{Roullet_Madec_JGR00} demonstrate that  
    272 (\ref{Eq_PE_flt}) can be integrated with a leap frog scheme except the additional term which  
    273 has to be computed implicitly. This is not surprising since the use of a large time step has a  
    274 necessarily numerical cost. Two gains arise in comparison with the previous formulations.  
    275 Firstly, the damping of EGWs can be quantified through the magnitude of the additional term.  
    276 Secondly, the numerical scheme does not need any tuning. Numerical stability is ensured as  
    277 soon as $T_c > \rdt$. 
    278  
    279 When the variations of free surface elevation are small compared to the thickness of the first  
    280 model layer, the free surface equation (\ref{Eq_PE_ssh}) can be linearized. As emphasized  
    281 by \citet{Roullet_Madec_JGR00} the linearization of (\ref{Eq_PE_ssh}) has consequences on the  
    282 conservation of salt in the model. With the nonlinear free surface equation, the time evolution  
    283 of the total salt content is  
    284 \begin{equation} \label{Eq_PE_salt_content} 
    285     \frac{\partial }{\partial t}\int\limits_{D\eta } {S\;dv}  
    286                         =\int\limits_S {S\;(-\frac{\partial \eta }{\partial t}-D+P-E)\;ds} 
    287 \end{equation} 
    288 where $S$ is the salinity, and the total salt is integrated over the whole ocean volume  
    289 $D_\eta$ bounded by the time-dependent free surface. The right hand side (which is an  
    290 integral over the free surface) vanishes when the nonlinear equation (\ref{Eq_PE_ssh})  
    291 is satisfied, so that the salt is perfectly conserved. When the free surface equation is  
    292 linearized, \citet{Roullet_Madec_JGR00} show that the total salt content integrated in the fixed  
    293 volume $D$ (bounded by the surface $z=0$) is no longer conserved: 
    294 \begin{equation} \label{Eq_PE_salt_content_linear} 
    295          \frac{\partial }{\partial t}\int\limits_D {S\;dv}  
    296                = - \int\limits_S {S\;\frac{\partial \eta }{\partial t}ds}  
    297 \end{equation} 
    298  
    299 The right hand side of (\ref{Eq_PE_salt_content_linear}) is small in equilibrium solutions  
    300 \citep{Roullet_Madec_JGR00}. It can be significant when the freshwater forcing is not balanced and  
    301 the globally averaged free surface is drifting. An increase in sea surface height \textit{$\eta $}  
    302 results in a decrease of the salinity in the fixed volume $D$. Even in that case though,  
    303 the total salt integrated in the variable volume $D_{\eta}$ varies much less, since  
    304 (\ref{Eq_PE_salt_content_linear}) can be rewritten as  
    305 \begin{equation} \label{Eq_PE_salt_content_corrected} 
    306 \frac{\partial }{\partial t}\int\limits_{D\eta } {S\;dv}  
    307 =\frac{\partial}{\partial t} \left[ \;{\int\limits_D {S\;dv} +\int\limits_S {S\eta \;ds} } \right] 
    308 =\int\limits_S {\eta \;\frac{\partial S}{\partial t}ds} 
    309 \end{equation} 
    310  
    311 Although the total salt content is not exactly conserved with the linearized free surface,  
    312 its variations are driven by correlations of the time variation of surface salinity with the  
    313 sea surface height, which is a negligible term. This situation contrasts with the case of  
    314 the rigid lid approximation in which case freshwater forcing is represented by a virtual  
    315 salt flux, leading to a spurious source of salt at the ocean surface  
    316 \citep{Huang_JPO93, Roullet_Madec_JGR00}. 
    317  
    318 \newpage 
    319 $\ $\newline    % force a new ligne 
     252of the temporal derivatives, using a split-explicit method \citep{Killworth_al_JPO91, Zhang_Endoh_JGR92}  
     253or the implicit scheme \citep{Dukowicz1994} or the addition of a filtering force in the momentum equation  
     254\citep{Roullet_Madec_JGR00}. With the present release, \NEMO offers the choice between  
     255an explicit free surface (see \S\ref{DYN_spg_exp}) or a split-explicit scheme strongly  
     256inspired the one proposed by \citet{Shchepetkin_McWilliams_OM05} (see \S\ref{DYN_spg_ts}). 
     257 
     258%\newpage 
     259%$\ $\newline    % force a new line 
    320260 
    321261% ================================================================ 
     
    773713\end{equation} 
    774714 
    775 The equations solved by the ocean model \eqref{Eq_PE} in $s-$coordinate can be written as follows: 
     715The equations solved by the ocean model \eqref{Eq_PE} in $s-$coordinate can be written as follows (see Appendix~\ref{Apdx_A_momentum}): 
    776716 
    777717 \vspace{0.5cm} 
    778 * momentum equation: 
     718$\bullet$ Vector invariant form of the momentum equation : 
    779719\begin{multline} \label{Eq_PE_sco_u} 
    780 \frac{1}{e_3} \frac{\partial \left(  e_3\,u  \right) }{\partial t}= 
     720\frac{\partial  u  }{\partial t}= 
    781721   +   \left( {\zeta +f} \right)\,v                                     
    782722   -   \frac{1}{2\,e_1} \frac{\partial}{\partial i} \left(  u^2+v^2   \right)  
     
    787727\end{multline} 
    788728\begin{multline} \label{Eq_PE_sco_v} 
    789 \frac{1}{e_3} \frac{\partial \left(  e_3\,v  \right) }{\partial t}= 
     729\frac{\partial v }{\partial t}= 
    790730   -   \left( {\zeta +f} \right)\,u    
    791731   -   \frac{1}{2\,e_2 }\frac{\partial }{\partial j}\left(  u^2+v^2  \right)         
     
    795735   +  D_v^{\vect{U}}  +   F_v^{\vect{U}} \quad 
    796736\end{multline} 
     737 
     738 \vspace{0.5cm} 
     739$\bullet$ Vector invariant form of the momentum equation : 
     740\begin{multline} \label{Eq_PE_sco_u} 
     741\frac{1}{e_3} \frac{\partial \left(  e_3\,u  \right) }{\partial t}= 
     742   +   \left( { f + \frac{1}{e_1 \; e_2 } 
     743               \left(    v \frac{\partial e_2}{\partial i} 
     744                  -u \frac{\partial e_1}{\partial j}  \right)}    \right) \, v    \\ 
     745   - \frac{1}{e_1 \; e_2 \; e_3 }   \left(  
     746               \frac{\partial \left( {e_2 \, e_3 \, u\,u} \right)}{\partial i} 
     747      +        \frac{\partial \left( {e_1 \, e_3 \, v\,u} \right)}{\partial j}   \right) 
     748   - \frac{1}{e_3 }\frac{\partial \left( { \omega\,u} \right)}{\partial k}    \\ 
     749   - \frac{1}{e_1} \frac{\partial}{\partial i} \left( \frac{p_s + p_h}{\rho _o}    \right)     
     750   +  g\frac{\rho }{\rho _o}\sigma _1  
     751   +   D_u^{\vect{U}}  +   F_u^{\vect{U}} \quad 
     752\end{multline} 
     753\begin{multline} \label{Eq_PE_sco_v} 
     754\frac{1}{e_3} \frac{\partial \left(  e_3\,v  \right) }{\partial t}= 
     755   -   \left( { f + \frac{1}{e_1 \; e_2} 
     756               \left(    v \frac{\partial e_2}{\partial i} 
     757                  -u \frac{\partial e_1}{\partial j}  \right)}    \right) \, u   \\ 
     758   - \frac{1}{e_1 \; e_2 \; e_3 }   \left(  
     759               \frac{\partial \left( {e_2 \; e_3  \,u\,v} \right)}{\partial i} 
     760      +        \frac{\partial \left( {e_1 \; e_3  \,v\,v} \right)}{\partial j}   \right) 
     761                 - \frac{1}{e_3 } \frac{\partial \left( { \omega\,v} \right)}{\partial k}    \\ 
     762   -   \frac{1}{e_2 }\frac{\partial }{\partial j}\left( \frac{p_s+p_h }{\rho _o}  \right)  
     763    +  g\frac{\rho }{\rho _o }\sigma _2    
     764   +  D_v^{\vect{U}}  +   F_v^{\vect{U}} \quad 
     765\end{multline} 
     766 
    797767where the relative vorticity, \textit{$\zeta $}, the surface pressure gradient, and the hydrostatic  
    798768pressure have the same expressions as in $z$-coordinates although they do not represent  
    799769exactly the same quantities. $\omega$ is provided by the continuity equation  
    800770(see Appendix~\ref{Apdx_A}): 
    801  
    802771\begin{equation} \label{Eq_PE_sco_continuity} 
    803772\frac{\partial e_3}{\partial t} + e_3 \; \chi + \frac{\partial \omega }{\partial s} = 0    
     
    809778 
    810779 \vspace{0.5cm} 
    811 * tracer equations: 
     780$\bullet$ tracer equations: 
    812781\begin{multline} \label{Eq_PE_sco_t} 
    813782\frac{1}{e_3} \frac{\partial \left(  e_3\,T  \right) }{\partial t}= 
     
    1023992\label{PE_zco_tilde} 
    1024993 
    1025 The $\tilde{z}$-coordinate has been developed by \citet{Leclair_Madec_OM10s}. 
    1026 It is not available in the current version of \NEMO. 
     994The $\tilde{z}$-coordinate has been developed by \citet{Leclair_Madec_OM11}. 
     995It is available in \NEMO since the version 3.4. Nevertheless, it is currently not robust enough  
     996to be used in all possible configurations. Its use is therefore not recommended. 
     997 
    1027998 
    1028999\newpage  
     
    11571128operator acting along $s-$surfaces (see \S\ref{LDF}). 
    11581129 
    1159 \subsubsection{Lateral second order tracer diffusive operator} 
    1160  
    1161 The lateral second order tracer diffusive operator is defined by (see Appendix~\ref{Apdx_B}): 
     1130\subsubsection{Lateral Laplacian tracer diffusive operator} 
     1131 
     1132The lateral Laplacian tracer diffusive operator is defined by (see Appendix~\ref{Apdx_B}): 
    11621133\begin{equation} \label{Eq_PE_iso_tensor} 
    11631134D^{lT}=\nabla {\rm {\bf .}}\left( {A^{lT}\;\Re \;\nabla T} \right) \qquad  
     
    11801151ocean (see Appendix~\ref{Apdx_B}). 
    11811152 
     1153For \textit{iso-level} diffusion, $r_1$ and $r_2 $ are zero. $\Re $ reduces to the identity  
     1154in the horizontal direction, no rotation is applied.  
     1155 
    11821156For \textit{geopotential} diffusion, $r_1$ and $r_2 $ are the slopes between the  
    1183 geopotential and computational surfaces: in $z$-coordinates they are zero  
    1184 ($r_1 = r_2 = 0$) while in $s$-coordinate (including $\textit{z*}$ case) they are  
    1185 equal to $\sigma _1$ and $\sigma _2$, respectively (see \eqref{Eq_PE_sco_slope} ). 
     1157geopotential and computational surfaces: they are equal to $\sigma _1$ and $\sigma _2$,  
     1158respectively (see \eqref{Eq_PE_sco_slope} ). 
    11861159 
    11871160For \textit{isoneutral} diffusion $r_1$ and $r_2$ are the slopes between the isoneutral  
     
    12311204to zero in the vicinity of the boundaries. The latter strategy is used in \NEMO (cf. Chap.~\ref{LDF}). 
    12321205 
    1233 \subsubsection{Lateral fourth order tracer diffusive operator} 
    1234  
    1235 The lateral fourth order tracer diffusive operator is defined by: 
     1206\subsubsection{Lateral bilaplacian tracer diffusive operator} 
     1207 
     1208The lateral bilaplacian tracer diffusive operator is defined by: 
    12361209\begin{equation} \label{Eq_PE_bilapT} 
    12371210D^{lT}=\Delta \left( {A^{lT}\;\Delta T} \right)  
    12381211\qquad \text{where} \  D^{lT}=\Delta \left( {A^{lT}\;\Delta T} \right) 
    12391212 \end{equation} 
    1240  
    12411213It is the second order operator given by \eqref{Eq_PE_iso_tensor} applied twice with  
    12421214the eddy diffusion coefficient correctly placed.  
    12431215 
    1244  
    1245 \subsubsection{Lateral second order momentum diffusive operator} 
    1246  
    1247 The second order momentum diffusive operator along $z$- or $s$-surfaces is found by  
     1216\subsubsection{Lateral Laplacian momentum diffusive operator} 
     1217 
     1218The Laplacian momentum diffusive operator along $z$- or $s$-surfaces is found by  
    12481219applying \eqref{Eq_PE_lap_vector} to the horizontal velocity vector (see Appendix~\ref{Apdx_B}): 
    12491220\begin{equation} \label{Eq_PE_lapU} 
     
    12791250of the Equator in a geographical coordinate system \citep{Lengaigne_al_JGR03}. 
    12801251 
    1281 \subsubsection{lateral fourth order momentum diffusive operator} 
     1252\subsubsection{lateral bilaplacian momentum diffusive operator} 
    12821253 
    12831254As for tracers, the fourth order momentum diffusive operator along $z$ or $s$-surfaces  
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Chapters/Chap_Model_Basics_zstar.tex

    r4147 r6436  
    11% ================================================================ 
    2 % Chapter 1 Model Basics 
     2% Chapter 1 ——— Model Basics 
    33% ================================================================ 
    44% ================================================================ 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Chapters/Chap_SBC.tex

    r5120 r6436  
    11% ================================================================ 
    2 % Chapter Surface Boundary Condition (SBC, ISF, ICB)  
     2% Chapter —— Surface Boundary Condition (SBC, ISF, ICB)  
    33% ================================================================ 
    44\chapter{Surface Boundary Condition (SBC, ISF, ICB) } 
     
    1717   \item the two components of the surface ocean stress $\left( {\tau _u \;,\;\tau _v} \right)$ 
    1818   \item the incoming solar and non solar heat fluxes $\left( {Q_{ns} \;,\;Q_{sr} } \right)$ 
    19    \item the surface freshwater budget $\left( {\textit{emp},\;\textit{emp}_S } \right)$ 
     19   \item the surface freshwater budget $\left( {\textit{emp}} \right)$ 
     20   \item the surface salt flux associated with freezing/melting of seawater $\left( {\textit{sfx}} \right)$ 
    2021\end{itemize} 
    2122plus an optional field: 
     
    2728are controlled by namelist \ngn{namsbc} variables: an analytical formulation (\np{ln\_ana}~=~true),  
    2829a flux formulation (\np{ln\_flx}~=~true), a bulk formulae formulation (CORE  
    29 (\np{ln\_core}~=~true), CLIO (\np{ln\_clio}~=~true) or MFS 
     30(\np{ln\_blk\_core}~=~true), CLIO (\np{ln\_blk\_clio}~=~true) or MFS 
    3031\footnote { Note that MFS bulk formulae compute fluxes only for the ocean component} 
    31 (\np{ln\_mfs}~=~true) bulk formulae) and a coupled  
    32 formulation (exchanges with a atmospheric model via the OASIS coupler)  
    33 (\np{ln\_cpl}~=~true). When used, the atmospheric pressure forces both  
    34 ocean and ice dynamics (\np{ln\_apr\_dyn}~=~true). 
    35 The frequency at which the six or seven fields have to be updated is the \np{nn\_fsbc}  
    36 namelist parameter.  
     32(\np{ln\_blk\_mfs}~=~true) bulk formulae) and a coupled or mixed forced/coupled formulation  
     33(exchanges with a atmospheric model via the OASIS coupler) (\np{ln\_cpl} or \np{ln\_mixcpl}~=~true).  
     34When used ($i.e.$ \np{ln\_apr\_dyn}~=~true), the atmospheric pressure forces both ocean and ice dynamics. 
     35 
     36The frequency at which the forcing fields have to be updated is given by the \np{nn\_fsbc} namelist parameter.  
    3737When the fields are supplied from data files (flux and bulk formulations), the input fields  
    38 need not be supplied on the model grid.  Instead a file of coordinates and weights can  
     38need not be supplied on the model grid. Instead a file of coordinates and weights can  
    3939be supplied which maps the data from the supplied grid to the model points  
    4040(so called "Interpolation on the Fly", see \S\ref{SBC_iof}). 
     
    4242can be masked to avoid spurious results in proximity of the coasts  as large sea-land gradients characterize 
    4343most of the atmospheric variables. 
     44 
    4445In addition, the resulting fields can be further modified using several namelist options.  
    45 These options control  the rotation of vector components supplied relative to an east-north  
    46 coordinate system onto the local grid directions in the model; the addition of a surface  
    47 restoring term to observed SST and/or SSS (\np{ln\_ssr}~=~true); the modification of fluxes  
    48 below ice-covered areas (using observed ice-cover or a sea-ice model)  
    49 (\np{nn\_ice}~=~0,1, 2 or 3); the addition of river runoffs as surface freshwater  
    50 fluxes or lateral inflow (\np{ln\_rnf}~=~true); the addition of isf melting as lateral inflow (parameterisation)  
    51 (\np{nn\_isf}~=~2 or 3 and \np{ln\_isfcav}~=~false) or as surface flux at the land-ice ocean interface 
    52 (\np{nn\_isf}~=~1 or 4 and \np{ln\_isfcav}~=~true);  
    53 the addition of a freshwater flux adjustment in order to avoid a mean sea-level drift (\np{nn\_fwb}~=~0,~1~or~2); the  
    54 transformation of the solar radiation (if provided as daily mean) into a diurnal  
    55 cycle (\np{ln\_dm2dc}~=~true); and a neutral drag coefficient can be read from an external wave  
    56 model (\np{ln\_cdgw}~=~true). The latter option is possible only in case core or mfs bulk formulas are selected. 
     46These options control  
     47\begin{itemize} 
     48\item the rotation of vector components supplied relative to an east-north  
     49coordinate system onto the local grid directions in the model ;  
     50\item the addition of a surface restoring term to observed SST and/or SSS (\np{ln\_ssr}~=~true) ;  
     51\item the modification of fluxes below ice-covered areas (using observed ice-cover or a sea-ice model) (\np{nn\_ice}~=~0,1, 2 or 3) ;  
     52\item the addition of river runoffs as surface freshwater fluxes or lateral inflow (\np{ln\_rnf}~=~true) ;  
     53\item the addition of isf melting as lateral inflow (parameterisation) (\np{nn\_isf}~=~2 or 3 and \np{ln\_isfcav}~=~false)  
     54or as fluxes applied at the land-ice ocean interface (\np{nn\_isf}~=~1 or 4 and \np{ln\_isfcav}~=~true) ;  
     55\item the addition of a freshwater flux adjustment in order to avoid a mean sea-level drift (\np{nn\_fwb}~=~0,~1~or~2) ;  
     56\item the transformation of the solar radiation (if provided as daily mean) into a diurnal cycle (\np{ln\_dm2dc}~=~true) ;  
     57and a neutral drag coefficient can be read from an external wave model (\np{ln\_cdgw}~=~true).  
     58\end{itemize} 
     59The latter option is possible only in case core or mfs bulk formulas are selected. 
    5760 
    5861In this chapter, we first discuss where the surface boundary condition appears in the 
     
    7376 
    7477The surface ocean stress is the stress exerted by the wind and the sea-ice  
    75 on the ocean. The two components of stress are assumed to be interpolated  
    76 onto the ocean mesh, $i.e.$ resolved onto the model (\textbf{i},\textbf{j}) direction  
    77 at $u$- and $v$-points They are applied as a surface boundary condition of the  
    78 computation of the momentum vertical mixing trend (\mdl{dynzdf} module) : 
    79 \begin{equation} \label{Eq_sbc_dynzdf} 
    80 \left.{\left( {\frac{A^{vm} }{e_3 }\ \frac{\partial \textbf{U}_h}{\partial k}} \right)} \right|_{z=1} 
    81     = \frac{1}{\rho _o} \binom{\tau _u}{\tau _v } 
    82 \end{equation} 
    83 where $(\tau _u ,\;\tau _v )=(utau,vtau)$ are the two components of the wind  
    84 stress vector in the $(\textbf{i},\textbf{j})$ coordinate system. 
     78on the ocean. It is applied in \mdl{dynzdf} module as a surface boundary condition of the  
     79computation of the momentum vertical mixing trend (see \eqref{Eq_dynzdf_sbc} in \S\ref{DYN_zdf}). 
     80As such, it has to be provided as a 2D vector interpolated  
     81onto the horizontal velocity ocean mesh, $i.e.$ resolved onto the model  
     82(\textbf{i},\textbf{j}) direction at $u$- and $v$-points. 
    8583 
    8684The surface heat flux is decomposed into two parts, a non solar and a solar heat  
    8785flux, $Q_{ns}$ and $Q_{sr}$, respectively. The former is the non penetrative part  
    88 of the heat flux ($i.e.$ the sum of sensible, latent and long wave heat fluxes).  
    89 It is applied as a surface boundary condition trend of the first level temperature  
    90 time evolution equation (\mdl{trasbc} module).  
    91 \begin{equation} \label{Eq_sbc_trasbc_q} 
    92 \frac{\partial T}{\partial t}\equiv \cdots \;+\;\left. {\frac{Q_{ns} }{\rho  
    93 _o \;C_p \;e_{3t} }} \right|_{k=1} \quad 
    94 \end{equation} 
    95 $Q_{sr}$ is the penetrative part of the heat flux. It is applied as a 3D  
    96 trends of the temperature equation (\mdl{traqsr} module) when \np{ln\_traqsr}=True. 
    97  
    98 \begin{equation} \label{Eq_sbc_traqsr} 
    99 \frac{\partial T}{\partial t}\equiv \cdots \;+\frac{Q_{sr} }{\rho_o C_p \,e_{3t} }\delta _k \left[ {I_w } \right] 
    100 \end{equation} 
    101 where $I_w$ is a non-dimensional function that describes the way the light  
    102 penetrates inside the water column. It is generally a sum of decreasing  
    103 exponentials (see \S\ref{TRA_qsr}). 
    104  
    105 The surface freshwater budget is provided by fields: \textit{emp} and $\textit{emp}_S$ which  
    106 may or may not be identical. Indeed, a surface freshwater flux has two effects:  
    107 it changes the volume of the ocean and it changes the surface concentration of  
    108 salt (and other tracers). Therefore it appears in the sea surface height as a volume  
    109 flux, \textit{emp} (\textit{dynspg\_xxx} modules), and in the salinity time evolution equations  
    110 as a concentration/dilution effect,  
    111 $\textit{emp}_{S}$ (\mdl{trasbc} module).  
    112 \begin{equation} \label{Eq_trasbc_emp} 
    113 \begin{aligned} 
    114 &\frac{\partial \eta }{\partial t}\equiv \cdots \;+\;\textit{emp}\quad  \\  
    115 \\ 
    116  &\frac{\partial S}{\partial t}\equiv \cdots \;+\left. {\frac{\textit{emp}_S \;S}{e_{3t} }} \right|_{k=1} \\  
    117  \end{aligned} 
    118 \end{equation}  
    119  
    120 In the real ocean, $\textit{emp}=\textit{emp}_S$ and the ocean salt content is conserved,  
    121 but it exist several numerical reasons why this equality should be broken.  
    122 For example, when the ocean is coupled to a sea-ice model, the water exchanged between  
    123 ice and ocean is slightly salty (mean sea-ice salinity is $\sim $\textit{4 psu}). In this case,  
    124 $\textit{emp}_{S}$ take into account both concentration/dilution effect associated with  
    125 freezing/melting and the salt flux between ice and ocean, while \textit{emp} is  
    126 only the volume flux. In addition, in the current version of \NEMO, the sea-ice is  
    127 assumed to be above the ocean (the so-called levitating sea-ice). Freezing/melting does  
    128 not change the ocean volume (no impact on \textit{emp}) but it modifies the SSS. 
    129 %gm  \colorbox{yellow}{(see {\S} on LIM sea-ice model)}. 
    130  
    131 Note that SST can also be modified by a freshwater flux. Precipitation (in  
    132 particular solid precipitation) may have a temperature significantly different from  
    133 the SST. Due to the lack of information about the temperature of  
    134 precipitation, we assume it is equal to the SST. Therefore, no  
    135 concentration/dilution term appears in the temperature equation. It has to  
    136 be emphasised that this absence does not mean that there is no heat flux  
    137 associated with precipitation! Precipitation can change the ocean volume and thus the 
    138 ocean heat content. It is therefore associated with a heat flux (not yet   
    139 diagnosed in the model) \citep{Roullet_Madec_JGR00}). 
     86of the heat flux ($i.e.$ the sum of sensible, latent and long wave heat fluxes  
     87plus the heat content of the mass exchange with the atmosphere and sea-ice).  
     88It is applied in \mdl{trasbc} module as a surface boundary condition trend of  
     89the first level temperature time evolution equation (see \eqref{Eq_tra_sbc}  
     90and \eqref{Eq_tra_sbc_lin} in \S\ref{TRA_sbc}).  
     91The latter is the penetrative part of the heat flux. It is applied as a 3D  
     92trends of the temperature equation (\mdl{traqsr} module) when \np{ln\_traqsr}=\textit{true}. 
     93The way the light penetrates inside the water column is generally a sum of decreasing  
     94exponentials (see \S\ref{TRA_qsr}).  
     95 
     96The surface freshwater budget is provided by the \textit{emp} field. 
     97It represents the mass flux exchanged with the atmosphere (evaporation minus precipitation)  
     98and possibly with the sea-ice and ice shelves (freezing minus melting of ice).  
     99It affects both the ocean in two different ways:  
     100$(i)$   it changes the volume of the ocean and therefore appears in the sea surface height  
     101equation as a volume flux, and  
     102$(ii)$  it changes the surface temperature and salinity through the heat and salt contents  
     103of the mass exchanged with the atmosphere, the sea-ice and the ice shelves.  
     104 
    140105 
    141106%\colorbox{yellow}{Miss: } 
     
    152117%Sbcmod manage the ``providing'' (fourniture) to the ocean the 7 fields 
    153118% 
    154 %Fluxes update only each nf{\_}sbc time step (namsbc) explain relation  
    155 %between nf{\_}sbc and nf{\_}ice, do we define nf{\_}blk??? ? only one  
    156 %nf{\_}sbc 
     119%Fluxes update only each nn{\_}fsbc time step (namsbc) explain relation  
     120%between nn{\_}fsbc and nf{\_}ice, do we define nf{\_}blk??? ? only one  
     121%nn{\_}fsbc 
    157122% 
    158123%Explain here all the namlist namsbc variable{\ldots}. 
     124%  
     125% explain : use or not of surface currents 
    159126% 
    160127%\colorbox{yellow}{End Miss } 
    161128 
    162 The ocean model provides the surface currents, temperature and salinity  
    163 averaged over \np{nf\_sbc} time-step (\ref{Tab_ssm}).The computation of the  
    164 mean is done in \mdl{sbcmod} module. 
     129The ocean model provides, at each time step, to the surface module (\mdl{sbcmod})  
     130the surface currents, temperature and salinity.   
     131These variables are averaged over \np{nn\_fsbc} time-step (\ref{Tab_ssm}),  
     132and it is these averaged fields which are used to computes the surface fluxes  
     133at a frequency of \np{nn\_fsbc} time-step. 
     134 
    165135 
    166136%-------------------------------------------------TABLE--------------------------------------------------- 
     
    175145\caption{  \label{Tab_ssm}    
    176146Ocean variables provided by the ocean to the surface module (SBC).  
    177 The variable are averaged over nf{\_}sbc time step, $i.e.$ the frequency of  
     147The variable are averaged over nn{\_}fsbc time step, $i.e.$ the frequency of  
    178148computation of surface fluxes.} 
    179149\end{center}   \end{table} 
     
    459429%-------------------------------------------------------------------------------------------------------------- 
    460430 
    461 In some circumstances it may be useful to avoid calculating the 3D temperature, salinity and velocity fields and simply read them in from  a previous run.   
    462 Options are defined through the  \ngn{namsbc\_sas} namelist variables. 
     431In some circumstances it may be useful to avoid calculating the 3D temperature, salinity and velocity fields  
     432and simply read them in from a previous run or receive them from OASIS.   
    463433For example: 
    464434 
    465 \begin{enumerate} 
    466 \item  Multiple runs of the model are required in code development to see the affect of different algorithms in 
     435\begin{itemize} 
     436\item  Multiple runs of the model are required in code development to see the effect of different algorithms in 
    467437       the bulk formulae. 
    468438\item  The effect of different parameter sets in the ice model is to be examined. 
    469 \end{enumerate} 
     439\item  Development of sea-ice algorithms or parameterizations. 
     440\item  spinup of the iceberg floats 
     441\item  ocean/sea-ice simulation with both media running in parallel (\np{ln\_mixcpl}~=~\textit{true}) 
     442\end{itemize} 
    470443 
    471444The StandAlone Surface scheme provides this utility. 
     445Its options are defined through the \ngn{namsbc\_sas} namelist variables. 
    472446A new copy of the model has to be compiled with a configuration based on ORCA2\_SAS\_LIM. 
    473447However no namelist parameters need be changed from the settings of the previous run (except perhaps nn{\_}date0) 
     
    475449Routines replaced are: 
    476450 
    477 \begin{enumerate} 
    478 \item  \mdl{nemogcm} 
    479  
    480        This routine initialises the rest of the model and repeatedly calls the stp time stepping routine (step.F90) 
     451\begin{itemize} 
     452\item \mdl{nemogcm} : This routine initialises the rest of the model and repeatedly calls the stp time stepping routine (step.F90) 
    481453       Since the ocean state is not calculated all associated initialisations have been removed. 
    482 \item  \mdl{step} 
    483  
    484        The main time stepping routine now only needs to call the sbc routine (and a few utility functions). 
    485 \item  \mdl{sbcmod} 
    486  
    487        This has been cut down and now only calculates surface forcing and the ice model required.  New surface modules 
     454\item  \mdl{step} : The main time stepping routine now only needs to call the sbc routine (and a few utility functions). 
     455\item  \mdl{sbcmod} : This has been cut down and now only calculates surface forcing and the ice model required.  New surface modules 
    488456       that can function when only the surface level of the ocean state is defined can also be added (e.g. icebergs). 
    489 \item  \mdl{daymod} 
    490  
    491        No ocean restarts are read or written (though the ice model restarts are retained), so calls to restart functions 
     457\item  \mdl{daymod} : No ocean restarts are read or written (though the ice model restarts are retained), so calls to restart functions 
    492458       have been removed.  This also means that the calendar cannot be controlled by time in a restart file, so the user 
    493459       must make sure that nn{\_}date0 in the model namelist is correct for his or her purposes. 
    494 \item  \mdl{stpctl} 
    495  
    496        Since there is no free surface solver, references to it have been removed from \rou{stp\_ctl} module. 
    497 \item  \mdl{diawri} 
    498  
    499        All 3D data have been removed from the output.  The surface temperature, salinity and velocity components (which 
     460\item  \mdl{stpctl} : Since there is no free surface solver, references to it have been removed from \rou{stp\_ctl} module. 
     461\item  \mdl{diawri} : All 3D data have been removed from the output.  The surface temperature, salinity and velocity components (which 
    500462       have been read in) are written along with relevant forcing and ice data. 
    501 \end{enumerate} 
     463\end{itemize} 
    502464 
    503465One new routine has been added: 
    504466 
    505 \begin{enumerate} 
    506 \item  \mdl{sbcsas} 
    507        This module initialises the input files needed for reading temperature, salinity and velocity arrays at the surface. 
     467\begin{itemize} 
     468\item  \mdl{sbcsas} : This module initialises the input files needed for reading temperature, salinity and velocity arrays at the surface. 
    508469       These filenames are supplied in namelist namsbc{\_}sas.  Unfortunately because of limitations with the \mdl{iom} module, 
    509470       the full 3D fields from the mean files have to be read in and interpolated in time, before using just the top level. 
    510471       Since fldread is used to read in the data, Interpolation on the Fly may be used to change input data resolution. 
    511 \end{enumerate} 
     472\end{itemize} 
     473 
     474 
     475% Missing the description of the 2 following variables: 
     476%   ln_3d_uve   = .true.    !  specify whether we are supplying a 3D u,v and e3 field 
     477%   ln_read_frq = .false.    !  specify whether we must read frq or not 
     478 
     479 
    512480 
    513481% ================================================================ 
     
    590558reanalysis and satellite data. They use an inertial dissipative method to compute  
    591559the turbulent transfer coefficients (momentum, sensible heat and evaporation)  
    592 from the 10 metre wind speed, air temperature and specific humidity. 
     560from the 10 meters wind speed, air temperature and specific humidity. 
    593561This \citet{Large_Yeager_Rep04} dataset is available through the  
    594562\href{http://nomads.gfdl.noaa.gov/nomads/forms/mom4/CORE.html}{GFDL web site}.  
     
    625593or larger than the one of the input atmospheric fields. 
    626594 
     595The  \np{sn\_wndi}, \np{sn\_wndj}, \np{sn\_qsr}, \np{sn\_qlw}, \np{sn\_tair},\np{sn\_humi},\np{sn\_prec}, \np{sn\_snow}, \np{sn\_tdif} parameters describe the fields and the way they have to be used (spatial and temporal interpolations).  
     596 
     597\np{cn\_dir} is the directory of location of bulk files 
     598\np{ln\_taudif} is the flag to specify if we use Hight Frequency (HF) tau information (.true.) or not (.false.) 
     599\np{rn\_zqt}: is the height of humidity and temperature measurements (m) 
     600\np{rn\_zu}: is the height of wind measurements (m) 
     601The multiplicative factors to activate (value is 1) or deactivate (value is 0) :  
     602\np{rn\_pfac} for precipitations (total and snow) 
     603\np{rn\_efac} for evaporation  
     604\np{rn\_vfac} for for ice/ocean velocities in the calculation of wind stress   
     605 
    627606% ------------------------------------------------------------------------------------------------------------- 
    628607%        CLIO Bulk formulea 
     
    720699are sent to the atmospheric component. 
    721700 
    722 A generalised coupled interface has been developed. It is currently interfaced with OASIS 3 
    723 (\key{oasis3}) and does not support OASIS 4 
    724 \footnote{The \key{oasis4} exist. It activates portion of the code that are still under development.}.  
     701A generalised coupled interface has been developed.  
     702It is currently interfaced with OASIS-3-MCT (\key{oasis3}).  
    725703It has been successfully used to interface \NEMO to most of the European atmospheric  
    726704GCM (ARPEGE, ECHAM, ECMWF, HadAM, HadGAM, LMDz),  
     
    787765\label{SBC_tide} 
    788766 
    789 A module is available to use the tidal potential forcing and is activated with with \key{tide}. 
    790  
    791  
    792 %------------------------------------------nam_tide---------------------------------------------------- 
     767%------------------------------------------nam_tide--------------------------------------- 
    793768\namdisplay{nam_tide} 
    794 %------------------------------------------------------------------------------------------------------------- 
    795  
    796 Concerning the tidal potential, some parameters are available in namelist \ngn{nam\_tide}: 
     769%----------------------------------------------------------------------------------------- 
     770 
     771A module is available to compute the tidal potential and use it in the momentum equation. 
     772This option is activated when \key{tide} is defined. 
     773 
     774Some parameters are available in namelist \ngn{nam\_tide}: 
    797775 
    798776- \np{ln\_tide\_pot} activate the tidal potential forcing 
     
    801779 
    802780- \np{clname} is the name of constituent 
    803  
    804781 
    805782The tide is generated by the forces of gravity ot the Earth-Moon and Earth-Sun sytem; 
     
    895872lowest box the river water is being added to (i.e. the total depth that river water is being added to in the model). 
    896873 
     874%Christian: 
     875If the depth information is not provide in the NetCDF file, it can be estimate from the runoff input file at the initial time-step, by setting the namelist parameter \np{ln\_rnf\_depth\_ini} to true. 
     876 
     877This estimation is a simple linear relation between the runoff and a given depth :  
     878\begin{equation}  
     879h\_dep  = \frac{rn\_dep\_max} {rn\_rnf\_max}  rnf 
     880\end{equation} 
     881where  \np{rn\_dep\_max} is the given maximum depth over which the runoffs is spread,  
     882 \np{rn\_rnf\_max} is the maximum value of the runoff climatologie over the global domain 
     883and rnf is the maximum value in time of the runoff climatology at each grid cell (computed online). 
     884 
     885The estimated depth array can be output if needed in a NetCDF file by setting the namelist parameter \np{nn\_rnf\_depth\_file} to 1. 
     886 
    897887The mass/volume addition due to the river runoff is, at each relevant depth level, added to the horizontal divergence  
    898888(\textit{hdivn}) in the subroutine \rou{sbc\_rnf\_div} (called from \mdl{divcur}). 
     
    958948\namdisplay{namsbc_isf} 
    959949%-------------------------------------------------------------------------------------------------------- 
    960 Namelist variable in \ngn{namsbc}, \np{nn\_isf},  control the kind of ice shelf representation used.  
     950Namelist variable in \ngn{namsbc}, \np{nn\_isf}, controls the ice shelf representation used (Fig. \ref{Fig_SBC_isf}):  
     951 
     952%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
     953\begin{figure}[!h]    \begin{center} 
     954\includegraphics[width=0.8\textwidth]{./TexFiles/Figures/Fig_SBC_isf.pdf} 
     955\caption{ \label{Fig_SBC_isf} 
     956Schematic for all the options available trough \np{nn\_isf}.} 
     957\end{center}   \end{figure} 
     958%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
     959 
    961960\begin{description} 
     961\item[\np{nn\_isf}~=~0] 
     962The ice shelf routines are not used. The ice shelf melting is not computed or prescribed, the cavity have to be closed.  
     963If needed, the ice shelf melting should be added to the runoff or the precipitation file. 
     964 
    962965\item[\np{nn\_isf}~=~1] 
    963 The ice shelf cavity is represented. The fwf and heat flux are computed.  
    964 Full description, sensitivity and validation in preparation.  
     966The ice shelf cavity is represented. The fwf and heat flux are computed. Two different bulk formula are available: 
     967   \begin{description} 
     968   \item[\np{nn\_isfblk}~=~1] 
     969   The bulk formula used to compute the melt is based the one described in \citet{Hunter2006}. 
     970        This formulation is based on a balance between the upward ocean heat flux and the latent heat flux at the ice shelf base. 
     971 
     972   \item[\np{nn\_isfblk}~=~2]  
     973   The bulk formula used to compute the melt is based the one described in \citet{Jenkins1991}. 
     974        This formulation is based on a 3 equations formulation (a heat flux budget, a salt flux budget and a linearised freezing point temperature equation). 
     975   \end{description} 
     976 
     977For this 2 bulk formulations, there are 3 different ways to compute the exchange coeficient: 
     978   \begin{description} 
     979        \item[\np{nn\_gammablk~=~0~}] 
     980   The salt and heat exchange coefficients are constant and defined by \np{rn\_gammas0} and \np{rn\_gammat0} 
     981 
     982   \item[\np{nn\_gammablk~=~1~}] 
     983   The salt and heat exchange coefficients are velocity dependent and defined as $\np{rn\_gammas0} \times u_{*}$ and $\np{rn\_gammat0} \times u_{*}$ 
     984        where $u_{*}$ is the friction velocity in the top boundary layer (ie first \np{rn\_hisf\_tbl} meters). 
     985        See \citet{Jenkins2010} for all the details on this formulation. 
     986    
     987   \item[\np{nn\_gammablk~=~2~}] 
     988   The salt and heat exchange coefficients are velocity and stability dependent and defined as  
     989        $\gamma_{T,S} = \frac{u_{*}}{\Gamma_{Turb} + \Gamma^{T,S}_{Mole}}$ 
     990        where $u_{*}$ is the friction velocity in the top boundary layer (ie first \np{rn\_hisf\_tbl} meters),  
     991        $\Gamma_{Turb}$ the contribution of the ocean stability and  
     992        $\Gamma^{T,S}_{Mole}$ the contribution of the molecular diffusion. 
     993        See \citet{Holland1999} for all the details on this formulation. 
     994        \end{description} 
    965995 
    966996\item[\np{nn\_isf}~=~2] 
     
    968998The fwf is distributed along the ice shelf edge between the depth of the average grounding line (GL) 
    969999(\np{sn\_depmax\_isf}) and the base of the ice shelf along the calving front (\np{sn\_depmin\_isf}) as in (\np{nn\_isf}~=~3).  
    970 Furthermore the fwf is computed using the \citet{Beckmann2003} parameterisation of isf melting.  
     1000Furthermore the fwf and heat flux are computed using the \citet{Beckmann2003} parameterisation of isf melting.  
    9711001The effective melting length (\np{sn\_Leff\_isf}) is read from a file. 
    9721002 
    9731003\item[\np{nn\_isf}~=~3] 
    9741004A simple parameterisation of isf is used. The ice shelf cavity is not represented.  
    975 The fwf (\np{sn\_rnfisf}) is distributed along the ice shelf edge between the depth of the average grounding line (GL) 
    976 (\np{sn\_depmax\_isf}) and the base of the ice shelf along the calving front (\np{sn\_depmin\_isf}). 
    977 Full description, sensitivity and validation in preparation. 
     1005The fwf (\np{sn\_rnfisf}) is prescribed and distributed along the ice shelf edge between the depth of the average grounding line (GL) 
     1006(\np{sn\_depmax\_isf}) and the base of the ice shelf along the calving front (\np{sn\_depmin\_isf}).  
     1007The heat flux ($Q_h$) is computed as $Q_h = fwf \times L_f$. 
    9781008 
    9791009\item[\np{nn\_isf}~=~4] 
    980 The ice shelf cavity is represented. However, the fwf (\np{sn\_fwfisf}) and heat flux (\np{sn\_qisf}) are  
    981 not computed but specified from file.  
     1010The ice shelf cavity is opened. However, the fwf is not computed but specified from file \np{sn\_fwfisf}).  
     1011The heat flux ($Q_h$) is computed as $Q_h = fwf \times L_f$.\\ 
    9821012\end{description} 
    9831013 
    984 \np{nn\_isf}~=~1 and \np{nn\_isf}~=~2 compute a melt rate based on the water masse properties, ocean velocities and depth. 
    985  This flux is thus highly dependent of the model resolution (horizontal and vertical), realism of the water masse onto the shelf ... 
    986  
    987 \np{nn\_isf}~=~3 and \np{nn\_isf}~=~4 read the melt rate and heat flux from a file. You have total control of the fwf scenario. 
    988  
    989  This can be usefull if the water masses on the shelf are not realistic or the resolution (horizontal/vertical) are too  
    990 coarse to have realistic melting or for sensitivity studies where you want to control your input.  
    991 Full description, sensitivity and validation in preparation.  
    992  
    993 There is 2 ways to apply the fwf to NEMO. The first possibility (\np{ln\_divisf}~=~false) applied the fwf 
    994  and heat flux directly on the salinity and temperature tendancy. The second possibility (\np{ln\_divisf}~=~true) 
    995  apply the fwf as for the runoff fwf (see \S\ref{SBC_rnf}). The mass/volume addition due to the ice shelf melting is, 
    996  at each relevant depth level, added to the horizontal divergence (\textit{hdivn}) in the subroutine \rou{sbc\_isf\_div}  
    997 (called from \mdl{divcur}).  
     1014 
     1015$\bullet$ \np{nn\_isf}~=~1 and \np{nn\_isf}~=~2 compute a melt rate based on the water mass properties, ocean velocities and depth. 
     1016 This flux is thus highly dependent of the model resolution (horizontal and vertical), realism of the water masses onto the shelf ...\\ 
     1017 
     1018$\bullet$ \np{nn\_isf}~=~3 and \np{nn\_isf}~=~4 read the melt rate from a file. You have total control of the fwf forcing. 
     1019This can be usefull if the water masses on the shelf are not realistic or the resolution (horizontal/vertical) are too  
     1020coarse to have realistic melting or for studies where you need to control your heat and fw input.\\  
     1021 
     1022Two namelist parameters control how the heat and fw fluxes are passed to NEMO: \np{rn\_hisf\_tbl} and \np{ln\_divisf} 
     1023\begin{description} 
     1024\item[\np{rn\_hisf\_tbl}] is the top boundary layer thickness as defined in \citet{Losch2008}.  
     1025This parameter is only used if \np{nn\_isf}~=~1 or \np{nn\_isf}~=~4 
     1026It allows you to control over which depth you want to spread the heat and fw fluxes.  
     1027 
     1028If \np{rn\_hisf\_tbl} = 0.0, the fluxes are put in the top level whatever is its tickness.  
     1029 
     1030If \np{rn\_hisf\_tbl} $>$ 0.0, the fluxes are spread over the first \np{rn\_hisf\_tbl} m (ie over one or several cells). 
     1031 
     1032\item[\np{ln\_divisf}] is a flag to apply the fw flux as a volume flux or as a salt flux.  
     1033 
     1034\np{ln\_divisf}~=~true applies the fwf as a volume flux. This volume flux is implemented with in the same way as for the runoff. 
     1035The fw addition due to the ice shelf melting is, at each relevant depth level, added to the horizontal divergence  
     1036(\textit{hdivn}) in the subroutine \rou{sbc\_isf\_div}, called from \mdl{divcur}.  
     1037See the runoff section \ref{SBC_rnf} for all the details about the divergence correction.  
     1038 
     1039\np{ln\_divisf}~=~false applies the fwf and heat flux directly on the salinity and temperature tendancy. 
     1040 
     1041\item[\np{ln\_conserve}] is a flag for \np{nn\_isf}~=~1. A conservative boundary layer scheme as described in \citet{Jenkins2001}  
     1042is used if \np{ln\_conserve}=true. It takes into account the fact that the melt water is at freezing T and needs to be warm up to ocean temperature.  
     1043It is only relevant for \np{ln\_divisf}~=~false.  
     1044If \np{ln\_divisf}~=~true, \np{ln\_conserve} has to be set to false to avoid a double counting of the contribution.  
     1045  
     1046\end{description} 
    9981047% 
    9991048% ================================================================ 
    10001049%        Handling of icebergs 
    10011050% ================================================================ 
    1002 \section{ Handling of icebergs (ICB) } 
     1051\section{Handling of icebergs (ICB)} 
    10031052\label{ICB_icebergs} 
    10041053%------------------------------------------namberg---------------------------------------------------- 
     
    10061055%------------------------------------------------------------------------------------------------------------- 
    10071056 
    1008 Icebergs are modelled as lagrangian particles in NEMO. 
    1009 Their physical behaviour is controlled by equations as described in  \citet{Martin_Adcroft_OM10} ). 
    1010 (Note that the authors kindly provided a copy of their code to act as a basis for implementation in NEMO.) 
    1011 Icebergs are initially spawned into one of ten classes which have specific mass and thickness as described in the \ngn{namberg} namelist:  
     1057Icebergs are modelled as lagrangian particles in NEMO \citep{Marsh_GMD2015}. 
     1058Their physical behaviour is controlled by equations as described in \citet{Martin_Adcroft_OM10} ). 
     1059(Note that the authors kindly provided a copy of their code to act as a basis for implementation in NEMO). 
     1060Icebergs are initially spawned into one of ten classes which have specific mass and thickness as described  
     1061in the \ngn{namberg} namelist:  
    10121062\np{rn\_initial\_mass} and \np{rn\_initial\_thickness}. 
    10131063Each class has an associated scaling (\np{rn\_mass\_scaling}), which is an integer representing how many icebergs  
     
    11931243The presence at the sea surface of an ice covered area modifies all the fluxes  
    11941244transmitted to the ocean. There are several way to handle sea-ice in the system  
    1195 depending on the value of the \np{nn{\_}ice} namelist parameter 
     1245depending on the value of the \np{nn\_ice} namelist parameter found in \ngn{namsbc} namelist 
    11961246\begin{description} 
    11971247\item[nn{\_}ice = 0]  there will never be sea-ice in the computational domain.  
     
    12681318% ------------------------------------------------------------------------------------------------------------- 
    12691319\subsection   [Neutral drag coefficient from external wave model (\textit{sbcwave})] 
    1270                         {Neutral drag coefficient from external wave model (\mdl{sbcwave})} 
     1320              {Neutral drag coefficient from external wave model (\mdl{sbcwave})} 
    12711321\label{SBC_wave} 
    12721322%------------------------------------------namwave---------------------------------------------------- 
    12731323\namdisplay{namsbc_wave} 
    12741324%------------------------------------------------------------------------------------------------------------- 
    1275 \begin{description} 
    1276  
    1277 \item [??] In order to read a neutral drag coeff, from an external data source (i.e. a wave model), the  
    1278 logical variable \np{ln\_cdgw} 
    1279  in $namsbc$ namelist must be defined ${.true.}$.  
     1325 
     1326In order to read a neutral drag coeff, from an external data source ($i.e.$ a wave model), the  
     1327logical variable \np{ln\_cdgw} in \ngn{namsbc} namelist must be set to \textit{true}.  
    12801328The \mdl{sbcwave} module containing the routine \np{sbc\_wave} reads the 
    12811329namelist \ngn{namsbc\_wave} (for external data names, locations, frequency, interpolation and all  
    12821330the miscellanous options allowed by Input Data generic Interface see \S\ref{SBC_input})  
    1283 and a 2D field of neutral drag coefficient. Then using the routine  
    1284 TURB\_CORE\_1Z or TURB\_CORE\_2Z, and starting from the neutral drag coefficent provided, the drag coefficient is computed according  
    1285 to stable/unstable conditions of the air-sea interface following \citet{Large_Yeager_Rep04}. 
    1286  
    1287 \end{description} 
     1331and a 2D field of neutral drag coefficient.  
     1332Then using the routine TURB\_CORE\_1Z or TURB\_CORE\_2Z, and starting from the neutral drag coefficent provided,  
     1333the drag coefficient is computed according to stable/unstable conditions of the air-sea interface following \citet{Large_Yeager_Rep04}. 
     1334 
    12881335 
    12891336% Griffies doc: 
    1290 % When running ocean-ice simulations, we are not explicitly representing land processes, such as rivers, catchment areas, snow accumulation, etc. However, to reduce model drift, it is important to balance the hydrological cycle in ocean-ice models. We thus need to prescribe some form of global normalization to the precipitation minus evaporation plus river runoff. The result of the normalization should be a global integrated zero net water input to the ocean-ice system over a chosen time scale.  
    1291 %How often the normalization is done is a matter of choice. In mom4p1, we choose to do so at each model time step, so that there is always a zero net input of water to the ocean-ice system. Others choose to normalize over an annual cycle, in which case the net imbalance over an annual cycle is used to alter the subsequent year�s water budget in an attempt to damp the annual water imbalance. Note that the annual budget approach may be inappropriate with interannually varying precipitation forcing.  
    1292 %When running ocean-ice coupled models, it is incorrect to include the water transport between the ocean and ice models when aiming to balance the hydrological cycle. The reason is that it is the sum of the water in the ocean plus ice that should be balanced when running ocean-ice models, not the water in any one sub-component. As an extreme example to illustrate the issue, consider an ocean-ice model with zero initial sea ice. As the ocean-ice model spins up, there should be a net accumulation of water in the growing sea ice, and thus a net loss of water from the ocean. The total water contained in the ocean plus ice system is constant, but there is an exchange of water between the subcomponents. This exchange should not be part of the normalization used to balance the hydrological cycle in ocean-ice models.  
    1293  
    1294  
     1337% When running ocean-ice simulations, we are not explicitly representing land processes,  
     1338% such as rivers, catchment areas, snow accumulation, etc. However, to reduce model drift,  
     1339% it is important to balance the hydrological cycle in ocean-ice models.  
     1340% We thus need to prescribe some form of global normalization to the precipitation minus evaporation plus river runoff.  
     1341% The result of the normalization should be a global integrated zero net water input to the ocean-ice system over  
     1342% a chosen time scale.  
     1343%How often the normalization is done is a matter of choice. In mom4p1, we choose to do so at each model time step,  
     1344% so that there is always a zero net input of water to the ocean-ice system.  
     1345% Others choose to normalize over an annual cycle, in which case the net imbalance over an annual cycle is used  
     1346% to alter the subsequent year�s water budget in an attempt to damp the annual water imbalance.  
     1347% Note that the annual budget approach may be inappropriate with interannually varying precipitation forcing.  
     1348% When running ocean-ice coupled models, it is incorrect to include the water transport between the ocean  
     1349% and ice models when aiming to balance the hydrological cycle.  
     1350% The reason is that it is the sum of the water in the ocean plus ice that should be balanced when running ocean-ice models,  
     1351% not the water in any one sub-component. As an extreme example to illustrate the issue,  
     1352% consider an ocean-ice model with zero initial sea ice. As the ocean-ice model spins up,  
     1353% there should be a net accumulation of water in the growing sea ice, and thus a net loss of water from the ocean.  
     1354% The total water contained in the ocean plus ice system is constant, but there is an exchange of water between  
     1355% the subcomponents. This exchange should not be part of the normalization used to balance the hydrological cycle  
     1356% in ocean-ice models.  
     1357 
     1358 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Chapters/Chap_STO.tex

    r5404 r6436  
    55\label{STO} 
    66 
     7Authors: P.-A. Bouttier 
     8 
    79\minitoc 
    8  
    910 
    1011\newpage 
    1112$\ $\newline    % force a new line 
     13 
     14The stochastic parametrization module aims to explicitly simulate uncertainties in the model. More particularly, \cite{Brankart_OM2013} has shown that, because of the nonlinearity of the seawater equation of state, unresolved scales represent a major source of uncertainties in the computation of the large scale horizontal density gradient (from T/S large scale fields), and that the impact of these uncertainties can be simulated by random processes representing unresolved T/S fluctuations. 
     15 
     16The stochastic formulation of the equation of state can be written as: 
     17\begin{equation} 
     18 \label{eq:eos_sto} 
     19  \rho = \frac{1}{2} \sum_{i=1}^m\{ \rho[T+\Delta T_i,S+\Delta S_i,p_o(z)] + \rho[T-\Delta T_i,S-\Delta S_i,p_o(z)] \} 
     20\end{equation} 
     21where $p_o(z)$ is the reference pressure depending on the depth and $\Delta T_i$ and $\Delta S_i$ are a set of T/S perturbations defined as the scalar product of the respective local T/S gradients with random walks $\mathbf{\xi}$: 
     22\begin{equation} 
     23 \label{eq:sto_pert} 
     24 \Delta T_i = \mathbf{\xi}_i \cdot \nabla T \qquad \hbox{and} \qquad \Delta S_i = \mathbf{\xi}_i \cdot \nabla S 
     25\end{equation} 
     26$\mathbf{\xi}_i$ are produced by a first-order autoregressive processes (AR-1) with a parametrized decorrelation time scale, and horizontal and vertical standard deviations $\sigma_s$. $\mathbf{\xi}$ are uncorrelated over the horizontal and fully correlated along the vertical. 
     27 
     28 
     29\section{Stochastic processes} 
     30\label{STO_the_details} 
     31 
     32The starting point of our implementation of stochastic parameterizations 
     33in NEMO is to observe that many existing parameterizations are based 
     34on autoregressive processes, which are used as a basic source of randomness 
     35to transform a deterministic model into a probabilistic model. 
     36A generic approach is thus to add one single new module in NEMO, 
     37generating processes with appropriate statistics 
     38to simulate each kind of uncertainty in the model 
     39(see \cite{Brankart_al_GMD2015} for more details). 
     40 
     41In practice, at every model grid point, independent Gaussian autoregressive 
     42processes~$\xi^{(i)},\,i=1,\ldots,m$ are first generated 
     43using the same basic equation: 
     44 
     45\begin{equation} 
     46\label{eq:autoreg} 
     47\xi^{(i)}_{k+1} = a^{(i)} \xi^{(i)}_k + b^{(i)} w^{(i)} + c^{(i)} 
     48\end{equation} 
     49 
     50\noindent 
     51where $k$ is the index of the model timestep; and 
     52$a^{(i)}$, $b^{(i)}$, $c^{(i)}$ are parameters defining 
     53the mean ($\mu^{(i)}$) standard deviation ($\sigma^{(i)}$) 
     54and correlation timescale ($\tau^{(i)}$) of each process: 
     55 
     56\begin{itemize} 
     57\item for order~1 processes, $w^{(i)}$ is a Gaussian white noise, 
     58with zero mean and standard deviation equal to~1, and the parameters 
     59$a^{(i)}$, $b^{(i)}$, $c^{(i)}$ are given by: 
     60 
     61\begin{equation} 
     62\label{eq:ord1} 
     63\left\{ 
     64\begin{array}{l} 
     65a^{(i)} = \varphi \\ 
     66b^{(i)} = \sigma^{(i)} \sqrt{ 1 - \varphi^2 }  
     67 \qquad\qquad\mbox{with}\qquad\qquad 
     68\varphi = \exp \left( - 1 / \tau^{(i)} \right) \\ 
     69c^{(i)} = \mu^{(i)} \left( 1 - \varphi \right) \\ 
     70\end{array} 
     71\right. 
     72\end{equation} 
     73 
     74\item for order~$n>1$ processes, $w^{(i)}$ is an order~$n-1$ autoregressive process, 
     75with zero mean, standard deviation equal to~$\sigma^{(i)}$; correlation timescale 
     76equal to~$\tau^{(i)}$; and the parameters 
     77$a^{(i)}$, $b^{(i)}$, $c^{(i)}$ are given by: 
     78 
     79\begin{equation} 
     80\label{eq:ord2} 
     81\left\{ 
     82\begin{array}{l} 
     83a^{(i)} = \varphi \\ 
     84b^{(i)} = \frac{n-1}{2(4n-3)} \sqrt{ 1 - \varphi^2 }  
     85 \qquad\qquad\mbox{with}\qquad\qquad 
     86\varphi = \exp \left( - 1 / \tau^{(i)} \right) \\ 
     87c^{(i)} = \mu^{(i)} \left( 1 - \varphi \right) \\ 
     88\end{array} 
     89\right. 
     90\end{equation} 
     91 
     92\end{itemize} 
     93 
     94\noindent 
     95In this way, higher order processes can be easily generated recursively using the same piece of code implementing Eq.~(\ref{eq:autoreg}), and using succesively processes from order $0$ to~$n-1$ as~$w^{(i)}$. 
     96The parameters in Eq.~(\ref{eq:ord2}) are computed so that this recursive application 
     97of Eq.~(\ref{eq:autoreg}) leads to processes with the required standard deviation 
     98and correlation timescale, with the additional condition that 
     99the $n-1$ first derivatives of the autocorrelation function 
     100are equal to zero at~$t=0$, so that the resulting processes 
     101become smoother and smoother as $n$ is increased. 
     102 
     103Overall, this method provides quite a simple and generic way of generating a wide class of stochastic processes. However, this also means that new model parameters are needed to specify each of these stochastic processes. As in any parameterization of lacking physics, a very important issues then to tune these new parameters using either first principles, model simulations, or real-world observations. 
     104 
     105\section{Implementation details} 
     106\label{STO_thech_details} 
     107The computer code implementing stochastic parametrisations is made of one single FORTRAN module, 
     108with 3 public routines to be called by the model (in our case, NEMO): 
     109 
     110The first routine ({sto\_par}) is a direct implementation of Eq.~(\ref{eq:autoreg}), 
     111applied at each model grid point (in 2D or 3D), 
     112and called at each model time step ($k$) to update 
     113every autoregressive process ($i=1,\ldots,m$). 
     114This routine also includes a filtering operator, applied to $w^{(i)}$, 
     115to introduce a spatial correlation between the stochastic processes. 
     116 
     117The second routine ({sto\_par\_init}) 
     118is an initialization routine mainly dedicated 
     119to the computation of parameters $a^{(i)}, b^{(i)}, c^{(i)}$ 
     120for each autoregressive process, as a function of the statistical properties 
     121required by the model user (mean, standard deviation, time correlation, 
     122order of the process,\ldots). Parameters for the processes can be specified through the following namelist parameters: 
     123\begin{alltt} 
     124\tiny 
     125\begin{verbatim} 
     126   nn_sto_eos = 1                ! number of independent random walks  
     127   rn_eos_stdxy = 1.4            ! random walk horz. standard deviation (in grid points) 
     128   rn_eos_stdz  = 0.7            ! random walk vert. standard deviation (in grid points) 
     129   rn_eos_tcor  = 1440.0         ! random walk time correlation (in timesteps) 
     130   nn_eos_ord  = 1               ! order of autoregressive processes 
     131   nn_eos_flt  = 0               ! passes of Laplacian filter 
     132   rn_eos_lim  = 2.0             ! limitation factor (default = 3.0) 
     133\end{verbatim} 
     134\end{alltt} 
     135This routine also includes the initialization (seeding) 
     136of the random number generator. 
     137 
     138The third routine ({sto\_rst\_write}) writes a ``restart file'' 
     139with the current value of all autoregressive processes 
     140to allow restarting a simulation from where it has been interrupted. 
     141This file also contains the current state of the random number generator. 
     142In case of a restart, this file is then read by the initialization routine 
     143({sto\_par\_init}), so that the simulation can continue exactly 
     144as if it was not interrupted. 
     145Restart capabilities of the module are driven by the following namelist parameters: 
     146\begin{alltt} 
     147\tiny 
     148\begin{verbatim} 
     149   ln_rststo = .false.           ! start from mean parameter (F) or from restart file (T) 
     150   ln_rstseed = .true.           ! read seed of RNG from restart file 
     151   cn_storst_in  = "restart_sto" !  suffix of stochastic parameter restart file (input) 
     152   cn_storst_out = "restart_sto" !  suffix of stochastic parameter restart file (output) 
     153\end{verbatim} 
     154\end{alltt} 
     155 
     156In the particular case of the stochastic equation of state, there is also an additional module ({sto\_pts}) implementing Eq~\ref{eq:sto_pert} and specific piece of code in the equation of state implementing Eq~\ref{eq:eos_sto}. 
     157 
     158 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Chapters/Chap_TRA.tex

    r5102 r6436  
    11% ================================================================ 
    2 % Chapter 1 Ocean Tracers (TRA) 
     2% Chapter 1 ——— Ocean Tracers (TRA) 
    33% ================================================================ 
    44\chapter{Ocean Tracers (TRA)} 
     
    3636(BBL) parametrisation, and an internal damping (DMP) term. The terms QSR,  
    3737BBC, BBL and DMP are optional. The external forcings and parameterisations  
    38 require complex inputs and complex calculations (e.g. bulk formulae, estimation  
     38require complex inputs and complex calculations ($e.g.$ bulk formulae, estimation  
    3939of mixing coefficients) that are carried out in the SBC, LDF and ZDF modules and  
    4040described in chapters \S\ref{SBC}, \S\ref{LDF} and  \S\ref{ZDF}, respectively.  
    41 Note that \mdl{tranpc}, the non-penetrative convection module,  although  
    42 (temporarily) located in the NEMO/OPA/TRA directory, is described with the  
    43 model vertical physics (ZDF). 
    44 %%% 
    45 \gmcomment{change the position of eosbn2 in the reference code} 
    46 %%% 
     41Note that \mdl{tranpc}, the non-penetrative convection module, although  
     42located in the NEMO/OPA/TRA directory as it directly modifies the tracer fields,  
     43is described with the model vertical physics (ZDF) together with other available  
     44parameterization of convection. 
    4745 
    4846In the present chapter we also describe the diagnostic equations used to compute  
    49 the sea-water properties (density, Brunt-Vais\"{a}l\"{a} frequency, specific heat and  
     47the sea-water properties (density, Brunt-V\"{a}is\"{a}l\"{a} frequency, specific heat and  
    5048freezing point with associated modules \mdl{eosbn2} and \mdl{phycst}). 
    5149 
     
    5654found in the \textit{trattt} or \textit{trattt\_xxx} module, in the NEMO/OPA/TRA directory. 
    5755 
    58 The user has the option of extracting each tendency term on the rhs of the tracer  
    59 equation for output (\key{trdtra} is defined), as described in Chap.~\ref{MISC}. 
     56The user has the option of extracting each tendency term on the RHS of the tracer  
     57equation for output (\np{ln\_tra\_trd} or \np{ln\_tra\_mxl}~=~true), as described in Chap.~\ref{DIA}. 
    6058 
    6159$\ $\newline    % force a new ligne 
     
    125123\end{description} 
    126124In all cases, this boundary condition retains local conservation of tracer.  
    127 Global conservation is obtained in both rigid-lid and non-linear free surface  
    128 cases, but not in the linear free surface case. Nevertheless, in the latter 
    129 case, it is achieved to a good approximation since the non-conservative  
     125Global conservation is obtained in non-linear free surface case,  
     126but \textit{not} in the linear free surface case. Nevertheless, in the latter case,  
     127it is achieved to a good approximation since the non-conservative  
    130128term is the product of the time derivative of the tracer and the free surface  
    131129height, two quantities that are not correlated (see \S\ref{PE_free_surface},  
     
    133131 
    134132The velocity field that appears in (\ref{Eq_tra_adv}) and (\ref{Eq_tra_adv_zco})  
    135 is the centred (\textit{now}) \textit{eulerian} ocean velocity (see Chap.~\ref{DYN}).  
    136 When eddy induced velocity (\textit{eiv}) parameterisation is used it is the \textit{now}  
    137 \textit{effective} velocity ($i.e.$ the sum of the eulerian and eiv velocities) which is used. 
     133is the centred (\textit{now}) \textit{effective} ocean velocity, $i.e.$ the \textit{eulerian} velocity 
     134(see Chap.~\ref{DYN}) plus the eddy induced velocity (\textit{eiv})  
     135and/or the mixed layer eddy induced velocity (\textit{eiv}) 
     136when those parameterisations are used (see Chap.~\ref{LDF}). 
    138137 
    139138The choice of an advection scheme is made in the \textit{\ngn{nam\_traadv}} namelist, by  
     
    146145 
    147146Note that  
    148 (1) cen2, cen4 and TVD schemes require an explicit diffusion  
     147(1) cen2 and TVD schemes require an explicit diffusion  
    149148operator while the other schemes are diffusive enough so that they do not  
    150149require additional diffusion ;  
    151 (2) cen2, cen4, MUSCL2, and UBS are not \textit{positive} schemes 
     150(2) cen2, MUSCL2, and UBS are not \textit{positive} schemes 
    152151\footnote{negative values can appear in an initially strictly positive tracer field  
    153152which is advected} 
     
    189188temperature is close to the freezing point). 
    190189This combined scheme has been included for specific grid points in the ORCA2  
    191 and ORCA4 configurations only. This is an obsolescent feature as the recommended  
     190configuration only. This is an obsolescent feature as the recommended  
    192191advection scheme for the ORCA configuration is TVD (see  \S\ref{TRA_adv_tvd}). 
    193192 
     
    196195have this order of accuracy. \gmcomment{Note also that ... blah, blah} 
    197196 
    198 % ------------------------------------------------------------------------------------------------------------- 
    199 %        4nd order centred scheme   
    200 % ------------------------------------------------------------------------------------------------------------- 
    201 \subsection   [$4^{nd}$ order centred scheme (cen4) (\np{ln\_traadv\_cen4})] 
    202            {$4^{nd}$ order centred scheme (cen4) (\np{ln\_traadv\_cen4}=true)} 
    203 \label{TRA_adv_cen4} 
    204  
    205 In the $4^{th}$ order formulation (to be implemented), tracer values are  
    206 evaluated at velocity points as a $4^{th}$ order interpolation, and thus depend on  
    207 the four neighbouring $T$-points. For example, in the $i$-direction: 
    208 \begin{equation} \label{Eq_tra_adv_cen4} 
    209 \tau _u^{cen4}  
    210 =\overline{   T - \frac{1}{6}\,\delta _i \left[ \delta_{i+1/2}[T] \,\right]   }^{\,i+1/2} 
    211 \end{equation} 
    212  
    213 Strictly speaking, the cen4 scheme is not a $4^{th}$ order advection scheme  
    214 but a $4^{th}$ order evaluation of advective fluxes, since the divergence of  
    215 advective fluxes \eqref{Eq_tra_adv} is kept at $2^{nd}$ order. The phrase ``$4^{th}$  
    216 order scheme'' used in oceanographic literature is usually associated  
    217 with the scheme presented here. Introducing a \textit{true} $4^{th}$ order advection  
    218 scheme is feasible but, for consistency reasons, it requires changes in the  
    219 discretisation of the tracer advection together with changes in both the  
    220 continuity equation and the momentum advection terms.   
    221  
    222 A direct consequence of the pseudo-fourth order nature of the scheme is that  
    223 it is not non-diffusive, i.e. the global variance of a tracer is not preserved using  
    224 \textit{cen4}. Furthermore, it must be used in conjunction with an explicit  
    225 diffusion operator to produce a sensible solution. The time-stepping is also  
    226 performed using a leapfrog scheme in conjunction with an Asselin time-filter,  
    227 so $T$ in (\ref{Eq_tra_adv_cen4}) is the \textit{now} tracer. 
    228  
    229 At a $T$-grid cell adjacent to a boundary (coastline, bottom and surface), an  
    230 additional hypothesis must be made to evaluate $\tau _u^{cen4}$. This  
    231 hypothesis usually reduces the order of the scheme. Here we choose to set  
    232 the gradient of $T$ across the boundary to zero. Alternative conditions can be  
    233 specified, such as a reduction to a second order scheme for these near boundary  
    234 grid points. 
    235197 
    236198% ------------------------------------------------------------------------------------------------------------- 
     
    270232used for the diffusive part.  
    271233 
     234An additional option has been added controlled by \np{ln\_traadv\_tvd\_zts}.  
     235By setting this logical to true, a TVD scheme is used on both horizontal and vertical direction,  
     236but on the latter, a split-explicit time stepping is used, with 5 sub-timesteps.  
     237This option can be useful when the value of the timestep is limited by vertical advection \citep{Lemarie_OM2015}.  
     238Note that in this case, a similar split-explicit time stepping should be used on  
     239vertical advection of momentum to ensure a better stability (see \np{ln\_dynzad\_zts} in \S\ref{DYN_zad}). 
     240 
     241 
    272242% ------------------------------------------------------------------------------------------------------------- 
    273243%        MUSCL scheme   
     
    296266 
    297267For an ocean grid point adjacent to land and where the ocean velocity is  
    298 directed toward land, two choices are available: an upstream flux  
    299 (\np{ln\_traadv\_muscl}=true) or a second order flux  
    300 (\np{ln\_traadv\_muscl2}=true). Note that the latter choice does not ensure  
    301 the \textit{positive} character of the scheme. Only the former can be used  
    302 on both active and passive tracers. The two MUSCL schemes are implemented  
    303 in the \mdl{traadv\_tvd} and \mdl{traadv\_tvd2} modules. 
     268directed toward land, two choices are available: an upstream flux (\np{ln\_traadv\_muscl}=true)  
     269or a second order flux (\np{ln\_traadv\_muscl2}=true).  
     270Note that the latter choice does not ensure the \textit{positive} character of the scheme.  
     271Only the former can be used on both active and passive tracers.  
     272The two MUSCL schemes are implemented in the \mdl{traadv\_tvd} and \mdl{traadv\_tvd2} modules. 
     273 
     274Note that when using np{ln\_traadv\_msc\_ups}~=~true in addition to \np{ln\_traadv\_muscl}=true,  
     275the MUSCL fluxes are replaced by upstream fluxes in vicinity of river mouths. 
    304276 
    305277% ------------------------------------------------------------------------------------------------------------- 
     
    416388direction (as for the UBS case) should be implemented to restore this property. 
    417389 
    418  
    419 % ------------------------------------------------------------------------------------------------------------- 
    420 %        PPM scheme   
    421 % ------------------------------------------------------------------------------------------------------------- 
    422 \subsection   [Piecewise Parabolic Method (PPM) (\np{ln\_traadv\_ppm})] 
    423          {Piecewise Parabolic Method (PPM) (\np{ln\_traadv\_ppm}=true)} 
    424 \label{TRA_adv_ppm} 
    425  
    426 The Piecewise Parabolic Method (PPM) proposed by Colella and Woodward (1984)  
    427 \sgacomment{reference?} 
    428 is based on a quadradic piecewise construction. Like the QCK scheme, it is associated  
    429 with the ULTIMATE QUICKEST limiter \citep{Leonard1991}. It has been implemented  
    430 in \NEMO by G. Reffray (MERCATOR-ocean) but is not yet offered in the reference  
    431 version 3.3. 
    432390 
    433391% ================================================================ 
     
    464422surfaces is given by:  
    465423\begin{equation} \label{Eq_tra_ldf_lap} 
    466 D_T^{lT} =\frac{1}{b_tT} \left( \; 
     424D_T^{lT} =\frac{1}{b_t} \left( \; 
    467425   \delta _{i}\left[ A_u^{lT} \; \frac{e_{2u}\,e_{3u}}{e_{1u}} \;\delta _{i+1/2} [T] \right]  
    468426+ \delta _{j}\left[ A_v^{lT} \;  \frac{e_{1v}\,e_{3v}}{e_{2v}} \;\delta _{j+1/2} [T] \right]  \;\right) 
     
    661619the thickness of the top model layer.  
    662620 
    663 Due to interactions and mass exchange of water ($F_{mass}$) with other Earth system components ($i.e.$ atmosphere, sea-ice, land), 
    664 the change in the heat and salt content of the surface layer of the ocean is due both  
    665 to the heat and salt fluxes crossing the sea surface (not linked with $F_{mass}$) 
    666  and to the heat and salt content of the mass exchange. 
    667 \sgacomment{ the following does not apply to the release to which this documentation is  
    668 attached and so should not be included .... 
    669 In a forthcoming release, these two parts, computed in the surface module (SBC), will be included directly 
    670 in $Q_{ns}$, the surface heat flux and $F_{salt}$, the surface salt flux. 
    671 The specification of these fluxes is further detailed in the SBC chapter (see \S\ref{SBC}).  
    672 This change will provide a forcing formulation which is the same for any tracer (including temperature and salinity). 
    673   
    674 In the current version, the situation is a little bit more complicated. } 
     621Due to interactions and mass exchange of water ($F_{mass}$) with other Earth system components  
     622($i.e.$ atmosphere, sea-ice, land), the change in the heat and salt content of the surface layer  
     623of the ocean is due both to the heat and salt fluxes crossing the sea surface (not linked with $F_{mass}$)  
     624and to the heat and salt content of the mass exchange. They are both included directly in $Q_{ns}$,  
     625the surface heat flux, and $F_{salt}$, the surface salt flux (see \S\ref{SBC} for further details). 
     626By doing this, the forcing formulation is the same for any tracer (including temperature and salinity). 
    675627 
    676628The surface module (\mdl{sbcmod}, see \S\ref{SBC}) provides the following  
     
    679631$\bullet$ $Q_{ns}$, the non-solar part of the net surface heat flux that crosses the sea surface  
    680632(i.e. the difference between the total surface heat flux and the fraction of the short wave flux that  
    681 penetrates into the water column, see \S\ref{TRA_qsr}) 
    682  
    683 $\bullet$ \textit{emp}, the mass flux exchanged with the atmosphere (evaporation minus precipitation) 
    684  
    685 $\bullet$ $\textit{emp}_S$, an equivalent mass flux taking into account the effect of ice-ocean mass exchange 
    686  
    687 $\bullet$ \textit{rnf}, the mass flux associated with runoff (see \S\ref{SBC_rnf} for further detail of how it acts on temperature and salinity tendencies) 
    688  
    689 The $\textit{emp}_S$ field is not simply the budget of evaporation-precipitation+freezing-melting because  
    690 the sea-ice is not currently embedded in the ocean but levitates above it. There is no mass 
    691 exchanged between the sea-ice and the ocean. Instead we only take into account the salt 
    692 flux associated with the non-zero salinity of sea-ice, and the concentration/dilution effect 
    693 due to the freezing/melting (F/M) process. These two parts of the forcing are then converted into  
    694 an equivalent mass flux given by $\textit{emp}_S - \textit{emp}$. As a result of this mess,  
    695 the surface boundary condition on temperature and salinity is applied as follows: 
    696  
    697 In the nonlinear free surface case (\key{vvl} is defined): 
     633penetrates into the water column, see \S\ref{TRA_qsr}) plus the heat content associated with  
     634of the mass exchange with the atmosphere and lands. 
     635 
     636$\bullet$ $\textit{sfx}$, the salt flux resulting from ice-ocean mass exchange (freezing, melting, ridging...) 
     637 
     638$\bullet$ \textit{emp}, the mass flux exchanged with the atmosphere (evaporation minus precipitation)  
     639 and possibly with the sea-ice and ice-shelves. 
     640 
     641$\bullet$ \textit{rnf}, the mass flux associated with runoff  
     642(see \S\ref{SBC_rnf} for further detail of how it acts on temperature and salinity tendencies) 
     643 
     644$\bullet$ \textit{fwfisf}, the mass flux associated with ice shelf melt, (see \S\ref{SBC_isf} for further details  
     645on how the ice shelf melt is computed and applied).\\ 
     646 
     647In the non-linear free surface case (\key{vvl} is defined), the surface boundary condition  
     648on temperature and salinity is applied as follows: 
    698649\begin{equation} \label{Eq_tra_sbc} 
     650\begin{aligned} 
     651 &F^T = \frac{ 1 }{\rho _o \;C_p \,\left. e_{3t} \right|_{k=1} }  &\overline{ Q_{ns}       }^t  & \\  
     652& F^S =\frac{ 1 }{\rho _o  \,      \left. e_{3t} \right|_{k=1} }  &\overline{ \textit{sfx} }^t   & \\    
     653 \end{aligned} 
     654\end{equation}  
     655where $\overline{x }^t$ means that $x$ is averaged over two consecutive time steps  
     656($t-\rdt/2$ and $t+\rdt/2$). Such time averaging prevents the  
     657divergence of odd and even time step (see \S\ref{STP}). 
     658 
     659In the linear free surface case (\key{vvl} is \textit{not} defined),  
     660an additional term has to be added on both temperature and salinity.  
     661On temperature, this term remove the heat content associated with mass exchange 
     662that has been added to $Q_{ns}$. On salinity, this term mimics the concentration/dilution effect that 
     663would have resulted from a change in the volume of the first level. 
     664The resulting surface boundary condition is applied as follows: 
     665\begin{equation} \label{Eq_tra_sbc_lin} 
    699666\begin{aligned} 
    700667 &F^T = \frac{ 1 }{\rho _o \;C_p \,\left. e_{3t} \right|_{k=1} }    
     
    702669% 
    703670& F^S =\frac{ 1 }{\rho _o \,\left. e_{3t} \right|_{k=1} }  
    704            &\overline{ \left( (\textit{emp}_S - \textit{emp})\;\left. S \right|_{k=1}  \right) }^t   & \\    
     671           &\overline{ \left( \;\textit{sfx} - \textit{emp} \;\left. S \right|_{k=1}  \right) }^t   & \\    
    705672 \end{aligned} 
    706673\end{equation}  
    707  
    708 In the linear free surface case (\key{vvl} not defined): 
    709 \begin{equation} \label{Eq_tra_sbc_lin} 
    710 \begin{aligned} 
    711  &F^T = \frac{ 1 }{\rho _o \;C_p \,\left. e_{3t} \right|_{k=1} }  &\overline{ Q_{ns} }^t  & \\  
    712 % 
    713 & F^S =\frac{ 1 }{\rho _o \,\left. e_{3t} \right|_{k=1} }  
    714            &\overline{ \left( \textit{emp}_S\;\left. S \right|_{k=1}  \right) }^t   & \\    
    715  \end{aligned} 
    716 \end{equation}  
    717 where $\overline{x }^t$ means that $x$ is averaged over two consecutive time steps  
    718 ($t-\rdt/2$ and $t+\rdt/2$). Such time averaging prevents the  
    719 divergence of odd and even time step (see \S\ref{STP}). 
    720  
    721 The two set of equations, \eqref{Eq_tra_sbc} and \eqref{Eq_tra_sbc_lin}, are obtained  
    722 by assuming that the temperature of precipitation and evaporation are equal to 
    723 the ocean surface temperature and that their salinity is zero. Therefore, the heat content 
    724 of the \textit{emp} budget must be added to the temperature equation in the variable volume case,  
    725 while it does not appear in the constant volume case. Similarly, the \textit{emp} budget affects  
    726 the ocean surface salinity in the constant volume case (through the concentration dilution effect) 
    727 while it does not appears explicitly in the variable volume case since salinity change will be 
    728 induced by volume change. In both constant and variable volume cases, surface salinity  
    729 will change with ice-ocean salt flux and F/M flux (both contained in $\textit{emp}_S - \textit{emp}$) without mass exchanges. 
    730  
    731 Note that the concentration/dilution effect due to F/M is computed using 
    732 a constant ice salinity as well as a constant ocean salinity.  
    733 This approximation suppresses the correlation between \textit{SSS}  
    734 and F/M flux, allowing the ice-ocean salt exchanges to be conservative. 
    735 Indeed, if this approximation is not made, even if the F/M budget is zero  
    736 on average over the whole ocean domain and over the seasonal cycle,  
    737 the associated salt flux is not zero, since sea-surface salinity and F/M flux are  
    738 intrinsically correlated (high \textit{SSS} are found where freezing is  
    739 strong whilst low \textit{SSS} is usually associated with high melting areas). 
    740  
    741 Even using this approximation, an exact conservation of heat and salt content  
    742 is only achieved in the variable volume case. In the constant volume case,  
    743 there is a small imbalance associated with the product $(\partial_t\eta - \textit{emp}) * \textit{SSS}$. 
    744 Nevertheless, the salt content variation is quite small and will not induce 
    745 a long term drift as there is no physical reason for $(\partial_t\eta - \textit{emp})$  
    746 and \textit{SSS} to be correlated \citep{Roullet_Madec_JGR00}.  
    747 Note that, while quite small, the imbalance in the constant volume case is larger  
     674Note that an exact conservation of heat and salt content is only achieved with non-linear free surface.  
     675In the linear free surface case, there is a small imbalance. The imbalance is larger  
    748676than the imbalance associated with the Asselin time filter \citep{Leclair_Madec_OM09}.  
    749 This is the reason why the modified filter is not applied in the constant volume case. 
     677This is the reason why the modified filter is not applied in the linear free surface case (see \S\ref{STP}). 
    750678 
    751679% ------------------------------------------------------------------------------------------------------------- 
     
    821749($i.e.$ the inverses of the extinction length scales) are tabulated over 61 nonuniform  
    822750chlorophyll classes ranging from 0.01 to 10 g.Chl/L (see the routine \rou{trc\_oce\_rgb}  
    823 in \mdl{trc\_oce} module). Three types of chlorophyll can be chosen in the RGB formulation: 
    824 (1) a constant 0.05 g.Chl/L value everywhere (\np{nn\_chdta}=0) ; (2) an observed  
    825 time varying chlorophyll (\np{nn\_chdta}=1) ; (3) simulated time varying chlorophyll 
    826 by TOP biogeochemical model (\np{ln\_qsr\_bio}=true). In the latter case, the RGB  
    827 formulation is used to calculate both the phytoplankton light limitation in PISCES  
    828 or LOBSTER and the oceanic heating rate.  
    829  
     751in \mdl{trc\_oce} module). Four types of chlorophyll can be chosen in the RGB formulation: 
     752\begin{description}  
     753\item[\np{nn\_chdta}=0]  
     754a constant 0.05 g.Chl/L value everywhere ;  
     755\item[\np{nn\_chdta}=1]   
     756an observed time varying chlorophyll deduced from satellite surface ocean color measurement  
     757spread uniformly in the vertical direction ;  
     758\item[\np{nn\_chdta}=2]   
     759same as previous case except that a vertical profile of chlorophyl is used.  
     760Following \cite{Morel_Berthon_LO89}, the profile is computed from the local surface chlorophyll value ; 
     761\item[\np{ln\_qsr\_bio}=true]   
     762simulated time varying chlorophyll by TOP biogeochemical model.  
     763In this case, the RGB formulation is used to calculate both the phytoplankton  
     764light limitation in PISCES or LOBSTER and the oceanic heating rate.  
     765\end{description}  
    830766The trend in \eqref{Eq_tra_qsr} associated with the penetration of the solar radiation  
    831767is added to the temperature trend, and the surface heat flux is modified in routine \mdl{traqsr}.  
     
    859795\label{TRA_bbc} 
    860796%--------------------------------------------nambbc-------------------------------------------------------- 
    861 \namdisplay{namtra_bbc} 
     797\namdisplay{nambbc} 
    862798%-------------------------------------------------------------------------------------------------------------- 
    863799%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
     
    11031039\subsection[DMP\_TOOLS]{Generating resto.nc using DMP\_TOOLS} 
    11041040 
    1105 DMP\_TOOLS can be used to generate a netcdf file containing the restoration coefficient $\gamma$. Note that in order to maintain bit comparison with previous NEMO versions DMP\_TOOLS must be compiled and run on the same machine as the NEMO model. A mesh\_mask.nc file for the model configuration is required as an input. This can be generated by carrying out a short model run with the namelist parameter \np{nn\_msh} set to 1. The namelist parameter \np{ln\_tradmp} will also need to be set to .false. for this to work. The \nl{nam\_dmp\_create} namelist in the DMP\_TOOLS directory is used to specify options for the restoration coefficient. 
     1041DMP\_TOOLS can be used to generate a netcdf file containing the restoration coefficient $\gamma$.  
     1042Note that in order to maintain bit comparison with previous NEMO versions DMP\_TOOLS must be compiled  
     1043and run on the same machine as the NEMO model. A mesh\_mask.nc file for the model configuration is required as an input.  
     1044This can be generated by carrying out a short model run with the namelist parameter \np{nn\_msh} set to 1.  
     1045The namelist parameter \np{ln\_tradmp} will also need to be set to .false. for this to work.  
     1046The \nl{nam\_dmp\_create} namelist in the DMP\_TOOLS directory is used to specify options for the restoration coefficient. 
    11061047 
    11071048%--------------------------------------------nam_dmp_create------------------------------------------------- 
     
    11111052\np{cp\_cfg}, \np{cp\_cpz}, \np{jp\_cfg} and \np{jperio} specify the model configuration being used and should be the same as specified in \nl{namcfg}. The variable \nl{lzoom} is used to specify that the damping is being used as in case \textit{a} above to provide boundary conditions to a zoom configuration. In the case of the arctic or antarctic zoom configurations this includes some specific treatment. Otherwise damping is applied to the 6 grid points along the ocean boundaries. The open boundaries are specified by the variables \np{lzoom\_n}, \np{lzoom\_e}, \np{lzoom\_s}, \np{lzoom\_w} in the \nl{nam\_zoom\_dmp} name list. 
    11121053 
    1113 The remaining switch namelist variables determine the spatial variation of the restoration coefficient in non-zoom configurations. \np{ln\_full\_field} specifies that newtonian damping should be applied to the whole model domain. \np{ln\_med\_red\_seas} specifies grid specific restoration coefficients in the Mediterranean Sea for the ORCA4, ORCA2 and ORCA05 configurations. If \np{ln\_old\_31\_lev\_code} is set then the depth variation of the coeffients will be specified as a function of the model number. This option is included to allow backwards compatability of the ORCA2 reference configurations with previous model versions. \np{ln\_coast} specifies that the restoration coefficient should be reduced near to coastlines. This option only has an effect if \np{ln\_full\_field} is true. \np{ln\_zero\_top\_layer} specifies that the restoration coefficient should be zero in the surface layer. Finally \np{ln\_custom} specifies that the custom module will be called. This module is contained in the file custom.F90 and can be edited by users. For example damping could be applied in a specific region. 
    1114  
    1115 The restoration coefficient can be set to zero in equatorial regions by specifying a positive value of \np{nn\_hdmp}. Equatorward of this latitude the restoration coefficient will be zero with a smooth transition to the full values of a 10$^{\circ}$ latitud band. This is often used because of the short adjustment time scale in the equatorial region \citep{Reverdin1991, Fujio1991, Marti_PhD92}. The time scale associated with the damping depends on the depth as a hyperbolic tangent, with \np{rn\_surf} as surface value, \np{rn\_bot} as bottom value and a transition depth of \np{rn\_dep}.   
     1054The remaining switch namelist variables determine the spatial variation of the restoration coefficient in non-zoom configurations.  
     1055\np{ln\_full\_field} specifies that newtonian damping should be applied to the whole model domain.  
     1056\np{ln\_med\_red\_seas} specifies grid specific restoration coefficients in the Mediterranean Sea  
     1057for the ORCA4, ORCA2 and ORCA05 configurations.  
     1058If \np{ln\_old\_31\_lev\_code} is set then the depth variation of the coeffients will be specified as  
     1059a function of the model number. This option is included to allow backwards compatability of the ORCA2 reference  
     1060configurations with previous model versions.  
     1061\np{ln\_coast} specifies that the restoration coefficient should be reduced near to coastlines.  
     1062This option only has an effect if \np{ln\_full\_field} is true.  
     1063\np{ln\_zero\_top\_layer} specifies that the restoration coefficient should be zero in the surface layer.  
     1064Finally \np{ln\_custom} specifies that the custom module will be called.  
     1065This module is contained in the file custom.F90 and can be edited by users. For example damping could be applied in a specific region. 
     1066 
     1067The restoration coefficient can be set to zero in equatorial regions by specifying a positive value of \np{nn\_hdmp}.  
     1068Equatorward of this latitude the restoration coefficient will be zero with a smooth transition to  
     1069the full values of a 10$^{\circ}$ latitud band.  
     1070This is often used because of the short adjustment time scale in the equatorial region  
     1071\citep{Reverdin1991, Fujio1991, Marti_PhD92}. The time scale associated with the damping depends on the depth as a  
     1072hyperbolic tangent, with \np{rn\_surf} as surface value, \np{rn\_bot} as bottom value and a transition depth of \np{rn\_dep}.   
    11161073 
    11171074% ================================================================ 
     
    11671124%        Equation of State 
    11681125% ------------------------------------------------------------------------------------------------------------- 
    1169 \subsection{Equation of State (\np{nn\_eos} = 0, 1 or 2)} 
     1126\subsection{Equation Of Seawater (\np{nn\_eos} = -1, 0, or 1)} 
    11701127\label{TRA_eos} 
    11711128 
    1172 It is necessary to know the equation of state for the ocean very accurately  
    1173 to determine stability properties (especially the Brunt-Vais\"{a}l\"{a} frequency),  
    1174 particularly in the deep ocean. The ocean seawater volumic mass, $\rho$,  
    1175 abusively called density, is a non linear empirical function of \textit{in situ}  
    1176 temperature, salinity and pressure. The reference equation of state is that  
    1177 defined by the Joint Panel on Oceanographic Tables and Standards  
    1178 \citep{UNESCO1983}. It was the standard equation of state used in early  
    1179 releases of OPA. However, even though this computation is fully vectorised,  
    1180 it is quite time consuming ($15$ to $20${\%} of the total CPU time) since  
    1181 it requires the prior computation of the \textit{in situ} temperature from the  
    1182 model \textit{potential} temperature using the \citep{Bryden1973} polynomial  
    1183 for adiabatic lapse rate and a $4^th$ order Runge-Kutta integration scheme.  
    1184 Since OPA6, we have used the \citet{JackMcD1995} equation of state for  
    1185 seawater instead. It allows the computation of the \textit{in situ} ocean density  
    1186 directly as a function of \textit{potential} temperature relative to the surface  
    1187 (an \NEMO variable), the practical salinity (another \NEMO variable) and the  
    1188 pressure (assuming no pressure variation along geopotential surfaces, $i.e.$  
    1189 the pressure in decibars is approximated by the depth in meters).  
    1190 Both the \citet{UNESCO1983} and \citet{JackMcD1995} equations of state  
    1191 have exactly the same except that the values of the various coefficients have  
    1192 been adjusted by \citet{JackMcD1995} in order to directly use the \textit{potential}  
    1193 temperature instead of the \textit{in situ} one. This reduces the CPU time of the  
    1194 \textit{in situ} density computation to about $3${\%} of the total CPU time,  
    1195 while maintaining a quite accurate equation of state. 
    1196  
    1197 In the computer code, a \textit{true} density anomaly, $d_a= \rho / \rho_o - 1$,  
    1198 is computed, with $\rho_o$ a reference volumic mass. Called \textit{rau0}  
    1199 in the code, $\rho_o$ is defined in \mdl{phycst}, and a value of $1,035~Kg/m^3$.  
     1129The Equation Of Seawater (EOS) is an empirical nonlinear thermodynamic relationship  
     1130linking seawater density, $\rho$, to a number of state variables,  
     1131most typically temperature, salinity and pressure.  
     1132Because density gradients control the pressure gradient force through the hydrostatic balance,  
     1133the equation of state provides a fundamental bridge between the distribution of active tracers  
     1134and the fluid dynamics. Nonlinearities of the EOS are of major importance, in particular  
     1135influencing the circulation through determination of the static stability below the mixed layer,  
     1136thus controlling rates of exchange between the atmosphere  and the ocean interior \citep{Roquet_JPO2015}.  
     1137Therefore an accurate EOS based on either the 1980 equation of state (EOS-80, \cite{UNESCO1983})  
     1138or TEOS-10 \citep{TEOS10} standards should be used anytime a simulation of the real  
     1139ocean circulation is attempted \citep{Roquet_JPO2015}.  
     1140The use of TEOS-10 is highly recommended because  
     1141\textit{(i)} it is the new official EOS,  
     1142\textit{(ii)} it is more accurate, being based on an updated database of laboratory measurements, and  
     1143\textit{(iii)} it uses Conservative Temperature and Absolute Salinity (instead of potential temperature  
     1144and practical salinity for EOS-980, both variables being more suitable for use as model variables  
     1145\citep{TEOS10, Graham_McDougall_JPO13}.  
     1146EOS-80 is an obsolescent feature of the NEMO system, kept only for backward compatibility. 
     1147For process studies, it is often convenient to use an approximation of the EOS. To that purposed,  
     1148a simplified EOS (S-EOS) inspired by \citet{Vallis06} is also available. 
     1149 
     1150In the computer code, a density anomaly, $d_a= \rho / \rho_o - 1$,  
     1151is computed, with $\rho_o$ a reference density. Called \textit{rau0}  
     1152in the code, $\rho_o$ is set in \mdl{phycst} to a value of $1,026~Kg/m^3$.  
    12001153This is a sensible choice for the reference density used in a Boussinesq ocean  
    12011154climate model, as, with the exception of only a small percentage of the ocean,  
    1202 density in the World Ocean varies by no more than 2$\%$ from $1,035~kg/m^3$  
    1203 \citep{Gill1982}. 
    1204  
    1205 Options are defined through the  \ngn{nameos} namelist variables. 
    1206 The default option (namelist parameter \np{nn\_eos}=0) is the \citet{JackMcD1995}  
    1207 equation of state. Its use is highly recommended. However, for process studies,  
    1208 it is often convenient to use a linear approximation of the density. 
     1155density in the World Ocean varies by no more than 2$\%$ from that value \citep{Gill1982}. 
     1156 
     1157Options are defined through the  \ngn{nameos} namelist variables, and in particular \np{nn\_eos}  
     1158which controls the EOS used (=-1 for TEOS10 ; =0 for EOS-80 ; =1 for S-EOS). 
     1159\begin{description} 
     1160 
     1161\item[\np{nn\_eos}$=-1$] the polyTEOS10-bsq equation of seawater \citep{Roquet_OM2015} is used.   
     1162The accuracy of this approximation is comparable to the TEOS-10 rational function approximation,  
     1163but it is optimized for a boussinesq fluid and the polynomial expressions have simpler  
     1164and more computationally efficient expressions for their derived quantities  
     1165which make them more adapted for use in ocean models.  
     1166Note that a slightly higher precision polynomial form is now used replacement of the TEOS-10  
     1167rational function approximation for hydrographic data analysis  \citep{TEOS10}.  
     1168A key point is that conservative state variables are used:  
     1169Absolute Salinity (unit: g/kg, notation: $S_A$) and Conservative Temperature (unit: $\degres C$, notation: $\Theta$). 
     1170The pressure in decibars is approximated by the depth in meters.  
     1171With TEOS10, the specific heat capacity of sea water, $C_p$, is a constant. It is set to  
     1172$C_p=3991.86795711963~J\,Kg^{-1}\,\degres K^{-1}$, according to \citet{TEOS10}. 
     1173 
     1174Choosing polyTEOS10-bsq implies that the state variables used by the model are  
     1175$\Theta$ and $S_A$. In particular, the initial state deined by the user have to be given as  
     1176\textit{Conservative} Temperature and \textit{Absolute} Salinity.  
     1177In addition, setting \np{ln\_useCT} to \textit{true} convert the Conservative SST to potential SST  
     1178prior to either computing the air-sea and ice-sea fluxes (forced mode)  
     1179or sending the SST field to the atmosphere (coupled mode). 
     1180 
     1181\item[\np{nn\_eos}$=0$] the polyEOS80-bsq equation of seawater is used. 
     1182It takes the same polynomial form as the polyTEOS10, but the coefficients have been optimized  
     1183to accurately fit EOS80 (Roquet, personal comm.). The state variables used in both the EOS80  
     1184and the ocean model are:  
     1185the Practical Salinity ((unit: psu, notation: $S_p$)) and Potential Temperature (unit: $\degres C$, notation: $\theta$). 
     1186The pressure in decibars is approximated by the depth in meters.   
     1187With thsi EOS, the specific heat capacity of sea water, $C_p$, is a function of temperature,  
     1188salinity and pressure \citep{UNESCO1983}. Nevertheless, a severe assumption is made in order to  
     1189have a heat content ($C_p T_p$) which is conserved by the model: $C_p$ is set to a constant  
     1190value, the TEOS10 value.  
     1191  
     1192\item[\np{nn\_eos}$=1$] a simplified EOS (S-EOS) inspired by \citet{Vallis06} is chosen,  
     1193the coefficients of which has been optimized to fit the behavior of TEOS10 (Roquet, personal comm.)  
     1194(see also \citet{Roquet_JPO2015}). It provides a simplistic linear representation of both  
     1195cabbeling and thermobaricity effects which is enough for a proper treatment of the EOS  
     1196in theoretical studies \citep{Roquet_JPO2015}. 
    12091197With such an equation of state there is no longer a distinction between  
    1210 \textit{in situ} and \textit{potential} density and both cabbeling and thermobaric 
    1211 effects are removed. 
    1212 Two linear formulations are available: a function of $T$ only (\np{nn\_eos}=1)  
    1213 and a function of both $T$ and $S$ (\np{nn\_eos}=2): 
    1214 \begin{equation} \label{Eq_tra_eos_linear} 
     1198\textit{conservative} and \textit{potential} temperature, as well as between \textit{absolute}  
     1199and \textit{practical} salinity. 
     1200S-EOS takes the following expression: 
     1201\begin{equation} \label{Eq_tra_S-EOS} 
    12151202\begin{split} 
    1216   d_a(T)       &=  \rho (T)      /  \rho_o   - 1     =  \  0.0285         -  \alpha   \;T     \\  
    1217   d_a(T,S)    &=  \rho (T,S)   /  \rho_o   - 1     =  \  \beta \; S       -  \alpha   \;T     
     1203  d_a(T,S,z)  =  ( & - a_0 \; ( 1 + 0.5 \; \lambda_1 \; T_a + \mu_1 \; z ) * T_a  \\ 
     1204                                & + b_0 \; ( 1 - 0.5 \; \lambda_2 \; S_a - \mu_2 \; z ) * S_a  \\ 
     1205                                & - \nu \; T_a \; S_a \;  ) \; / \; \rho_o                     \\ 
     1206  with \ \  T_a = T-10  \; ;  & \;  S_a = S-35  \; ;\;  \rho_o = 1026~Kg/m^3 
    12181207\end{split} 
    12191208\end{equation}  
    1220 where $\alpha$ and $\beta$ are the thermal and haline expansion  
    1221 coefficients, and $\rho_o$, the reference volumic mass, $rau0$.  
    1222 ($\alpha$ and $\beta$ can be modified through the \np{rn\_alpha} and  
    1223 \np{rn\_beta} namelist variables). Note that when $d_a$ is a function  
    1224 of $T$ only (\np{nn\_eos}=1), the salinity is a passive tracer and can be  
    1225 used as such. 
    1226  
    1227 % ------------------------------------------------------------------------------------------------------------- 
    1228 %        Brunt-Vais\"{a}l\"{a} Frequency 
    1229 % ------------------------------------------------------------------------------------------------------------- 
    1230 \subsection{Brunt-Vais\"{a}l\"{a} Frequency (\np{nn\_eos} = 0, 1 or 2)} 
     1209where the computer name of the coefficients as well as their standard value are given in \ref{Tab_SEOS}. 
     1210In fact, when choosing S-EOS, various approximation of EOS can be specified simply by changing  
     1211the associated coefficients.  
     1212Setting to zero the two thermobaric coefficients ($\mu_1$, $\mu_2$) remove thermobaric effect from S-EOS. 
     1213setting to zero the three cabbeling coefficients ($\lambda_1$, $\lambda_2$, $\nu$) remove cabbeling effect from S-EOS. 
     1214Keeping non-zero value to $a_0$ and $b_0$ provide a linear EOS function of T and S. 
     1215 
     1216\end{description} 
     1217 
     1218 
     1219%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
     1220\begin{table}[!tb] 
     1221\begin{center} \begin{tabular}{|p{26pt}|p{72pt}|p{56pt}|p{136pt}|} 
     1222\hline 
     1223coeff.   & computer name   & S-EOS     &  description                      \\ \hline 
     1224$a_0$       & \np{rn\_a0}     & 1.6550 $10^{-1}$ &  linear thermal expansion coeff.    \\ \hline 
     1225$b_0$       & \np{rn\_b0}     & 7.6554 $10^{-1}$ &  linear haline  expansion coeff.    \\ \hline 
     1226$\lambda_1$ & \np{rn\_lambda1}& 5.9520 $10^{-2}$ &  cabbeling coeff. in $T^2$          \\ \hline 
     1227$\lambda_2$ & \np{rn\_lambda2}& 5.4914 $10^{-4}$ &  cabbeling coeff. in $S^2$       \\ \hline 
     1228$\nu$       & \np{rn\_nu}     & 2.4341 $10^{-3}$ &  cabbeling coeff. in $T \, S$       \\ \hline 
     1229$\mu_1$     & \np{rn\_mu1}    & 1.4970 $10^{-4}$ &  thermobaric coeff. in T         \\ \hline 
     1230$\mu_2$     & \np{rn\_mu2}    & 1.1090 $10^{-5}$ &  thermobaric coeff. in S            \\ \hline 
     1231\end{tabular} 
     1232\caption{ \label{Tab_SEOS} 
     1233Standard value of S-EOS coefficients. } 
     1234\end{center} 
     1235\end{table} 
     1236%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
     1237 
     1238 
     1239% ------------------------------------------------------------------------------------------------------------- 
     1240%        Brunt-V\"{a}is\"{a}l\"{a} Frequency 
     1241% ------------------------------------------------------------------------------------------------------------- 
     1242\subsection{Brunt-V\"{a}is\"{a}l\"{a} Frequency (\np{nn\_eos} = 0, 1 or 2)} 
    12311243\label{TRA_bn2} 
    12321244 
    1233 An accurate computation of the ocean stability (i.e. of $N$, the brunt-Vais\"{a}l\"{a} 
    1234  frequency) is of paramount importance as it is used in several ocean  
    1235  parameterisations (namely TKE, KPP, Richardson number dependent  
    1236  vertical diffusion, enhanced vertical diffusion, non-penetrative convection,  
    1237  iso-neutral diffusion). In particular, one must be aware that $N^2$ has to  
    1238  be computed with an \textit{in situ} reference. The expression for $N^2$  
    1239  depends on the type of equation of state used (\np{nn\_eos} namelist parameter). 
    1240  
    1241 For \np{nn\_eos}=0 (\citet{JackMcD1995} equation of state), the \citet{McDougall1987}  
    1242 polynomial expression is used (with the pressure in decibar approximated by  
    1243 the depth in meters):  
     1245An accurate computation of the ocean stability (i.e. of $N$, the brunt-V\"{a}is\"{a}l\"{a} 
     1246 frequency) is of paramount importance as determine the ocean stratification and  
     1247 is used in several ocean parameterisations (namely TKE, GLS, Richardson number dependent  
     1248 vertical diffusion, enhanced vertical diffusion, non-penetrative convection, tidal mixing  
     1249 parameterisation, iso-neutral diffusion). In particular, $N^2$ has to be computed at the local pressure  
     1250 (pressure in decibar being approximated by the depth in meters). The expression for $N^2$  
     1251 is given by:  
    12441252\begin{equation} \label{Eq_tra_bn2} 
    1245 N^2 = \frac{g}{e_{3w}} \; \beta   \  
    1246       \left(  \alpha / \beta \ \delta_{k+1/2}[T]     - \delta_{k+1/2}[S]   \right)  
    1247 \end{equation}  
    1248 where $\alpha$ and $\beta$ are the thermal and haline expansion coefficients.  
    1249 They are a function of  $\overline{T}^{\,k+1/2},\widetilde{S}=\overline{S}^{\,k+1/2} - 35.$,  
    1250 and  $z_w$, with $T$ the \textit{potential} temperature and $\widetilde{S}$ a salinity anomaly.  
    1251 Note that both $\alpha$ and $\beta$ depend on \textit{potential}  
    1252 temperature and salinity which are averaged at $w$-points prior  
    1253 to the computation instead of being computed at $T$-points and  
    1254 then averaged to $w$-points. 
    1255  
    1256 When a linear equation of state is used (\np{nn\_eos}=1 or 2,  
    1257 \eqref{Eq_tra_bn2} reduces to: 
    1258 \begin{equation} \label{Eq_tra_bn2_linear} 
    12591253N^2 = \frac{g}{e_{3w}} \left(   \beta \;\delta_{k+1/2}[S] - \alpha \;\delta_{k+1/2}[T]   \right) 
    12601254\end{equation}  
    1261 where $\alpha$ and $\beta $ are the constant coefficients used to  
    1262 defined the linear equation of state \eqref{Eq_tra_eos_linear}. 
    1263  
    1264 % ------------------------------------------------------------------------------------------------------------- 
    1265 %        Specific Heat 
    1266 % ------------------------------------------------------------------------------------------------------------- 
    1267 \subsection    [Specific Heat (\textit{phycst})] 
    1268          {Specific Heat (\mdl{phycst})} 
    1269 \label{TRA_adv_ldf} 
    1270  
    1271 The specific heat of sea water, $C_p$, is a function of temperature, salinity  
    1272 and pressure \citep{UNESCO1983}. It is only used in the model to convert  
    1273 surface heat fluxes into surface temperature increase and so the pressure  
    1274 dependence is neglected. The dependence on $T$ and $S$ is weak.  
    1275 For example, with $S=35~psu$, $C_p$ increases from $3989$ to $4002$  
    1276 when $T$ varies from -2~\degres C to 31~\degres C. Therefore, $C_p$ has  
    1277 been chosen as a constant: $C_p=4.10^3~J\,Kg^{-1}\,\degres K^{-1}$.  
    1278 Its value is set in \mdl{phycst} module.  
    1279  
     1255where $(T,S) = (\Theta, S_A)$ for TEOS10, $= (\theta, S_p)$ for TEOS-80, or $=(T,S)$ for S-EOS,  
     1256and, $\alpha$ and $\beta$ are the thermal and haline expansion coefficients.  
     1257The coefficients are a polynomial function of temperature, salinity and depth which expression  
     1258depends on the chosen EOS. They are computed through \textit{eos\_rab}, a \textsc{Fortran}  
     1259function that can be found in \mdl{eosbn2}. 
    12801260 
    12811261% ------------------------------------------------------------------------------------------------------------- 
     
    12981278sea water ($i.e.$ referenced to the surface $p=0$), thus the pressure dependent  
    12991279terms in \eqref{Eq_tra_eos_fzp} (last term) have been dropped. The freezing 
    1300 point is computed through \textit{tfreez}, a \textsc{Fortran} function that can be found  
     1280point is computed through \textit{eos\_fzp}, a \textsc{Fortran} function that can be found  
    13011281in \mdl{eosbn2}.   
    13021282 
     
    13081288\label{TRA_zpshde} 
    13091289 
    1310 \gmcomment{STEVEN: to be consistent with earlier discussion of differencing and averaging operators, I've changed "derivative" to "difference" and "mean" to "average"} 
    1311  
    1312 With partial bottom cells (\np{ln\_zps}=true), in general, tracers in horizontally  
     1290\gmcomment{STEVEN: to be consistent with earlier discussion of differencing and averaging operators,  
     1291                   I've changed "derivative" to "difference" and "mean" to "average"} 
     1292 
     1293With partial cells (\np{ln\_zps}=true) at bottom and top (\np{ln\_isfcav}=true), in general, tracers in horizontally  
    13131294adjacent cells live at different depths. Horizontal gradients of tracers are needed  
    13141295for horizontal diffusion (\mdl{traldf} module) and for the hydrostatic pressure  
    13151296gradient (\mdl{dynhpg} module) to be active.  
    13161297\gmcomment{STEVEN from gm : question: not sure of  what -to be active- means} 
     1298 
    13171299Before taking horizontal gradients between the tracers next to the bottom, a linear  
    13181300interpolation in the vertical is used to approximate the deeper tracer as if it actually  
     
    13901372\gmcomment{gm :   this last remark has to be done} 
    13911373%%% 
     1374 
     1375If under ice shelf seas opened (\np{ln\_isfcav}=true), the partial cell properties  
     1376at the top are computed in the same way as for the bottom. Some extra variables are,  
     1377however, computed to reduce the flow generated at the top and bottom if $z*$ coordinates activated. 
     1378The extra variables calculated and used by \S\ref{DYN_hpg_isf} are: 
     1379 
     1380$\bullet$ $\overline{T}_k^{\,i+1/2}$ as described in \eqref{Eq_zps_hde} 
     1381 
     1382$\bullet$ $\delta _{i+1/2} Z_{T_k} = \widetilde {Z}^{\,i}_{T_k}-Z^{\,i}_{T_k}$ to compute  
     1383the pressure gradient correction term used by \eqref{Eq_dynhpg_sco} in \S\ref{DYN_hpg_isf}, 
     1384 with $\widetilde {Z}_{T_k}$ the depth of the point $\widetilde {T}_{k}$ in case of $z^*$ coordinates  
     1385(this term = 0 in z-coordinates) 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Chapters/Chap_ZDF.tex

    r5120 r6436  
    3333points, respectively (see \S\ref{TRA_zdf} and \S\ref{DYN_zdf}). These  
    3434coefficients can be assumed to be either constant, or a function of the local  
    35 Richardson number, or computed from a turbulent closure model (either  
    36 TKE or KPP formulation). The computation of these coefficients is initialized  
    37 in the \mdl{zdfini} module and performed in the \mdl{zdfric}, \mdl{zdftke} or  
    38 \mdl{zdfkpp} modules. The trends due to the vertical momentum and tracer  
    39 diffusion, including the surface forcing, are computed and added to the  
    40 general trend in the \mdl{dynzdf} and \mdl{trazdf} modules, respectively.  
     35Richardson number, or computed from a turbulent closure model (TKE, GLS or KPP formulation).  
     36The computation of these coefficients is initialized in the \mdl{zdfini} module  
     37and performed in the \mdl{zdfric}, \mdl{zdftke}, \mdl{zdfgls} or \mdl{zdfkpp} modules.  
     38The trends due to the vertical momentum and tracer diffusion, including the surface forcing,  
     39are computed and added to the general trend in the \mdl{dynzdf} and \mdl{trazdf} modules, respectively.  
    4140These trends can be computed using either a forward time stepping scheme  
    4241(namelist parameter \np{ln\_zdfexp}=true) or a backward time stepping  
     
    262261\end{equation} 
    263262 
    264 At the ocean surface, a non zero length scale is set through the  \np{rn\_lmin0} namelist  
     263At the ocean surface, a non zero length scale is set through the  \np{rn\_mxl0} namelist  
    265264parameter. Usually the surface scale is given by $l_o = \kappa \,z_o$  
    266265where $\kappa = 0.4$ is von Karman's constant and $z_o$ the roughness  
    267266parameter of the surface. Assuming $z_o=0.1$~m \citep{Craig_Banner_JPO94}  
    268 leads to a 0.04~m, the default value of \np{rn\_lsurf}. In the ocean interior  
     267leads to a 0.04~m, the default value of \np{rn\_mxl0}. In the ocean interior  
    269268a minimum length scale is set to recover the molecular viscosity when $\bar{e}$  
    270269reach its minimum value ($1.10^{-6}= C_k\, l_{min} \,\sqrt{\bar{e}_{min}}$ ). 
     
    295294As the surface boundary condition on TKE is prescribed through $\bar{e}_o = e_{bb} |\tau| / \rho_o$,  
    296295with $e_{bb}$ the \np{rn\_ebb} namelist parameter, setting \np{rn\_ebb}~=~67.83 corresponds  
    297 to $\alpha_{CB} = 100$. further setting  \np{ln\_lsurf} to true applies \eqref{ZDF_Lsbc}  
    298 as surface boundary condition on length scale, with $\beta$ hard coded to the Stacet's value. 
     296to $\alpha_{CB} = 100$. Further setting  \np{ln\_mxl0} to true applies \eqref{ZDF_Lsbc}  
     297as surface boundary condition on length scale, with $\beta$ hard coded to the Stacey's value. 
    299298Note that a minimal threshold of \np{rn\_emin0}$=10^{-4}~m^2.s^{-2}$ (namelist parameters)  
    300299is applied on surface $\bar{e}$ value. 
     
    355354%--------------------------------------------------------------% 
    356355 
    357 To be add here a description of "penetration of TKE" and the associated namelist parameters 
    358  \np{nn\_etau}, \np{rn\_efr} and \np{nn\_htau}. 
     356Vertical mixing parameterizations commonly used in ocean general circulation models  
     357tend to produce mixed-layer depths that are too shallow during summer months and windy conditions. 
     358This bias is particularly acute over the Southern Ocean.  
     359To overcome this systematic bias, an ad hoc parameterization is introduced into the TKE scheme  \cite{Rodgers_2014}.  
     360The parameterization is an empirical one, $i.e.$ not derived from theoretical considerations,  
     361but rather is meant to account for observed processes that affect the density structure of  
     362the ocean’s planetary boundary layer that are not explicitly captured by default in the TKE scheme  
     363($i.e.$ near-inertial oscillations and ocean swells and waves). 
     364 
     365When using this parameterization ($i.e.$ when \np{nn\_etau}~=~1), the TKE input to the ocean ($S$)  
     366imposed by the winds in the form of near-inertial oscillations, swell and waves is parameterized  
     367by \eqref{ZDF_Esbc} the standard TKE surface boundary condition, plus a depth depend one given by: 
     368\begin{equation}  \label{ZDF_Ehtau} 
     369S = (1-f_i) \; f_r \; e_s \; e^{-z / h_\tau}  
     370\end{equation} 
     371where  
     372$z$ is the depth,   
     373$e_s$ is TKE surface boundary condition,  
     374$f_r$ is the fraction of the surface TKE that penetrate in the ocean,  
     375$h_\tau$ is a vertical mixing length scale that controls exponential shape of the penetration,  
     376and $f_i$ is the ice concentration (no penetration if $f_i=1$, that is if the ocean is entirely  
     377covered by sea-ice). 
     378The value of $f_r$, usually a few percents, is specified through \np{rn\_efr} namelist parameter.  
     379The vertical mixing length scale, $h_\tau$, can be set as a 10~m uniform value (\np{nn\_etau}~=~0)  
     380or a latitude dependent value (varying from 0.5~m at the Equator to a maximum value of 30~m  
     381at high latitudes (\np{nn\_etau}~=~1).  
     382 
     383Note that two other option existe, \np{nn\_etau}~=~2, or 3. They correspond to applying  
     384\eqref{ZDF_Ehtau} only at the base of the mixed layer, or to using the high frequency part  
     385of the stress to evaluate the fraction of TKE that penetrate the ocean.  
     386Those two options are obsolescent features introduced for test purposes. 
     387They will be removed in the next release.  
     388 
     389 
    359390 
    360391% from Burchard et al OM 2008 :  
    361 % the most critical process not reproduced by statistical turbulence models is the activity of internal waves and their interaction with turbulence. After the Reynolds decomposition, internal waves are in principle included in the RANS equations, but later partially excluded by the hydrostatic assumption and the model resolution. Thus far, the representation of internal wave mixing in ocean models has been relatively crude (e.g. Mellor, 1989; Large et al., 1994; Meier, 2001; Axell, 2002; St. Laurent and Garrett, 2002). 
     392% the most critical process not reproduced by statistical turbulence models is the activity of  
     393% internal waves and their interaction with turbulence. After the Reynolds decomposition,  
     394% internal waves are in principle included in the RANS equations, but later partially  
     395% excluded by the hydrostatic assumption and the model resolution.  
     396% Thus far, the representation of internal wave mixing in ocean models has been relatively crude  
     397% (e.g. Mellor, 1989; Large et al., 1994; Meier, 2001; Axell, 2002; St. Laurent and Garrett, 2002). 
    362398 
    363399 
     
    586622Options are defined through the  \ngn{namzdf\_kpp} namelist variables. 
    587623 
    588 \colorbox{yellow}{Add a description of KPP here.} 
     624Note that KPP is an obsolescent feature of the \NEMO system.  
     625It will be removed in the next release (v3.7 and followings). 
    589626 
    590627 
     
    636673 
    637674Options are defined through the  \ngn{namzdf} namelist variables. 
    638 The non-penetrative convective adjustment is used when \np{ln\_zdfnpc}=true.  
     675The non-penetrative convective adjustment is used when \np{ln\_zdfnpc}~=~\textit{true}.  
    639676It is applied at each \np{nn\_npc} time step and mixes downwards instantaneously  
    640677the statically unstable portion of the water column, but only until the density  
     
    644681(Fig. \ref{Fig_npc}): starting from the top of the ocean, the first instability is  
    645682found. Assume in the following that the instability is located between levels  
    646 $k$ and $k+1$. The potential temperature and salinity in the two levels are  
     683$k$ and $k+1$. The temperature and salinity in the two levels are  
    647684vertically mixed, conserving the heat and salt contents of the water column.  
    648685The new density is then computed by a linear approximation. If the new  
     
    664701\citep{Madec_al_JPO91, Madec_al_DAO91, Madec_Crepon_Bk91}. 
    665702 
    666 Note that in the current implementation of this algorithm presents several  
    667 limitations. First, potential density referenced to the sea surface is used to  
    668 check whether the density profile is stable or not. This is a strong  
    669 simplification which leads to large errors for realistic ocean simulations.  
    670 Indeed, many water masses of the world ocean, especially Antarctic Bottom 
    671 Water, are unstable when represented in surface-referenced potential density.  
    672 The scheme will erroneously mix them up. Second, the mixing of potential  
    673 density is assumed to be linear. This assures the convergence of the algorithm  
    674 even when the equation of state is non-linear. Small static instabilities can thus  
    675 persist due to cabbeling: they will be treated at the next time step.  
    676 Third, temperature and salinity, and thus density, are mixed, but the  
    677 corresponding velocity fields remain unchanged. When using a Richardson  
    678 Number dependent eddy viscosity, the mixing of momentum is done through  
    679 the vertical diffusion: after a static adjustment, the Richardson Number is zero  
    680 and thus the eddy viscosity coefficient is at a maximum. When this convective  
    681 adjustment algorithm is used with constant vertical eddy viscosity, spurious  
    682 solutions can occur since the vertical momentum diffusion remains small even  
    683 after a static adjustment. In that case, we recommend the addition of momentum  
    684 mixing in a manner that mimics the mixing in temperature and salinity  
    685 \citep{Speich_PhD92, Speich_al_JPO96}. 
     703The current implementation has been modified in order to deal with any non linear  
     704equation of seawater (L. Brodeau, personnal communication).  
     705Two main differences have been introduced compared to the original algorithm:  
     706$(i)$ the stability is now checked using the Brunt-V\"{a}is\"{a}l\"{a} frequency  
     707(not the the difference in potential density) ;  
     708$(ii)$ when two levels are found unstable, their thermal and haline expansion coefficients  
     709are vertically mixed in the same way their temperature and salinity has been mixed. 
     710These two modifications allow the algorithm to perform properly and accurately  
     711with TEOS10 or EOS-80 without having to recompute the expansion coefficients at each  
     712mixing iteration. 
    686713 
    687714% ------------------------------------------------------------------------------------------------------------- 
     
    689716% ------------------------------------------------------------------------------------------------------------- 
    690717\subsection   [Enhanced Vertical Diffusion (\np{ln\_zdfevd})] 
    691          {Enhanced Vertical Diffusion (\np{ln\_zdfevd}=true)} 
     718              {Enhanced Vertical Diffusion (\np{ln\_zdfevd}=true)} 
    692719\label{ZDF_evd} 
    693720 
     
    830857% Bottom Friction 
    831858% ================================================================ 
    832 \section  [Bottom and top Friction (\textit{zdfbfr})]   {Bottom Friction (\mdl{zdfbfr} module)} 
     859\section  [Bottom and Top Friction (\textit{zdfbfr})]   {Bottom and Top Friction (\mdl{zdfbfr} module)} 
    833860\label{ZDF_bfr} 
    834861 
     
    838865 
    839866Options to define the top and bottom friction are defined through the  \ngn{nambfr} namelist variables. 
    840 The top friction is activated only if the ice shelf cavities are opened (\np{ln\_isfcav}~=~true). 
    841 As the friction processes at the top and bottom are the represented similarly, only the bottom friction is described in detail. 
     867The bottom friction represents the friction generated by the bathymetry.  
     868The top friction represents the friction generated by the ice shelf/ocean interface.  
     869As the friction processes at the top and bottom are represented similarly, only the bottom friction is described in detail below.\\ 
     870 
    842871 
    843872Both the surface momentum flux (wind stress) and the bottom momentum  
     
    912941$H = 4000$~m, the resulting friction coefficient is $r = 4\;10^{-4}$~m\;s$^{-1}$.  
    913942This is the default value used in \NEMO. It corresponds to a decay time scale  
    914 of 115~days. It can be changed by specifying \np{rn\_bfric1} (namelist parameter). 
     943of 115~days. It can be changed by specifying \np{rn\_bfri1} (namelist parameter). 
    915944 
    916945For the linear friction case the coefficients defined in the general  
     
    922951\end{split} 
    923952\end{equation} 
    924 When \np{nn\_botfr}=1, the value of $r$ used is \np{rn\_bfric1}.  
     953When \np{nn\_botfr}=1, the value of $r$ used is \np{rn\_bfri1}.  
    925954Setting \np{nn\_botfr}=0 is equivalent to setting $r=0$ and leads to a free-slip  
    926955bottom boundary condition. These values are assigned in \mdl{zdfbfr}.  
     
    929958in the \ifile{bfr\_coef} input NetCDF file. The mask values should vary from 0 to 1.  
    930959Locations with a non-zero mask value will have the friction coefficient increased  
    931 by $mask\_value$*\np{rn\_bfrien}*\np{rn\_bfric1}. 
     960by $mask\_value$*\np{rn\_bfrien}*\np{rn\_bfri1}. 
    932961 
    933962% ------------------------------------------------------------------------------------------------------------- 
     
    949978$e_b = 2.5\;10^{-3}$m$^2$\;s$^{-2}$, while the FRAM experiment \citep{Killworth1992}  
    950979uses $C_D = 1.4\;10^{-3}$ and $e_b =2.5\;\;10^{-3}$m$^2$\;s$^{-2}$.  
    951 The CME choices have been set as default values (\np{rn\_bfric2} and \np{rn\_bfeb2}  
     980The CME choices have been set as default values (\np{rn\_bfri2} and \np{rn\_bfeb2}  
    952981namelist parameters). 
    953982 
     
    964993\end{equation} 
    965994 
    966 The coefficients that control the strength of the non-linear bottom friction are  
    967 initialised as namelist parameters: $C_D$= \np{rn\_bfri2}, and $e_b$ =\np{rn\_bfeb2}.  
    968 Note for applications which treat tides explicitly a low or even zero value of  
    969 \np{rn\_bfeb2} is recommended. From v3.2 onwards a local enhancement of $C_D$  
    970 is possible via an externally defined 2D mask array (\np{ln\_bfr2d}=true).  
    971 See previous section for details. 
     995The coefficients that control the strength of the non-linear bottom friction are 
     996initialised as namelist parameters: $C_D$= \np{rn\_bfri2}, and $e_b$ =\np{rn\_bfeb2}. 
     997Note for applications which treat tides explicitly a low or even zero value of 
     998\np{rn\_bfeb2} is recommended. From v3.2 onwards a local enhancement of $C_D$ is possible 
     999via an externally defined 2D mask array (\np{ln\_bfr2d}=true).  This works in the same way 
     1000as for the linear bottom friction case with non-zero masked locations increased by 
     1001$mask\_value$*\np{rn\_bfrien}*\np{rn\_bfri2}. 
     1002 
     1003% ------------------------------------------------------------------------------------------------------------- 
     1004%       Bottom Friction Log-layer 
     1005% ------------------------------------------------------------------------------------------------------------- 
     1006\subsection{Log-layer Bottom Friction enhancement (\np{nn\_botfr} = 2, \np{ln\_loglayer} = .true.)} 
     1007\label{ZDF_bfr_loglayer} 
     1008 
     1009In the non-linear bottom friction case, the drag coefficient, $C_D$, can be optionally 
     1010enhanced using a "law of the wall" scaling. If  \np{ln\_loglayer} = .true., $C_D$ is no 
     1011longer constant but is related to the thickness of the last wet layer in each column by: 
     1012 
     1013\begin{equation} 
     1014C_D = \left ( {\kappa \over {\rm log}\left ( 0.5e_{3t}/rn\_bfrz0 \right ) } \right )^2 
     1015\end{equation} 
     1016 
     1017\noindent where $\kappa$ is the von-Karman constant and \np{rn\_bfrz0} is a roughness 
     1018length provided via the namelist. 
     1019 
     1020For stability, the drag coefficient is bounded such that it is kept greater or equal to 
     1021the base \np{rn\_bfri2} value and it is not allowed to exceed the value of an additional 
     1022namelist parameter: \np{rn\_bfri2\_max}, i.e.: 
     1023 
     1024\begin{equation} 
     1025rn\_bfri2 \leq C_D \leq rn\_bfri2\_max 
     1026\end{equation} 
     1027 
     1028\noindent Note also that a log-layer enhancement can also be applied to the top boundary 
     1029friction if under ice-shelf cavities are in use (\np{ln\_isfcav}=.true.).  In this case, the 
     1030relevant namelist parameters are \np{rn\_tfrz0}, \np{rn\_tfri2} 
     1031and \np{rn\_tfri2\_max}. 
    9721032 
    9731033% ------------------------------------------------------------------------------------------------------------- 
     
    12531313 
    12541314% ================================================================ 
     1315% Internal wave-driven mixing 
     1316% ================================================================ 
     1317\section{Internal wave-driven mixing (\key{zdftmx\_new})} 
     1318\label{ZDF_tmx_new} 
     1319 
     1320%--------------------------------------------namzdf_tmx_new------------------------------------------ 
     1321\namdisplay{namzdf_tmx_new} 
     1322%-------------------------------------------------------------------------------------------------------------- 
     1323 
     1324The parameterization of mixing induced by breaking internal waves is a generalization  
     1325of the approach originally proposed by \citet{St_Laurent_al_GRL02}.  
     1326A three-dimensional field of internal wave energy dissipation $\epsilon(x,y,z)$ is first constructed,  
     1327and the resulting diffusivity is obtained as  
     1328\begin{equation} \label{Eq_Kwave} 
     1329A^{vT}_{wave} =  R_f \,\frac{ \epsilon }{ \rho \, N^2 } 
     1330\end{equation} 
     1331where $R_f$ is the mixing efficiency and $\epsilon$ is a specified three dimensional distribution  
     1332of the energy available for mixing. If the \np{ln\_mevar} namelist parameter is set to false,  
     1333the mixing efficiency is taken as constant and equal to 1/6 \citep{Osborn_JPO80}.  
     1334In the opposite (recommended) case, $R_f$ is instead a function of the turbulence intensity parameter  
     1335$Re_b = \frac{ \epsilon}{\nu \, N^2}$, with $\nu$ the molecular viscosity of seawater,  
     1336following the model of \cite{Bouffard_Boegman_DAO2013}  
     1337and the implementation of \cite{de_lavergne_JPO2016_efficiency}. 
     1338Note that $A^{vT}_{wave}$ is bounded by $10^{-2}\,m^2/s$, a limit that is often reached when the mixing efficiency is constant. 
     1339 
     1340In addition to the mixing efficiency, the ratio of salt to heat diffusivities can chosen to vary  
     1341as a function of $Re_b$ by setting the \np{ln\_tsdiff} parameter to true, a recommended choice).  
     1342This parameterization of differential mixing, due to \cite{Jackson_Rehmann_JPO2014},  
     1343is implemented as in \cite{de_lavergne_JPO2016_efficiency}. 
     1344 
     1345The three-dimensional distribution of the energy available for mixing, $\epsilon(i,j,k)$, is constructed  
     1346from three static maps of column-integrated internal wave energy dissipation, $E_{cri}(i,j)$,  
     1347$E_{pyc}(i,j)$, and $E_{bot}(i,j)$, combined to three corresponding vertical structures  
     1348(de Lavergne et al., in prep): 
     1349\begin{align*} 
     1350F_{cri}(i,j,k) &\propto e^{-h_{ab} / h_{cri} }\\ 
     1351F_{pyc}(i,j,k) &\propto N^{n\_p}\\ 
     1352F_{bot}(i,j,k) &\propto N^2 \, e^{- h_{wkb} / h_{bot} } 
     1353\end{align*}  
     1354In the above formula, $h_{ab}$ denotes the height above bottom,  
     1355$h_{wkb}$ denotes the WKB-stretched height above bottom, defined by 
     1356\begin{equation*} 
     1357h_{wkb} = H \, \frac{ \int_{-H}^{z} N \, dz' } { \int_{-H}^{\eta} N \, dz'  } \; , 
     1358\end{equation*} 
     1359The $n_p$ parameter (given by \np{nn\_zpyc} in \ngn{namzdf\_tmx\_new} namelist)  controls the stratification-dependence of the pycnocline-intensified dissipation.  
     1360It can take values of 1 (recommended) or 2. 
     1361Finally, the vertical structures $F_{cri}$ and $F_{bot}$ require the specification of  
     1362the decay scales $h_{cri}(i,j)$ and $h_{bot}(i,j)$, which are defined by two additional input maps.  
     1363$h_{cri}$ is related to the large-scale topography of the ocean (etopo2)  
     1364and $h_{bot}$ is a function of the energy flux $E_{bot}$, the characteristic horizontal scale of  
     1365the abyssal hill topography \citep{Goff_JGR2010} and the latitude. 
     1366 
     1367% ================================================================ 
     1368 
     1369 
     1370 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Chapters/Introduction.tex

    r4661 r6436  
    2424release 8.2, described in \citet{Madec1998}. This model has been used for a wide  
    2525range of applications, both regional or global, as a forced ocean model and as a  
    26 model coupled with the atmosphere. A complete list of references is found on the  
    27 \NEMO web site.  
     26model coupled with the sea-ice and/or the atmosphere.   
    2827 
    2928This manual is organised in as follows. Chapter~\ref{PE} presents the model basics,  
    3029$i.e.$ the equations and their assumptions, the vertical coordinates used, and the  
    3130subgrid scale physics. This part deals with the continuous equations of the model  
    32 (primitive equations, with potential temperature, salinity and an equation of state).  
     31(primitive equations, with temperature, salinity and an equation of seawater).  
    3332The equations are written in a curvilinear coordinate system, with a choice of vertical  
    3433coordinates ($z$ or $s$, with the rescaled height coordinate formulation \textit{z*}, or   
     
    7978space and time variable coefficient \citet{Treguier1997}. The model has vertical harmonic  
    8079viscosity and diffusion with a space and time variable coefficient, with options to compute  
    81 the coefficients with \citet{Blanke1993}, \citet{Large_al_RG94}, \citet{Pacanowski_Philander_JPO81},  
     80the coefficients with \citet{Blanke1993}, \citet{Pacanowski_Philander_JPO81},  
    8281or \citet{Umlauf_Burchard_JMS03} mixing schemes. 
    8382 \vspace{1cm} 
    8483  
    85   
     84%%gm    To be put somewhere else .... 
     85 
    8686\noindent CPP keys and namelists are used for inputs to the code.  \newline 
    8787 
     
    112112 \vspace{1cm} 
    113113 
     114%%gm  end 
    114115 
    115116Model outputs management and specific online diagnostics are described in chapters~\ref{DIA}. 
     
    227228\item a deep re-writting and simplification of the off-line tracer component (OFF\_SRC) ;  
    228229\item the merge of passive and active advection and diffusion modules ; 
    229 \item  Use of the Flexible Configuration Manager (FCM) to build configurations, generate the Makefile and produce the executable ; 
     230\item Use of the Flexible Configuration Manager (FCM) to build configurations, generate the Makefile and produce the executable ; 
    230231\item Linear-tangent and Adjoint component (TAM) added, phased with v3.0 
    231232\end{enumerate} 
     
    249250 
    250251 
     252 \vspace{1cm} 
     253$\bullet$ The main modifications from NEMO/OPA v3.4 and  v3.6 are :\\ 
     254\begin{enumerate} 
     255\item I/O management: NEMO in now interfaced with XIOS, a Input/Output server having a versatile xml user interface, and  
     256allowing I/O to be performed on dedicated processors thus improving scalability and performance on massively parallel platforms.  
     257\item ICB module \citep{Marsh_GMD2015}: icebergs as lagrangian floats ;  
     258\item SAS: Stand Alone Surface module allowing testing of forcing set with bulk formulae, to run sea-ice models without ocean, to run ICB icebergs module alone, and to test AGRIF with sea-ice 
     259\item ISF : Under ice-selves cavities (parametrisation and/or explicit representation) 
     260\item Coupled interface for next IPCC requirements (multi category sea-ice, calving and iceberg module) 
     261\item Ocean and ice allowed to be explicitly coupled through OASIS, using StandAlone Surface module) 
     262\item On line coarsening of ocean I/O 
     263\item Major evolution of LIM3 sea-ice model \citep{Rousset_GMD2015} 
     264\item Open boundaries: completion of BDY/OBC merge : BDY is now the only Open boundary module available 
     265\item re-visit of the specification of heat/salt(tracers)/mass fluxes ; 
     266\item levitating or fully embedded sea-ice (for LIM and CICE) ; 
     267\item a new parameterization of mixing induced by breaking internal waves (de Lavergne et al. in prep.) 
     268And also: 
     269\item update of AGRIF package and AGRIF compatibility with LIM2 sea-ice model ; 
     270\item A new vertical sigma coordinate stretching function \citep{Siddorn_Furner_OM12} ; 
     271\item Smagorinsky eddy coefficients: the \cite{Griffies_Hallberg_MWR00} Smagorinsky type diffusivity/viscosity for lateral mixing has been introduced ; 
     272\item Standard Fox Kemper parametrisation 
     273\item Analytical tropical cyclones taken in account using track and magnitude observations (Vincent et al. JGR 2012a,b) ; 
     274\item OBS: observation operators improved and now available in Standalone mode ; 
     275\item Log layer option for bottom friction 
     276\item Faster split-explicit time stepping ;  
     277\item Z-tilde ALE coordinates \citep{Leclair_Madec_OM11} ;  
     278\item implicit bottom friction ; 
     279\item Runoff improved and SBC with BGC 
     280\item MPP assessment and optimisation 
     281\item First steps of wave coupling 
     282 
     283Features becoming obsolete: LIM2 (replaced by LIM3 monocategory) ; IOIPSL (replaced by XIOS) ;  
     284 
     285Features that has been removed : LOBSTER (now included in PISCES) ; OBC, replaced by BDY ;    
     286 
     287 
     288 
     289\end{enumerate} 
     290 
     291 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Namelist/nam_tide

    r4147 r6436  
    33!----------------------------------------------------------------------- 
    44   ln_tide_pot   = .true.   !  use tidal potential forcing 
    5    clname(1)     =   'M2'   !  name of constituent 
    6    clname(2)     =   'S2' 
    7    clname(3)     =   'N2' 
    8    clname(4)     =   'K1' 
    9    clname(5)     =   'O1' 
    10    clname(6)     =   'Q1' 
    11    clname(7)     =   'M4' 
    12    clname(8)     =   'K2' 
    13    clname(9)     =   'P1' 
    14    clname(10)    =   'Mf' 
    15    clname(11)    =   'Mm' 
     5   ln_tide_ramp  = .false.  ! 
     6   rdttideramp   =    0.    ! 
     7   clname(1)     = 'DUMMY'  !  name of constituent - all tidal components must be set in namelist_cfg 
    168/ 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Namelist/nambdy

    r4147 r6436  
    22&nambdy        !  unstructured open boundaries                          ("key_bdy") 
    33!----------------------------------------------------------------------- 
    4     nb_bdy = 1                            !  number of open boundary sets 
    5     ln_coords_file = .true.               !  =T : read bdy coordinates from file 
    6     cn_coords_file = 'coordinates.bdy.nc' !  bdy coordinates files 
    7     ln_mask_file = .false.                !  =T : read mask from file 
    8     cn_mask_file = ''                     !  name of mask file (if ln_mask_file=.TRUE.) 
    9     nn_dyn2d      =  2                    !  boundary conditions for barotropic fields 
    10     nn_dyn2d_dta  =  3                    !  = 0, bdy data are equal to the initial state 
    11                                           !  = 1, bdy data are read in 'bdydata   .nc' files 
    12                                           !  = 2, use tidal harmonic forcing data from files 
    13                                           !  = 3, use external data AND tidal harmonic forcing 
    14     nn_dyn3d      =  0                    !  boundary conditions for baroclinic velocities 
    15     nn_dyn3d_dta  =  0                    !  = 0, bdy data are equal to the initial state 
    16                            !  = 1, bdy data are read in 'bdydata   .nc' files 
    17     nn_tra        =  1                    !  boundary conditions for T and S 
    18     nn_tra_dta    =  1                    !  = 0, bdy data are equal to the initial state 
    19                            !  = 1, bdy data are read in 'bdydata   .nc' files 
    20     nn_rimwidth  = 10                      !  width of the relaxation zone 
    21     ln_vol     = .false.                  !  total volume correction (see nn_volctl parameter) 
    22     nn_volctl  = 1                        !  = 0, the total water flux across open boundaries is zero 
     4    nb_bdy = 2                               !  number of open boundary sets        
     5    ln_coords_file = .true.,.false.          !  =T : read bdy coordinates from file 
     6    cn_coords_file = 'coordinates.bdy.nc','' !  bdy coordinates files 
     7    ln_mask_file = .false.                   !  =T : read mask from file 
     8    cn_mask_file = ''                        !  name of mask file (if ln_mask_file=.TRUE.) 
     9    cn_dyn2d       = 'none','none'           ! 
     10    nn_dyn2d      =  2, 0                    !  boundary conditions for barotropic fields 
     11    nn_dyn2d_dta  =  3, 0                    !  = 0, bdy data are equal to the initial state 
     12                                             !  = 1, bdy data are read in 'bdydata   .nc' files 
     13                                             !  = 2, use tidal harmonic forcing data from files 
     14                                             !  = 3, use external data AND tidal harmonic forcing 
     15    cn_dyn3d      =  'none',' none'          ! 
     16    nn_dyn3d      =  0, 0                    !  boundary conditions for baroclinic velocities 
     17    nn_dyn3d_dta  =  0, 0                    !  = 0, bdy data are equal to the initial state 
     18                                             !  = 1, bdy data are read in 'bdydata   .nc' files 
     19    cn_tra        =  'none', 'none'          ! 
     20    nn_tra_dta    =  1, 1                    !  = 0, bdy data are equal to the initial state 
     21                                             !  = 1, bdy data are read in 'bdydata   .nc' files 
     22    cn_ice_lim      =  'none','none'         ! 
     23    nn_ice_lim_dta  =  0, 0                  !  = 0, bdy data are equal to the initial state 
     24                                             !  = 1, bdy data are read in 'bdydata   .nc' files 
     25    rn_ice_tem      = 270., 270.             !  lim3 only: arbitrary temperature of incoming sea ice 
     26    rn_ice_sal      = 10.,  10.              !  lim3 only:      --   salinity           -- 
     27    rn_ice_age      = 30., 30.               !  lim3 only:      --   age                -- 
     28    ln_tra_dmp    = .false.,.false.          !  open boudaries conditions for tracers 
     29    ln_dyn3d_dmp  = .false.,.false.          !  open boundary condition for baroclinic velocities 
     30    rn_time_dmp   =  1., 1.                  ! Damping time scale in days 
     31    rn_time_dmp_out =  1., 1.                ! Outflow damping time scale 
     32    nn_rimwidth  = 10, 5                     !  width of the relaxation zone 
     33    ln_vol     = .false.                     !  total volume correction (see nn_volctl parameter) 
     34    nn_volctl  = 1                           !  = 0, the total water flux across open boundaries is zero 
    2335/ 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Namelist/nambdy_dta

    r4230 r6436  
    22&nambdy_dta      !  open boundaries - external data           ("key_bdy") 
    33!----------------------------------------------------------------------- 
    4 !              !   file name    ! frequency (hours) !  variable  ! time interpol. !  clim   ! 'yearly'/ ! weights  ! rotation ! land/sea mask ! 
    5 !              !                !  (if <0  months)  !    name    !    (logical)   !  (T/F)  ! 'monthly' ! filename ! pairing  ! filename      ! 
    6    bn_ssh =     'amm12_bdyT_u2d' ,         24        , 'sossheig' ,     .true.     , .false. ,  'daily'  ,    ''    ,   ''    , '' 
    7    bn_u2d =     'amm12_bdyU_u2d' ,         24        , 'vobtcrtx' ,     .true.     , .false. ,  'daily'  ,    ''    ,   ''    , '' 
    8    bn_v2d =     'amm12_bdyV_u2d' ,         24        , 'vobtcrty' ,     .true.     , .false. ,  'daily'  ,    ''    ,   ''    , '' 
    9    bn_u3d  =    'amm12_bdyU_u3d' ,         24        , 'vozocrtx' ,     .true.     , .false. ,  'daily'  ,    ''    ,   ''    , '' 
    10    bn_v3d  =    'amm12_bdyV_u3d' ,         24        , 'vomecrty' ,     .true.     , .false. ,  'daily'  ,    ''    ,   ''    , '' 
    11    bn_tem  =    'amm12_bdyT_tra' ,         24        , 'votemper' ,     .true.     , .false. ,  'daily'  ,    ''    ,   ''    , '' 
    12    bn_sal  =    'amm12_bdyT_tra' ,         24        , 'vosaline' ,     .true.     , .false. ,  'daily'  ,    ''    ,   ''    , '' 
     4!              !  file name      ! frequency (hours) ! variable   ! time interp.   !  clim   ! 'yearly'/ ! weights  ! rotation ! land/sea mask ! 
     5!              !                 !  (if <0  months)  !   name     !   (logical)    !  (T/F ) ! 'monthly' ! filename ! pairing  ! filename      ! 
     6   bn_ssh =     'amm12_bdyT_u2d' ,         24        , 'sossheig' ,     .true.     , .false. ,  'daily'  ,    ''    ,   ''     , '' 
     7   bn_u2d =     'amm12_bdyU_u2d' ,         24        , 'vobtcrtx' ,     .true.     , .false. ,  'daily'  ,    ''    ,   ''     , '' 
     8   bn_v2d =     'amm12_bdyV_u2d' ,         24        , 'vobtcrty' ,     .true.     , .false. ,  'daily'  ,    ''    ,   ''     , '' 
     9   bn_u3d  =    'amm12_bdyU_u3d' ,         24        , 'vozocrtx' ,     .true.     , .false. ,  'daily'  ,    ''    ,   ''     , '' 
     10   bn_v3d  =    'amm12_bdyV_u3d' ,         24        , 'vomecrty' ,     .true.     , .false. ,  'daily'  ,    ''    ,   ''     , '' 
     11   bn_tem  =    'amm12_bdyT_tra' ,         24        , 'votemper' ,     .true.     , .false. ,  'daily'  ,    ''    ,   ''     , '' 
     12   bn_sal  =    'amm12_bdyT_tra' ,         24        , 'vosaline' ,     .true.     , .false. ,  'daily'  ,    ''    ,   ''     , '' 
     13! for lim2 
     14!   bn_frld  =    'amm12_bdyT_ice' ,         24        , 'ileadfra' ,     .true.     , .false. ,  'daily'  ,    ''    ,   ''     , '' 
     15!   bn_hicif =    'amm12_bdyT_ice' ,         24        , 'iicethic' ,     .true.     , .false. ,  'daily'  ,    ''    ,   ''     , '' 
     16!   bn_hsnif =    'amm12_bdyT_ice' ,         24        , 'isnowthi' ,     .true.     , .false. ,  'daily'  ,    ''    ,   ''     , '' 
     17! for lim3 
     18!   bn_a_i  =    'amm12_bdyT_ice' ,         24        , 'ileadfra' ,     .true.     , .false. ,  'daily'  ,    ''    ,   ''     , '' 
     19!   bn_ht_i =    'amm12_bdyT_ice' ,         24        , 'iicethic' ,     .true.     , .false. ,  'daily'  ,    ''    ,   ''     , '' 
     20!   bn_ht_s =    'amm12_bdyT_ice' ,         24        , 'isnowthi' ,     .true.     , .false. ,  'daily'  ,    ''    ,   ''     , '' 
    1321   cn_dir  =    'bdydta/' 
    1422   ln_full_vel = .false. 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Namelist/namberg

    r4230 r6436  
    99                                                      ! Initial mass required for an iceberg of each class 
    1010      rn_initial_mass          = 8.8e7, 4.1e8, 3.3e9, 1.8e10, 3.8e10, 7.5e10, 1.2e11, 2.2e11, 3.9e11, 7.4e11 
    11                                                       ! Proportion of calving mass to apportion to each class   
     11                                                      ! Proportion of calving mass to apportion to each class 
    1212      rn_distribution          = 0.24, 0.12, 0.15, 0.18, 0.12, 0.07, 0.03, 0.03, 0.03, 0.02 
    1313                                                      ! Ratio between effective and real iceberg mass (non-dim) 
    14                                                       ! i.e. number of icebergs represented at a point          
     14                                                      ! i.e. number of icebergs represented at a point 
    1515      rn_mass_scaling          = 2000, 200, 50, 20, 10, 5, 2, 1, 1, 1 
    1616                                                      ! thickness of newly calved bergs (m) 
     
    2121      rn_bits_erosion_fraction = 0.                   ! Fraction of erosion melt flux to divert to bergy bits 
    2222      rn_sicn_shift            = 0.                   ! Shift of sea-ice concn in erosion flux (0<sicn_shift<1) 
    23       ln_passive_mode          = .false.              ! iceberg - ocean decoupling    
     23      ln_passive_mode          = .false.              ! iceberg - ocean decoupling 
    2424      nn_test_icebergs         =  10                  ! Create test icebergs of this class (-1 = no) 
    2525                                                      ! Put a test iceberg at each gridpoint in box (lon1,lon2,lat1,lat2) 
    2626      rn_test_box              = 108.0,  116.0, -66.0, -58.0 
    27       rn_speed_limit           = 0.                   ! CFL speed limit for a berg    
     27      rn_speed_limit           = 0.                   ! CFL speed limit for a berg 
    2828 
    29                ! filename ! freq (hours) ! variable ! time interp. ! clim  !'yearly' or ! weights  ! rotation ! land/sea mask ! 
    30                !          ! (<0  months) !   name   !  (logical)   ! (T/F) ! 'monthly' ! filename ! pairing  ! filename      ! 
    31       sn_icb =  'calving' ,     -1       , 'calvingmask',  .true.      , .true., 'yearly'   , ' '      , ' '  , '' 
    32     
    33       cn_dir = './'  
     29!              ! file name ! frequency (hours) !   variable   ! time interp.   !  clim   ! 'yearly'/ ! weights  ! rotation ! land/sea mask ! 
     30!              !           !  (if <0  months)  !     name     !   (logical)    !  (T/F ) ! 'monthly' ! filename ! pairing  ! filename      ! 
     31      sn_icb =  'calving' ,       -1           , 'calvingmask',  .true.        , .true.  , 'yearly'  , ''       , ''       , '' 
     32 
     33      cn_dir = './' 
    3434/ 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Namelist/namdom

    r4560 r6436  
    33!----------------------------------------------------------------------- 
    44   nn_bathy    =    1      !  compute (=0) or read (=1) the bathymetry file 
    5    nn_closea    =   0      !  remove (=0) or keep (=1) closed seas and lakes (ORCA) 
    6    nn_msh      =    0      !  create (=1) a mesh file or not (=0) 
     5   rn_bathy    =    0.     !  value of the bathymetry. if (=0) bottom flat at jpkm1 
     6   nn_closea   =    0      !  remove (=0) or keep (=1) closed seas and lakes (ORCA) 
     7   nn_msh      =    1      !  create (=1) a mesh file or not (=0) 
    78   rn_hmin     =   -3.     !  min depth of the ocean (>0) or min number of ocean level (<0) 
    89   rn_e3zps_min=   20.     !  partial step thickness is set larger than the minimum of 
     
    1617   rn_rdtmax   = 28800.          !  maximum time step on tracers (used if nn_acc=1) 
    1718   rn_rdth     =  800.           !  depth variation of tracer time step  (used if nn_acc=1) 
     19   ln_crs      = .false.      !  Logical switch for coarsening module 
    1820   jphgr_msh   =       0               !  type of horizontal mesh 
    1921                                       !  = 0 curvilinear coordinate on the sphere read in coordinate.nc 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Namelist/namdyn_adv

    r3294 r6436  
    22&namdyn_adv    !   formulation of the momentum advection 
    33!----------------------------------------------------------------------- 
    4    ln_dynadv_vec = .true.  !  vector form (T) or flux form (F)   
     4   ln_dynadv_vec = .true.  !  vector form (T) or flux form (F) 
     5   nn_dynkeg     = 0       ! scheme for grad(KE): =0   C2  ;  =1   Hollingsworth correction 
    56   ln_dynadv_cen2= .false. !  flux form - 2nd order centered scheme 
    6    ln_dynadv_ubs = .false. !  flux form - 3rd order UBS      scheme  
    7  
     7   ln_dynadv_ubs = .false. !  flux form - 3rd order UBS      scheme 
     8   ln_dynzad_zts = .false. !  Use (T) sub timestepping for vertical momentum advection 
     9/ 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Namelist/namdyn_hpg

    r5120 r6436  
    55   ln_hpg_zps  = .true.    !  z-coordinate - partial steps (interpolation) 
    66   ln_hpg_sco  = .false.   !  s-coordinate (standard jacobian formulation) 
    7    ln_hpg_isf  = .false.   !  s-coordinate (sco ) adapted to ice shelf cavity 
     7   ln_hpg_isf  = .false.   !  s-coordinate (sco ) adapted to isf 
    88   ln_hpg_djc  = .false.   !  s-coordinate (Density Jacobian with Cubic polynomial) 
    99   ln_hpg_prj  = .false.   !  s-coordinate (Pressure Jacobian scheme) 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Namelist/namdyn_vor

    r4147 r6436  
    66   ln_dynvor_mix = .false. !  mixed scheme 
    77   ln_dynvor_een = .true.  !  energy & enstrophy scheme 
     8   ln_dynvor_een_old = .false.  !  energy & enstrophy scheme - original formulation 
    89/ 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Namelist/nameos

    r3294 r6436  
    22&nameos        !   ocean physical parameters 
    33!----------------------------------------------------------------------- 
    4    nn_eos      =   0       !  type of equation of state and Brunt-Vaisala frequency 
    5                            !     = 0, UNESCO (formulation of Jackett and McDougall (1994) and of McDougall (1987) ) 
    6                            !     = 1, linear: rho(T)   = rau0 * ( 1.028 - ralpha * T ) 
    7                            !     = 2, linear: rho(T,S) = rau0 * ( rbeta * S - ralpha * T ) 
    8    rn_alpha    =   2.0e-4  !  thermal expension coefficient (nn_eos= 1 or 2) 
    9    rn_beta     =   7.7e-4  !  saline  expension coefficient (nn_eos= 2) 
     4   nn_eos      =  -1     !  type of equation of state and Brunt-Vaisala frequency 
     5                                 !  =-1, TEOS-10 
     6                                 !  = 0, EOS-80 
     7                                 !  = 1, S-EOS   (simplified eos) 
     8   ln_useCT    = .true.  ! use of Conservative Temp. ==> surface CT converted in Pot. Temp. in sbcssm 
     9   !                             ! 
     10   !                     ! S-EOS coefficients : 
     11   !                             !  rd(T,S,Z)*rau0 = -a0*(1+.5*lambda*dT+mu*Z+nu*dS)*dT+b0*dS 
     12   rn_a0       =  1.6550e-1      !  thermal expension coefficient (nn_eos= 1) 
     13   rn_b0       =  7.6554e-1      !  saline  expension coefficient (nn_eos= 1) 
     14   rn_lambda1  =  5.9520e-2      !  cabbeling coeff in T^2  (=0 for linear eos) 
     15   rn_lambda2  =  7.4914e-4      !  cabbeling coeff in S^2  (=0 for linear eos) 
     16   rn_mu1      =  1.4970e-4      !  thermobaric coeff. in T (=0 for linear eos) 
     17   rn_mu2      =  1.1090e-5      !  thermobaric coeff. in S (=0 for linear eos) 
     18   rn_nu       =  2.4341e-3      !  cabbeling coeff in T*S  (=0 for linear eos) 
    1019/ 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Namelist/namhsb

    r2540 r6436  
    11!----------------------------------------------------------------------- 
    2 &namhsb       !  Heat and salt budgets  
     2&namhsb       !  Heat and salt budgets 
    33!----------------------------------------------------------------------- 
    44   ln_diahsb  = .false.    !  check the heat and salt budgets (T) or not (F) 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Namelist/namobs

    r4147 r6436  
    55   ln_s3d     = .false.    ! Logical switch for S profile observations 
    66   ln_ena     = .false.    ! Logical switch for ENACT insitu data set 
    7    !                       !     ln_cor                  Logical switch for Coriolis insitu data set 
     7   ln_cor     = .false.    ! Logical switch for Coriolis insitu data set 
    88   ln_profb   = .false.    ! Logical switch for feedback insitu data set 
    99   ln_sla     = .false.    ! Logical switch for SLA observations 
    10  
    1110   ln_sladt   = .false.    ! Logical switch for AVISO SLA data 
    12  
    1311   ln_slafb   = .false.    ! Logical switch for feedback SLA data 
    14                            !     ln_ssh                  Logical switch for SSH observations 
    15  
    16    ln_sst     = .true.     ! Logical switch for SST observations 
    17    ln_reysst  = .true.     !     ln_reysst               Logical switch for Reynolds observations 
    18    ln_ghrsst  = .false.    !     ln_ghrsst               Logical switch for GHRSST observations       
    19  
     12   ln_ssh     = .false.    ! Logical switch for SSH observations 
     13   ln_sst     = .false.    ! Logical switch for SST observations 
     14   ln_reysst  = .false.    ! Logical switch for Reynolds observations 
     15   ln_ghrsst  = .false.    ! Logical switch for GHRSST observations 
    2016   ln_sstfb   = .false.    ! Logical switch for feedback SST data 
    21                            !     ln_sss                  Logical switch for SSS observations 
    22                            !     ln_seaice               Logical switch for Sea Ice observations 
    23                            !     ln_vel3d                Logical switch for velocity observations 
    24                            !     ln_velavcur             Logical switch for velocity daily av. cur. 
    25                            !     ln_velhrcur             Logical switch for velocity high freq. cur. 
    26                            !     ln_velavadcp            Logical switch for velocity daily av. ADCP 
    27                            !     ln_velhradcp            Logical switch for velocity high freq. ADCP 
    28                            !     ln_velfb                Logical switch for feedback velocity data 
    29                            !     ln_grid_global          Global distribtion of observations 
    30                            !     ln_grid_search_lookup   Logical switch for obs grid search w/lookup table 
    31                            !     grid_search_file        Grid search lookup file header 
    32                            !     enactfiles              ENACT input observation file names 
    33                            !     coriofiles              Coriolis input observation file name 
    34    !                       ! profbfiles: Profile feedback input observation file name 
    35    profbfiles = 'profiles_01.nc' 
    36                            !     ln_profb_enatim         Enact feedback input time setting switch 
    37                            !     slafilesact             Active SLA input observation file name 
    38                            !     slafilespas             Passive SLA input observation file name 
    39    !                       ! slafbfiles: Feedback SLA input observation file name 
    40    slafbfiles = 'sla_01.nc' 
    41                            !     sstfiles                GHRSST input observation file name 
    42    !                       ! sstfbfiles: Feedback SST input observation file name 
    43    sstfbfiles = 'sst_01.nc' 'sst_02.nc' 'sst_03.nc' 'sst_04.nc' 'sst_05.nc' 
    44                            !     seaicefiles             Sea Ice input observation file name 
    45                            !     velavcurfiles           Vel. cur. daily av. input file name 
    46                            !     velhvcurfiles           Vel. cur. high freq. input file name 
    47                            !     velavadcpfiles          Vel. ADCP daily av. input file name 
    48                            !     velhvadcpfiles          Vel. ADCP high freq. input file name 
    49                            !     velfbfiles              Vel. feedback input observation file name 
    50                            !     dobsini                 Initial date in window YYYYMMDD.HHMMSS 
    51                            !     dobsend                 Final date in window YYYYMMDD.HHMMSS 
    52                            !     n1dint                  Type of vertical interpolation method 
    53                            !     n2dint                  Type of horizontal interpolation method 
    54                            !     ln_nea                  Rejection of observations near land switch 
    55    nmsshc     = 0          ! MSSH correction scheme 
    56                            !     mdtcorr                 MDT  correction 
    57                            !     mdtcutoff               MDT cutoff for computed correction 
     17   ln_sss     = .false.    ! Logical switch for SSS observations 
     18   ln_seaice  = .false.    ! Logical switch for Sea Ice observations 
     19   ln_vel3d   = .false.    ! Logical switch for velocity observations 
     20   ln_velavcur= .false     ! Logical switch for velocity daily av. cur. 
     21   ln_velhrcur= .false     ! Logical switch for velocity high freq. cur. 
     22   ln_velavadcp = .false.  ! Logical switch for velocity daily av. ADCP 
     23   ln_velhradcp = .false.  ! Logical switch for velocity high freq. ADCP 
     24   ln_velfb   = .false.    ! Logical switch for feedback velocity data 
     25   ln_grid_global = .false. ! Global distribtion of observations 
     26   ln_grid_search_lookup = .false. !  Logical switch for obs grid search w/lookup table 
     27   grid_search_file = 'grid_search'  !  Grid search lookup file header 
     28! All of the *files* variables below are arrays. Use namelist_cfg to add more files 
     29   enactfiles = 'enact.nc' !  ENACT input observation file names (specify full array in namelist_cfg) 
     30   coriofiles = 'corio.nc' !  Coriolis input observation file name 
     31   profbfiles = 'profiles_01.nc' ! Profile feedback input observation file name 
     32   ln_profb_enatim = .false !        Enact feedback input time setting switch 
     33   slafilesact = 'sla_act.nc' !  Active SLA input observation file names 
     34   slafilespas = 'sla_pass.nc' ! Passive SLA input observation file names 
     35   slafbfiles = 'sla_01.nc' ! slafbfiles: Feedback SLA input observation file names 
     36   sstfiles = 'ghrsst.nc'   ! GHRSST input observation file names 
     37   sstfbfiles = 'sst_01.nc' ! Feedback SST input observation file names 
     38   seaicefiles = 'seaice_01.nc' ! Sea Ice input observation file names 
     39   velavcurfiles = 'velavcurfile.nc'  ! Vel. cur. daily av. input file name 
     40   velhrcurfiles = 'velhrcurfile.nc'  ! Vel. cur. high freq. input file name 
     41   velavadcpfiles = 'velavadcpfile.nc' ! Vel. ADCP daily av. input file name 
     42   velhradcpfiles = 'velhradcpfile.nc' ! Vel. ADCP high freq. input file name 
     43   velfbfiles = 'velfbfile.nc' ! Vel. feedback input observation file name 
     44   dobsini = 20000101.000000  !  Initial date in window YYYYMMDD.HHMMSS 
     45   dobsend = 20010101.000000  !  Final date in window YYYYMMDD.HHMMSS 
     46   n1dint = 0  !               Type of vertical interpolation method 
     47   n2dint = 0  !               Type of horizontal interpolation method 
     48   ln_nea = .false.   !        Rejection of observations near land switch 
     49   nmsshc     = 0     !        MSSH correction scheme 
     50   mdtcorr = 1.61     !        MDT  correction 
     51   mdtcutoff = 65.0   !        MDT cutoff for computed correction 
    5852   ln_altbias = .false.    ! Logical switch for alt bias 
    5953   ln_ignmis  = .true.     ! Logical switch for ignoring missing files 
    60                            !     endailyavtypes   ENACT daily average types 
     54   endailyavtypes = 820    ! ENACT daily average types - array (use namelist_cfg to set more values) 
    6155   ln_grid_global = .true. 
    6256   ln_grid_search_lookup = .false. 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Namelist/namptr

    r4147 r6436  
    33!----------------------------------------------------------------------- 
    44   ln_diaptr  = .false.    !  Poleward heat and salt transport (T) or not (F) 
    5    ln_diaznl  = .true.     !  Add zonal means and meridional stream functions 
    6    ln_subbas  = .true.     !  Atlantic/Pacific/Indian basins computation (T) or not 
    7                            !  (orca configuration only, need input basins mask file named "subbasins.nc" 
    8    ln_ptrcomp = .true.     !  Add decomposition : overturning 
    9    nn_fptr    =  1         !  Frequency of ptr computation [time step] 
    10    nn_fwri    =  15        !  Frequency of ptr outputs [time step] 
     5   ln_subbas  = .false.     !  Atlantic/Pacific/Indian basins computation (T) or not 
    116/ 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Namelist/namrun

    r4147 r6436  
    99   nn_leapy    =       0   !  Leap year calendar (1) or not (0) 
    1010   ln_rstart   = .false.   !  start from rest (F) or from a restart file (T) 
    11    nn_rstctl   =       0   !  restart control => activated only if ln_rstart = T 
     11   nn_euler    =       1   !  = 0 : start with forward time step if ln_rstart=T 
     12   nn_rstctl   =       0   !  restart control ==> activated only if ln_rstart=T 
    1213                           !    = 0 nn_date0 read in namelist ; nn_it000 : read in namelist 
    1314                           !    = 1 nn_date0 read in namelist ; nn_it000 : check consistancy between namelist and restart 
    1415                           !    = 2 nn_date0 read in restart  ; nn_it000 : check consistancy between namelist and restart 
    1516   cn_ocerst_in  = "restart"   !  suffix of ocean restart name (input) 
     17   cn_ocerst_indir = "."       !  directory from which to read input ocean restarts 
    1618   cn_ocerst_out = "restart"   !  suffix of ocean restart name (output) 
     19   cn_ocerst_outdir = "."      !  directory in which to write output ocean restarts 
    1720   nn_istate   =       0   !  output the initial state (1) or not (0) 
     21   ln_rst_list = .false.   !  output restarts at list of times using nn_stocklist (T) or at set frequency with nn_stock (F) 
    1822   nn_stock    =    5475   !  frequency of creation of a restart file (modulo referenced to 1) 
     23   nn_stocklist = 0,0,0,0,0,0,0,0,0,0 ! List of timesteps when a restart file is to be written 
    1924   nn_write    =    5475   !  frequency of write in the output file   (modulo referenced to nn_it000) 
    2025   ln_dimgnnn  = .false.   !  DIMG file format: 1 file for all processors (F) or by processor (T) 
    2126   ln_mskland  = .false.   !  mask land points in NetCDF outputs (costly: + ~15%) 
     27   ln_cfmeta   = .false.   !  output additional data to netCDF files required for compliance with the CF metadata standard 
    2228   ln_clobber  = .false.   !  clobber (overwrite) an existing file 
    2329   nn_chunksz  =       0   !  chunksize (bytes) for NetCDF file (works only with iom_nf90 routines) 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Namelist/namsbc

    r5120 r6436  
    99   ln_blk_core = .true.    !  CORE bulk formulation                     (T => fill namsbc_core) 
    1010   ln_blk_mfs  = .false.   !  MFS bulk formulation                      (T => fill namsbc_mfs ) 
    11    ln_cpl      = .false.   !  Coupled formulation                       (T => fill namsbc_cpl ) 
     11   ln_cpl      = .false.   !  atmosphere coupled   formulation          ( requires key_oasis3 ) 
     12   ln_mixcpl   = .false.   !  forced-coupled mixed formulation          ( requires key_oasis3 ) 
     13   nn_components = 0       !  configuration of the opa-sas OASIS coupling 
     14                           !  =0 no opa-sas OASIS coupling: default single executable configuration 
     15                           !  =1 opa-sas OASIS coupling: multi executable configuration, OPA component 
     16                           !  =2 opa-sas OASIS coupling: multi executable configuration, SAS component  
    1217   ln_apr_dyn  = .false.   !  Patm gradient added in ocean & ice Eqs.   (T => fill namsbc_apr ) 
    1318   nn_ice      = 2         !  =0 no ice boundary condition   , 
    1419                           !  =1 use observed ice-cover      , 
    15                            !  =2 ice-model used                         ("key_lim3" or "key_lim2) 
    16    nn_ice_embd = 0         !  =0 levitating ice (no mass exchange, concentration/dilution effect) 
     20                           !  =2 ice-model used                         ("key_lim3" or "key_lim2") 
     21   nn_ice_embd = 1         !  =0 levitating ice (no mass exchange, concentration/dilution effect) 
    1722                           !  =1 levitating ice with mass and salt exchange but no presure effect 
    1823                           !  =2 embedded sea-ice (full salt and mass exchanges and pressure) 
    1924   ln_dm2dc    = .false.   !  daily mean to diurnal cycle on short wave 
    20    ln_rnf      = .true.    !  runoffs                                   (T => fill namsbc_rnf) 
     25   ln_rnf      = .true.    !  runoffs                                   (T   => fill namsbc_rnf) 
    2126   nn_isf      = 0         !  ice shelf melting/freezing                (/=0 => fill namsbc_isf) 
    2227                           !  0 =no isf                  1 = presence of ISF 
     
    2530                           !  option 1 and 4 need ln_isfcav = .true. (domzgr) 
    2631   ln_ssr      = .true.    !  Sea Surface Restoring on T and/or S       (T => fill namsbc_ssr) 
    27    nn_fwb      = 3         !  FreshWater Budget: =0 unchecked 
     32   nn_fwb      = 2         !  FreshWater Budget: =0 unchecked 
    2833                           !     =1 global mean of e-p-r set to zero at each time step 
    2934                           !     =2 annual global mean of e-p-r set to zero 
    30                            !     =3 global emp set to zero and spread out over erp area 
    3135   ln_wave = .false.       !  Activate coupling with wave (either Stokes Drift or Drag coefficient, or both)  (T => fill namsbc_wave) 
    3236   ln_cdgw = .false.       !  Neutral drag coefficient read from wave model (T => fill namsbc_wave) 
    3337   ln_sdw  = .false.       !  Computation of 3D stokes drift                (T => fill namsbc_wave) 
    34    nn_lsm  = 0             !  =0   land/sea mask for input fields is not applied (the field land/sea mask filename 
    35                            !       is left empty in namelist)  , 
    36                            !  =1:n number of iterations of land/sea mask application for input fields 
     38   nn_lsm  = 0             !  =0 land/sea mask for input fields is not applied (keep empty land/sea mask filename field) , 
     39                           !  =1:n number of iterations of land/sea mask application for input fields (fill land/sea mask filename field) 
     40   nn_limflx = -1          !  LIM3 Multi-category heat flux formulation (use -1 if LIM3 is not used) 
     41                           !  =-1  Use per-category fluxes, bypass redistributor, forced mode only, not yet implemented coupled 
     42                           !  = 0  Average per-category fluxes (forced and coupled mode) 
     43                           !  = 1  Average and redistribute per-category fluxes, forced mode only, not yet implemented coupled 
     44                           !  = 2  Redistribute a single flux over categories (coupled mode only) 
    3745/ 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Namelist/namsbc_alb

    r4147 r6436  
    22&namsbc_alb    !   albedo parameters 
    33!----------------------------------------------------------------------- 
    4    rn_cloud    =    0.06   !  cloud correction to snow and ice albedo 
    5    rn_albice   =    0.53   !  albedo of melting ice in the arctic and antarctic 
    6    rn_alphd    =    0.80   !  coefficients for linear interpolation used to 
    7    rn_alphc    =    0.65   !  compute albedo between two extremes values 
    8    rn_alphdi   =    0.72   !  (Pyane, 1972) 
     4   nn_ice_alb  =    0   !  parameterization of ice/snow albedo 
     5                        !     0: Shine & Henderson-Sellers (JGR 1985) 
     6                        !     1: "home made" based on Brandt et al. (J. Climate 2005) 
     7                        !                         and Grenfell & Perovich (JGR 2004) 
     8   rn_albice   =  0.53  !  albedo of bare puddled ice (values from 0.49 to 0.58) 
     9                        !     0.53 (default) => if nn_ice_alb=0 
     10                        !     0.50 (default) => if nn_ice_alb=1 
    911/ 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Namelist/namsbc_apr

    r4230 r6436  
    22&namsbc_apr    !   Atmospheric pressure used as ocean forcing or in bulk 
    33!----------------------------------------------------------------------- 
    4 !              ! file name ! frequency (hours) ! variable ! time interpol. !  clim   ! 'yearly'/ ! weights  ! rotation ! land/sea mask ! 
    5 !              !           !  (if <0  months)  !   name   !    (logical)   !  (T/F) ! 'monthly' ! filename ! pairing  ! filename      ! 
    6    sn_apr      = 'patm'    ,         -1        ,'somslpre',    .true.      , .true. , 'yearly'  ,  ''      ,   ''     , '' 
     4!              !  file name  ! frequency (hours) ! variable  ! time interp. !  clim  ! 'yearly'/ ! weights  ! rotation ! land/sea mask ! 
     5!              !             !  (if <0  months)  !   name    !   (logical)  !  (T/F) ! 'monthly' ! filename ! pairing  ! filename      ! 
     6   sn_apr      = 'patm'      ,         -1        ,'somslpre',    .true.     , .true. , 'yearly'  ,  ''      ,   ''     , '' 
    77 
    88   cn_dir      = './'       !  root directory for the location of the bulk files 
    9    rn_pref     = 101000._wp !  reference atmospheric pressure   [N/m2]/ 
     9   rn_pref     = 101000.    !  reference atmospheric pressure   [N/m2]/ 
    1010   ln_ref_apr  = .false.    !  ref. pressure: global mean Patm (T) or a constant (F) 
    1111   ln_apr_obc  = .false.    !  inverse barometer added to OBC ssh data 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Namelist/namsbc_core

    r4230 r6436  
    22&namsbc_core   !   namsbc_core  CORE bulk formulae 
    33!----------------------------------------------------------------------- 
    4 !              !  file name                    ! frequency (hours) ! variable  ! time interp. !  clim  ! 'yearly'/ ! weights  ! rotation ! land/sea mask ! 
    5 !              !                               !  (if <0  months)  !   name    !   (logical)  !  (T/F) ! 'monthly' ! filename ! pairing  !  filename     ! 
    6    sn_wndi     = 'u_10.15JUNE2009_orca2'       ,         6         , 'U_10_MOD',   .false.    , .true. , 'yearly'  , ''       , 'Uwnd'   , '' 
    7    sn_wndj     = 'v_10.15JUNE2009_orca2'       ,         6         , 'V_10_MOD',   .false.    , .true. , 'yearly'  , ''       , 'Vwnd'   , '' 
    8    sn_qsr      = 'ncar_rad.15JUNE2009_orca2'   ,        24         , 'SWDN_MOD',   .false.    , .true. , 'yearly'  , ''       , ''       , '' 
    9    sn_qlw      = 'ncar_rad.15JUNE2009_orca2'   ,        24         , 'LWDN_MOD',   .false.    , .true. , 'yearly'  , ''       , ''       , '' 
    10    sn_tair     = 't_10.15JUNE2009_orca2'       ,         6         , 'T_10_MOD',   .false.    , .true. , 'yearly'  , ''       , ''       , '' 
    11    sn_humi     = 'q_10.15JUNE2009_orca2'       ,         6         , 'Q_10_MOD',   .false.    , .true. , 'yearly'  , ''       , ''       , '' 
    12    sn_prec     = 'ncar_precip.15JUNE2009_orca2',        -1         , 'PRC_MOD1',   .false.    , .true. , 'yearly'  , ''       , ''       , '' 
    13    sn_snow     = 'ncar_precip.15JUNE2009_orca2',        -1         , 'SNOW'    ,   .false.    , .true. , 'yearly'  , ''       , ''       , '' 
    14    sn_tdif     = 'taudif_core'                 ,        24         , 'taudif'  ,   .false.    , .true. , 'yearly'  , ''       , ''       , '' 
    15 ! 
     4!              !  file name                    ! frequency (hours) ! variable  ! time interp. !  clim  ! 'yearly'/ ! weights                               ! rotation ! land/sea mask ! 
     5!              !                               !  (if <0  months)  !   name    !   (logical)  !  (T/F) ! 'monthly' ! filename                              ! pairing  ! filename      ! 
     6   sn_wndi     = 'u_10.15JUNE2009_fill'        ,         6         , 'U_10_MOD',   .false.    , .true. , 'yearly'  , 'weights_core_orca2_bicubic_noc.nc'   , 'Uwnd'   , '' 
     7   sn_wndj     = 'v_10.15JUNE2009_fill'        ,         6         , 'V_10_MOD',   .false.    , .true. , 'yearly'  , 'weights_core_orca2_bicubic_noc.nc'   , 'Vwnd'   , '' 
     8   sn_qsr      = 'ncar_rad.15JUNE2009_fill'    ,        24         , 'SWDN_MOD',   .false.    , .true. , 'yearly'  , 'weights_core_orca2_bilinear_noc.nc'  , ''       , '' 
     9   sn_qlw      = 'ncar_rad.15JUNE2009_fill'    ,        24         , 'LWDN_MOD',   .false.    , .true. , 'yearly'  , 'weights_core_orca2_bilinear_noc.nc'  , ''       , '' 
     10   sn_tair     = 't_10.15JUNE2009_fill'        ,         6         , 'T_10_MOD',   .false.    , .true. , 'yearly'  , 'weights_core_orca2_bilinear_noc.nc'  , ''       , '' 
     11   sn_humi     = 'q_10.15JUNE2009_fill'        ,         6         , 'Q_10_MOD',   .false.    , .true. , 'yearly'  , 'weights_core_orca2_bilinear_noc.nc'  , ''       , '' 
     12   sn_prec     = 'ncar_precip.15JUNE2009_fill' ,        -1         , 'PRC_MOD1',   .false.    , .true. , 'yearly'  , 'weights_core_orca2_bilinear_noc.nc'  , ''       , '' 
     13   sn_snow     = 'ncar_precip.15JUNE2009_fill' ,        -1         , 'SNOW'    ,   .false.    , .true. , 'yearly'  , 'weights_core_orca2_bilinear_noc.nc'  , ''       , '' 
     14   sn_tdif     = 'taudif_core'                 ,        24         , 'taudif'  ,   .false.    , .true. , 'yearly'  , 'weights_core_orca2_bilinear_noc.nc'  , ''       , '' 
     15 
    1616   cn_dir      = './'      !  root directory for the location of the bulk files 
    17    ln_2m       = .false.   !  air temperature and humidity referenced at 2m (T) instead 10m (F) 
    1817   ln_taudif   = .false.   !  HF tau contribution: use "mean of stress module - module of the mean stress" data 
     18   rn_zqt      = 10.        !  Air temperature and humidity reference height (m) 
     19   rn_zu       = 10.        !  Wind vector reference height (m) 
    1920   rn_pfac     = 1.        !  multiplicative factor for precipitation (total & snow) 
     21   rn_efac     = 1.        !  multiplicative factor for evaporation (0. or 1.) 
     22   rn_vfac     = 0.        !  multiplicative factor for ocean/ice velocity 
     23                           !  in the calculation of the wind stress (0.=absolute winds or 1.=relative winds) 
    2024/ 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Namelist/namsbc_cpl

    r4147 r6436  
    11!----------------------------------------------------------------------- 
    2 &namsbc_cpl    !   coupled ocean/atmosphere model                       ("key_coupled") 
     2&namsbc_cpl    !   coupled ocean/atmosphere model                       ("key_oasis3") 
    33!----------------------------------------------------------------------- 
    44!                    !     description       !  multiple  !    vector   !      vector          ! vector ! 
    55!                    !                       ! categories !  reference  !    orientation       ! grids  ! 
    66! send 
    7 sn_snd_temp   =       'weighted oce and ice' ,    'no'    ,     ''      ,         ''           ,   '' 
    8 sn_snd_alb    =       'weighted ice'         ,    'no'    ,     ''      ,         ''           ,   '' 
    9 sn_snd_thick  =       'none'                 ,    'no'   ,     ''      ,         ''           ,   '' 
    10 sn_snd_crt    =       'none'                 ,    'no'    , 'spherical' , 'eastward-northward' ,  'T' 
    11 sn_snd_co2    =       'coupled'              ,    'no'    ,     ''      ,         ''           ,   '' 
     7   sn_snd_temp   =       'weighted oce and ice' ,    'no'    ,     ''      ,         ''           ,   '' 
     8   sn_snd_alb    =       'weighted ice'         ,    'no'    ,     ''      ,         ''           ,   '' 
     9   sn_snd_thick  =       'none'                 ,    'no'   ,     ''      ,         ''           ,   '' 
     10   sn_snd_crt    =       'none'                 ,    'no'    , 'spherical' , 'eastward-northward' ,  'T' 
     11   sn_snd_co2    =       'coupled'              ,    'no'    ,     ''      ,         ''           ,   '' 
    1212! receive 
    13 sn_rcv_w10m   =       'none'                 ,    'no'    ,     ''      ,         ''          ,   '' 
    14 sn_rcv_taumod =       'coupled'              ,    'no'    ,     ''      ,         ''          ,   '' 
    15 sn_rcv_tau    =       'oce only'             ,    'no'    , 'cartesian' , 'eastward-northward',  'U,V' 
    16 sn_rcv_dqnsdt =       'coupled'              ,    'no'    ,     ''      ,         ''          ,   '' 
    17 sn_rcv_qsr    =       'oce and ice'          ,    'no'    ,     ''      ,         ''          ,   '' 
    18 sn_rcv_qns    =       'oce and ice'          ,    'no'    ,     ''      ,         ''          ,   '' 
    19 sn_rcv_emp    =       'conservative'         ,    'no'    ,     ''      ,         ''          ,   '' 
    20 sn_rcv_rnf    =       'coupled'              ,    'no'    ,     ''      ,         ''          ,   '' 
    21 sn_rcv_cal    =       'coupled'              ,    'no'    ,     ''      ,         ''          ,   '' 
    22 sn_rcv_co2    =       'coupled'              ,    'no'    ,     ''      ,         ''          ,   '' 
     13   sn_rcv_w10m   =       'none'                 ,    'no'    ,     ''      ,         ''          ,   '' 
     14   sn_rcv_taumod =       'coupled'              ,    'no'    ,     ''      ,         ''          ,   '' 
     15   sn_rcv_tau    =       'oce only'             ,    'no'    , 'cartesian' , 'eastward-northward',  'U,V' 
     16   sn_rcv_dqnsdt =       'coupled'              ,    'no'    ,     ''      ,         ''          ,   '' 
     17   sn_rcv_qsr    =       'oce and ice'          ,    'no'    ,     ''      ,         ''          ,   '' 
     18   sn_rcv_qns    =       'oce and ice'          ,    'no'    ,     ''      ,         ''          ,   '' 
     19   sn_rcv_emp    =       'conservative'         ,    'no'    ,     ''      ,         ''          ,   '' 
     20   sn_rcv_rnf    =       'coupled'              ,    'no'    ,     ''      ,         ''          ,   '' 
     21   sn_rcv_cal    =       'coupled'              ,    'no'    ,     ''      ,         ''          ,   '' 
     22   sn_rcv_co2    =       'coupled'              ,    'no'    ,     ''      ,         ''          ,   '' 
     23! 
     24   nn_cplmodel   =     1     !  Maximum number of models to/from which NEMO is potentialy sending/receiving data 
     25   ln_usecplmask = .false.   !  use a coupling mask file to merge data received from several models 
     26                             !   -> file cplmask.nc with the float variable called cplmask (jpi,jpj,nn_cplmodel) 
    2327/ 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Namelist/namsbc_mfs

    r4230 r6436  
    22&namsbc_mfs   !   namsbc_mfs  MFS bulk formulae 
    33!----------------------------------------------------------------------- 
    4 !              !  file name  ! frequency (hours) ! variable  ! time interp. !  clim  ! 'yearly'/ ! weights  ! rotation ! land/sea mask ! 
    5 !              !             !  (if <0  months)  !   name    !   (logical)  !  (T/F) ! 'monthly' ! filename ! pairing  ! filename      ! 
    6    sn_wndi     =   'ecmwf'   ,        6          , 'u10'     ,    .true.    , .false. , 'daily'  ,'bicubic.nc' , ''    , '' 
    7    sn_wndj     =   'ecmwf'   ,        6          , 'v10'     ,    .true.    , .false. , 'daily'  ,'bicubic.nc' , ''    , '' 
    8    sn_clc      =   'ecmwf'   ,        6          , 'clc'     ,    .true.    , .false. , 'daily'  ,'bilinear.nc', ''    , '' 
    9    sn_msl      =   'ecmwf'   ,        6          , 'msl'     ,    .true.    , .false. , 'daily'  ,'bicubic.nc' , ''    , '' 
    10    sn_tair     =   'ecmwf'   ,        6          , 't2'      ,    .true.    , .false. , 'daily'  ,'bicubic.nc' , ''    , '' 
    11    sn_rhm      =   'ecmwf'   ,        6          , 'rh'      ,    .true.    , .false. , 'daily'  ,'bilinear.nc', ''    , '' 
    12    sn_prec     =   'precip'  ,        6          , 'precip'  ,    .true.    , .false. , 'daily'  ,'bicubic'    , ''    , '' 
    13    cn_dir      =   './'      !  root directory for the location of the bulk files 
     4!              !  file name  ! frequency (hours) ! variable  ! time interp. !  clim  ! 'yearly'/ ! weights     ! rotation ! land/sea mask ! 
     5!              !             !  (if <0  months)  !   name    !   (logical)  !  (T/F) ! 'monthly' ! filename    ! pairing  ! filename      ! 
     6   sn_wndi     =   'ecmwf'   ,        6          , 'u10'     ,    .true.    , .false. , 'daily'  ,'bicubic.nc' , ''       , '' 
     7   sn_wndj     =   'ecmwf'   ,        6          , 'v10'     ,    .true.    , .false. , 'daily'  ,'bicubic.nc' , ''       , '' 
     8   sn_clc      =   'ecmwf'   ,        6          , 'clc'     ,    .true.    , .false. , 'daily'  ,'bilinear.nc', ''       , '' 
     9   sn_msl      =   'ecmwf'   ,        6          , 'msl'     ,    .true.    , .false. , 'daily'  ,'bicubic.nc' , ''       , '' 
     10   sn_tair     =   'ecmwf'   ,        6          , 't2'      ,    .true.    , .false. , 'daily'  ,'bicubic.nc' , ''       , '' 
     11   sn_rhm      =   'ecmwf'   ,        6          , 'rh'      ,    .true.    , .false. , 'daily'  ,'bilinear.nc', ''       , '' 
     12   sn_prec     =   'ecmwf'   ,        6          , 'precip'  ,    .true.    , .true.  , 'daily'  ,'bicubic.nc' , ''       , '' 
     13 
     14   cn_dir      = './ECMWF/'      !  root directory for the location of the bulk files 
    1415/ 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Namelist/namsbc_rnf

    r4230 r6436  
    22&namsbc_rnf    !   runoffs namelist surface boundary condition 
    33!----------------------------------------------------------------------- 
    4 !              !  file name  ! frequency (hours) ! variable  ! time interp. !  clim  ! 'yearly'/ ! weights  ! rotation ! land/sea mask ! 
    5 !              !             !  (if <0  months)  !   name    !   (logical)  !  (T/F) ! 'monthly' ! filename ! pairing  ! filename      ! 
    6    sn_rnf      = 'runoff_core_monthly',    -1    , 'sorunoff',   .true.     , .true. , 'yearly'  , ''       , ''       , '' 
    7    sn_cnf      = 'runoff_core_monthly',     0    , 'socoefr0',   .false.    , .true. , 'yearly'  , ''       , ''       , '' 
    8    sn_s_rnf    = 'runoffs'            ,    24    , 'rosaline',   .true.     , .true. , 'yearly'  , ''       , ''       , '' 
    9    sn_t_rnf    = 'runoffs'            ,    24    , 'rotemper',   .true.     , .true. , 'yearly'  , ''       , ''       , '' 
    10    sn_dep_rnf  = 'runoffs'            ,     0    , 'rodepth' ,   .false.    , .true. , 'yearly'  , ''       , ''       , '' 
     4!              !  file name           ! frequency (hours) ! variable  ! time interp. !  clim  ! 'yearly'/ ! weights  ! rotation ! land/sea mask ! 
     5!              !                      !  (if <0  months)  !   name    !   (logical)  !  (T/F) ! 'monthly' ! filename ! pairing  ! filename      ! 
     6   sn_rnf      = 'runoff_core_monthly',        -1         , 'sorunoff',   .true.     , .true. , 'yearly'  , ''       , ''       , '' 
     7   sn_cnf      = 'runoff_core_monthly',         0         , 'socoefr0',   .false.    , .true. , 'yearly'  , ''       , ''       , '' 
     8   sn_s_rnf    = 'runoffs'            ,        24         , 'rosaline',   .true.     , .true. , 'yearly'  , ''       , ''       , '' 
     9   sn_t_rnf    = 'runoffs'            ,        24         , 'rotemper',   .true.     , .true. , 'yearly'  , ''       , ''       , '' 
     10   sn_dep_rnf  = 'runoffs'            ,         0         , 'rodepth' ,   .false.    , .true. , 'yearly'  , ''       , ''       , '' 
    1111 
    1212   cn_dir       = './'      !  root directory for the location of the runoff files 
    13    ln_rnf_emp   = .false.   !  runoffs included into precipitation field (T) or into a file (F) 
    1413   ln_rnf_mouth = .true.    !  specific treatment at rivers mouths 
    1514   rn_hrnf      =  15.e0    !  depth over which enhanced vertical mixing is used 
     
    1918   ln_rnf_tem   = .false.   !  read in temperature information for runoff 
    2019   ln_rnf_sal   = .false.   !  read in salinity information for runoff 
     20   ln_rnf_depth_ini = .false.  ! compute depth at initialisation from runoff file 
     21   rn_rnf_max   = 5.735e-4  !  max value of the runoff climatologie over global domain ( ln_rnf_depth_ini = .true ) 
     22   rn_dep_max   = 150.      !  depth over which runoffs is spread ( ln_rnf_depth_ini = .true ) 
     23   nn_rnf_depth_file = 0    !  create (=1) a runoff depth file or not (=0) 
    2124/ 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Namelist/namsbc_sas

    r4230 r6436  
    44!              !  file name  ! frequency (hours) ! variable  ! time interp. !  clim  ! 'yearly'/ ! weights  ! rotation ! land/sea mask ! 
    55!              !             !  (if <0  months)  !   name    !   (logical)  !  (T/F) ! 'monthly' ! filename ! pairing  ! filename      ! 
    6    sn_usp      = 'sas_grid_U' ,    120    , 'vozocrtx' ,  .true.    , .true. ,   'yearly'  , ''       , ''             , '' 
    7    sn_vsp      = 'sas_grid_V' ,    120    , 'vomecrty' ,  .true.    , .true. ,   'yearly'  , ''       , ''             , '' 
    8    sn_tem      = 'sas_grid_T' ,    120    , 'sosstsst' ,  .true.    , .true. ,   'yearly'  , ''       , ''             , '' 
    9    sn_sal      = 'sas_grid_T' ,    120    , 'sosaline' ,  .true.    , .true. ,   'yearly'  , ''       , ''             , '' 
    10    sn_ssh      = 'sas_grid_T' ,    120    , 'sossheig' ,  .true.    , .true. ,   'yearly'  , ''       , ''             , '' 
     6   sn_usp      = 'sas_grid_U' ,    120           , 'vozocrtx' ,  .true.    , .true. ,   'yearly'  , ''       , ''             , '' 
     7   sn_vsp      = 'sas_grid_V' ,    120           , 'vomecrty' ,  .true.    , .true. ,   'yearly'  , ''       , ''             , '' 
     8   sn_tem      = 'sas_grid_T' ,    120           , 'sosstsst' ,  .true.    , .true. ,   'yearly'  , ''       , ''             , '' 
     9   sn_sal      = 'sas_grid_T' ,    120           , 'sosaline' ,  .true.    , .true. ,   'yearly'  , ''       , ''             , '' 
     10   sn_ssh      = 'sas_grid_T' ,    120           , 'sossheig' ,  .true.    , .true. ,   'yearly'  , ''       , ''             , '' 
     11   sn_e3t      = 'sas_grid_T' ,    120           , 'e3t_m'    ,  .true.    , .true. ,   'yearly'  , ''       , ''             , '' 
     12   sn_frq      = 'sas_grid_T' ,    120           , 'frq_m'    ,  .true.    , .true. ,   'yearly'  , ''       , ''             , '' 
    1113 
    12    ln_3d_uv    = .true.    !  specify whether we are supplying a 3D u,v field 
     14   ln_3d_uve   = .true.    !  specify whether we are supplying a 3D u,v and e3 field 
     15   ln_read_frq = .false.    !  specify whether we must read frq or not 
    1316   cn_dir      = './'      !  root directory for the location of the bulk files are 
    1417/ 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Namelist/namsbc_wave

    r4230 r6436  
    22&namsbc_wave   ! External fields from wave model 
    33!----------------------------------------------------------------------- 
    4 !              !  file name  ! frequency (hours) ! variable  ! time interp. !  clim  ! 'yearly'/ ! weights  ! rotation ! land/sea mask ! 
    5 !              !             !  (if <0  months)  !   name    !   (logical)  !  (T/F) ! 'monthly' ! filename ! pairing  ! filename      ! 
    6    sn_cdg      =  'cdg_wave' ,        1          , 'drag_coeff' , .true.    , .false. , 'daily'  , ''       , ''       , '' 
    7    sn_usd      =  'sdw_wave' ,        1          , 'u_sd2d'     , .true.   , .false. , 'daily'  ,''         , ''       , '' 
    8    sn_vsd      =  'sdw_wave' ,        1          , 'v_sd2d'     , .true.   , .false. , 'daily'  ,''         , ''       , '' 
    9    sn_wn       =  'sdw_wave' ,        1          , 'wave_num'   , .true.   , .false. , 'daily'  ,''         , ''       , '' 
     4!              !  file name  ! frequency (hours) ! variable     ! time interp. !  clim   ! 'yearly'/ ! weights  ! rotation ! land/sea mask ! 
     5!              !             !  (if <0  months)  !   name       !   (logical)  !  (T/F) ! 'monthly' ! filename ! pairing  ! filename      ! 
     6   sn_cdg      =  'cdg_wave' ,        1          , 'drag_coeff' ,     .true.   , .false. , 'daily'   ,  ''      , ''       , '' 
     7   sn_usd      =  'sdw_wave' ,        1          , 'u_sd2d'     ,     .true.   , .false. , 'daily'   ,  ''      , ''       , '' 
     8   sn_vsd      =  'sdw_wave' ,        1          , 'v_sd2d'     ,     .true.   , .false. , 'daily'   ,  ''      , ''       , '' 
     9   sn_wn       =  'sdw_wave' ,        1          , 'wave_num'   ,     .true.   , .false. , 'daily'   ,  ''      , ''       , '' 
    1010! 
    1111   cn_dir_cdg  = './'  !  root directory for the location of drag coefficient files 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Namelist/namtra_adv

    r4147 r6436  
    22&namtra_adv    !   advection scheme for tracer 
    33!----------------------------------------------------------------------- 
    4    ln_traadv_cen2   =  .false.  !  2nd order centered scheme 
    5    ln_traadv_tvd    =  .true.   !  TVD scheme 
    6    ln_traadv_muscl  =  .false.  !  MUSCL scheme 
    7    ln_traadv_muscl2 =  .false.  !  MUSCL2 scheme + cen2 at boundaries 
    8    ln_traadv_ubs    =  .false.  !  UBS scheme 
    9    ln_traadv_qck    =  .false.  !  QUICKEST scheme 
    10    ln_traadv_msc_ups=  .false.  !  use upstream scheme within muscl 
     4   ln_traadv_cen2   =  .false.   !  2nd order centered scheme 
     5   ln_traadv_tvd    =  .true.    !  TVD scheme 
     6   ln_traadv_muscl  =  .false.   !  MUSCL scheme 
     7   ln_traadv_muscl2 =  .false.   !  MUSCL2 scheme + cen2 at boundaries 
     8   ln_traadv_ubs    =  .false.   !  UBS scheme 
     9   ln_traadv_qck    =  .false.   !  QUICKEST scheme 
     10   ln_traadv_msc_ups=  .false.   !  use upstream scheme within muscl 
     11   ln_traadv_tvd_zts=  .false.  !  TVD scheme with sub-timestepping of vertical tracer advection 
    1112/ 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Namelist/namtra_dmp

    r5102 r6436  
    22&namtra_dmp    !   tracer: T & S newtonian damping 
    33!----------------------------------------------------------------------- 
    4    ln_tradmp   =  .true.     !  add a damping termn (T) or not (F) 
    5    nn_zdmp     =    0        !  vertical   shape =0    damping throughout the water column 
    6                              !                   =1 no damping in the mixing layer (kz  criteria) 
    7                              !                   =2 no damping in the mixed  layer (rho crieria) 
    8    cn_resto    = 'resto.nc'  ! Name of file containing restoration coefficient field (use dmp_tools to create this) 
    9  
     4   ln_tradmp   =  .true.   !  add a damping termn (T) or not (F) 
     5   nn_zdmp     =    0      !  vertical   shape =0    damping throughout the water column 
     6                           !                   =1 no damping in the mixing layer (kz  criteria) 
     7                           !                   =2 no damping in the mixed  layer (rho crieria) 
     8   cn_resto    = 'resto.nc' ! Name of file containing restoration coefficient field (use dmp_tools to create this) 
    109/ 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Namelist/namtra_qsr

    r4230 r6436  
    1111   ln_qsr_2bd  = .false.   !  2 bands              light penetration 
    1212   ln_qsr_bio  = .false.   !  bio-model light penetration 
    13    nn_chldta   =      1    !  RGB : Chl data (=1) or cst value (=0) 
     13   nn_chldta   =      1    !  RGB : 2D Chl data (=1), 3D Chl data (=2) or cst value (=0) 
    1414   rn_abs      =   0.58    !  RGB & 2 bands: fraction of light (rn_si1) 
    1515   rn_si0      =   0.35    !  RGB & 2 bands: shortess depth of extinction 
    1616   rn_si1      =   23.0    !  2 bands: longest depth of extinction 
     17   ln_qsr_ice  = .true.    !  light penetration for ice-model LIM3 
    1718/ 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Namelist/namtrd

    r3294 r6436  
    11!----------------------------------------------------------------------- 
    2 &namtrd        !   diagnostics on dynamics and/or tracer trends         ("key_trddyn" and/or "key_trdtra") 
    3 !              !       or mixed-layer trends or barotropic vorticity    ("key_trdmld" or     "key_trdvor") 
     2&namtrd        !   diagnostics on dynamics and/or tracer trends 
     3!              !       and/or mixed-layer trends and/or barotropic vorticity 
    44!----------------------------------------------------------------------- 
    5    nn_trd      = 365       !  time step frequency dynamics and tracers trends 
    6    nn_ctls     =   0       !  control surface type in mixed-layer trends (0,1 or n<jpk) 
    7    rn_ucf      =   1.      !  unit conversion factor (=1 -> /seconds ; =86400. -> /day) 
    8    cn_trdrst_in      = "restart_mld"   ! suffix of ocean restart name (input) 
    9    cn_trdrst_out     = "restart_mld"   ! suffix of ocean restart name (output) 
    10    ln_trdmld_restart = .false.         !  restart for ML diagnostics 
    11    ln_trdmld_instant = .false.         !  flag to diagnose trends of instantantaneous or mean ML T/S 
     5   ln_glo_trd  = .false.   ! (T) global domain averaged diag for T, T^2, KE, and PE 
     6   ln_dyn_trd  = .false.   ! (T) 3D momentum trend output 
     7   ln_dyn_mxl  = .FALSE.   ! (T) 2D momentum trends averaged over the mixed layer (not coded yet) 
     8   ln_vor_trd  = .FALSE.   ! (T) 2D barotropic vorticity trends (not coded yet) 
     9   ln_KE_trd   = .false.   ! (T) 3D Kinetic   Energy     trends 
     10   ln_PE_trd   = .false.   ! (T) 3D Potential Energy     trends 
     11   ln_tra_trd  = .FALSE.   ! (T) 3D tracer trend output 
     12   ln_tra_mxl  = .false.   ! (T) 2D tracer trends averaged over the mixed layer (not coded yet) 
     13   nn_trd      = 365       !  print frequency (ln_glo_trd=T) (unit=time step) 
    1214/ 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Namelist/namtsd

    r4230 r6436  
    22&namtsd    !   data : Temperature  & Salinity 
    33!----------------------------------------------------------------------- 
    4 !          ! file name ! frequency (hours)         ! variable     ! time interp. ! clim  !'yearly' or ! weights  ! rotation ! land/sea mask ! 
    5 !          !           !  (if <0  months)          !   name       !  (logical)   ! (T/F) ! 'monthly'  ! filename ! pairing  ! filename      ! 
    6    sn_tem  = 'data_1m_potential_temperature_nomask', -1,'votemper',  .true.      , .true., 'yearly'   , ' '      , ' '      , '' 
    7    sn_sal  = 'data_1m_salinity_nomask'             , -1,'vosaline',  .true.      , .true., 'yearly'   , ''       , ' '      , '' 
     4!----------------------------------------------------------------------- 
     5!          !  file name                            ! frequency (hours) ! variable  ! time interp. !  clim  ! 'yearly'/ ! weights  ! rotation ! land/sea mask ! 
     6!          !                                       !  (if <0  months)  !   name    !   (logical)  !  (T/F) ! 'monthly' ! filename ! pairing  ! filename      ! 
     7   sn_tem  = 'data_1m_potential_temperature_nomask',         -1        ,'votemper' ,    .true.    , .true. , 'yearly'   , ''       ,   ''    ,    '' 
     8   sn_sal  = 'data_1m_salinity_nomask'             ,         -1        ,'vosaline' ,    .true.    , .true. , 'yearly'   , ''       ,   ''    ,    '' 
    89   ! 
    910   cn_dir        = './'     !  root directory for the location of the runoff files 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Namelist/namzdf_gls

    r3294 r6436  
    22&namzdf_gls                !   GLS vertical diffusion                   ("key_zdfgls") 
    33!----------------------------------------------------------------------- 
    4    rn_emin       = 1.e-6   !  minimum value of e   [m2/s2] 
     4   rn_emin       = 1.e-7   !  minimum value of e   [m2/s2] 
    55   rn_epsmin     = 1.e-12  !  minimum value of eps [m2/s3] 
    66   ln_length_lim = .true.  !  limit on the dissipation rate under stable stratification (Galperin et al., 1988) 
    7    rn_clim_galp  = 0.53    !  galperin limit 
    8    ln_crban      = .true.  !  Use Craig & Banner (1994) surface wave mixing parametrisation 
     7   rn_clim_galp  = 0.267   !  galperin limit 
    98   ln_sigpsi     = .true.  !  Activate or not Burchard 2001 mods on psi schmidt number in the wb case 
    109   rn_crban      = 100.    !  Craig and Banner 1994 constant for wb tke flux 
    1110   rn_charn      = 70000.  !  Charnock constant for wb induced roughness length 
    12    nn_tkebc_surf =   1     !  surface tke condition (0/1/2=Dir/Neum/Dir Mellor-Blumberg) 
    13    nn_tkebc_bot  =   1     !  bottom tke condition (0/1=Dir/Neum) 
    14    nn_psibc_surf =   1     !  surface psi condition (0/1/2=Dir/Neum/Dir Mellor-Blumberg) 
    15    nn_psibc_bot  =   1     !  bottom psi condition (0/1=Dir/Neum) 
    16    nn_stab_func  =   2     !  stability function (0=Galp, 1= KC94, 2=CanutoA, 3=CanutoB) 
    17    nn_clos       =   1     !  predefined closure type (0=MY82, 1=k-eps, 2=k-w, 3=Gen) 
     11   rn_hsro       =  0.02   !  Minimum surface roughness 
     12   rn_frac_hs    =   1.3   !  Fraction of wave height as roughness (if nn_z0_met=2) 
     13   nn_z0_met     =     2   !  Method for surface roughness computation (0/1/2) 
     14   nn_bc_surf    =     1   !  surface condition (0/1=Dir/Neum) 
     15   nn_bc_bot     =     1   !  bottom condition (0/1=Dir/Neum) 
     16   nn_stab_func  =     2   !  stability function (0=Galp, 1= KC94, 2=CanutoA, 3=CanutoB) 
     17   nn_clos       =     1   !  predefined closure type (0=MY82, 1=k-eps, 2=k-w, 3=Gen) 
    1818/ 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Namelist/namzdf_tke

    r4147 r6436  
    2121                           !        = 1 add a tke source below the ML 
    2222                           !        = 2 add a tke source just at the base of the ML 
    23                            !        = 3 as = 1 applied on HF part of the stress    ("key_coupled") 
     23                           !        = 3 as = 1 applied on HF part of the stress    ("key_oasis3") 
    2424   rn_efr      =   0.05    !  fraction of surface tke value which penetrates below the ML (nn_etau=1 or 2) 
    2525   nn_htau     =   1       !  type of exponential decrease of tke penetration below the ML 
  • branches/UKMO/nemo_v3_6_STABLE_copy/DOC/TexFiles/Namelist/namzgr_sco

    r3680 r6436  
    1313                        !!!!!!!  SH94 stretching coefficients  (ln_s_sh94 = .true.) 
    1414   rn_theta    =    6.0    !  surface control parameter (0<=theta<=20) 
    15    rn_bb       =    0.8    !  stretching with SH94 s-sigma    
     15   rn_bb       =    0.8    !  stretching with SH94 s-sigma 
    1616                        !!!!!!!  SF12 stretching coefficient  (ln_s_sf12 = .true.) 
    1717   rn_alpha    =    4.4    !  stretching with SF12 s-sigma 
     
    2222   rn_zb_b     =   -0.2    !  offset for calculating Zb 
    2323                        !!!!!!!! Other stretching (not SH94 or SF12) [also uses rn_theta above] 
    24    rn_thetb    =    1.0    !  bottom control parameter  (0<=thetb<= 1)  
     24   rn_thetb    =    1.0    !  bottom control parameter  (0<=thetb<= 1) 
    2525/ 
Note: See TracChangeset for help on using the changeset viewer.