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.
2014WP/2014_SystemSimplification_hard_coding (diff) – NEMO

Changes between Version 6 and Version 7 of 2014WP/2014_SystemSimplification_hard_coding


Ignore:
Timestamp:
2015-10-22T10:01:32+02:00 (9 years ago)
Author:
gm
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • 2014WP/2014_SystemSimplification_hard_coding

    v6 v7  
    99The idea here is to introduce in the code a few number of user routine with a clear interface that the user can fill up rolling his desires. This strategy will be applied for the standard configurations (GYRE, ORCA2, AMM, ...)   For example, the analytical forcing of gyre configuration instead of being part of the inner part of the code (sbc_gyre) it will put put in a my_sbc.F90 module given in the MY_SRC directory of the GYRE configuration. 
    1010 
    11 Typically, the my_...  will be related to forcing, horizontal mesh, vertical grid.  In each cases what should come out of those routine will be pass as arguments, so the user will know exactly what they have to define. 
     11Typically, the my_...  will be related to horizontal mesh, vertical grid, initial state and forcing.  In each cases what should come out of those routine will be pass as arguments, so the user will know exactly what they have to define. 
    1212 
    1313---- 
     
    1717[[BR]] '''cla.F90, domzgr.F90, dynspg_flt.F90'''         : 
    1818 
    19   cross land advection only defined in ORCA2 case [[BR]] (gibraltar and Bad el Mendeb straits) and no more used[[BR]]  ===>>>  module to be suppress              [[BR]]'''DONE in '''   [https://forge.ipsl.jussieu.fr/nemo/browser/branches/2015/dev_r5721_CNRS9_NOC3_LDF 2015/dev_r5721_CNRS9_NOC3_LDF] 
     19  cross land advection only defined in ORCA2 case [[BR]]  (gibraltar and Bad el Mendeb straits) and no more used[[BR]]   ===>>>  module to be suppress              [[BR]] ''' DONE in '''    [https://forge.ipsl.jussieu.fr/nemo/browser/branches/2015/dev_r5721_CNRS9_NOC3_LDF 2015/dev_r5721_CNRS9_NOC3_LDF] 
    2020 
    2121'''closea.F90'''        : 
    2222 
    23   suppress closed seas in forced mode (typically Caspian Sea, Azov Sea…)[[BR]] or balance their fresh water budget in coupled mode …[[BR]] ''' ===>>>  How to deal with that ?'''   idea user_defined module for close.F90 
     23  suppress closed seas in forced mode (typically Caspian Sea, Azov Sea…)[[BR]]  or balance their fresh water budget in coupled mode …[[BR]]  '''  ===>>>  How to deal with that ?'''    idea user_defined module for close.F90 
    2424 
    2525[[BR]] '''diafwb.F90'''        : 
    2626 
    27   only diagnostics of the global fresh water budget and of transport of mass salt and heat in some straits:[[BR]] Gibraltar, Red Sea, Baltic Sea etc. for ORCA 4°, 2° & 1°[[BR]] ''' ===>>>  module to be suppress  '''     idea user_defined module for that 
     27  only diagnostics of the global fresh water budget and of transport of mass salt and heat in some straits:[[BR]]  Gibraltar, Red Sea, Baltic Sea etc. for ORCA 4°, 2° & 1°[[BR]]  '''  ===>>>  module to be suppress  '''      idea user_defined module for that 
    2828 
    2929[[BR]] '''diaptr.F90'''        : 
    3030 
    31   Computes meridional transports and zonal means (of heat salt velocities). [[BR]] Inefficient on MPP as require global communication. Better to compute off line. [[BR]] Suppress the module and add the output of the vertical average of u.T , v.T , u.S, v.S [[BR]] from which exact poleward heat transport can be computed…[[BR]] ''' ===>>>  module to be suppress (?)  ''' discussion still open as in ESM, they want those diags directly in the output... 
     31  Computes meridional transports and zonal means (of heat salt velocities). [[BR]]  Inefficient on MPP as require global communication. Better to compute off line. [[BR]]  Suppress the module and add the output of the vertical average of u.T , v.T , u.S, v.S [[BR]]  from which exact poleward heat transport can be computed…[[BR]]  '''  ===>>>  module to be suppress (?)  ''' discussion still open as in ESM, they want those diags directly in the output... 
    3232 
    3333[[BR]] '''domhgr.F90'''        : 
    3434 
    35   hard coded reduction of scale factors in some straits in ORCA configurations [[BR]] (typically straits of Gibraltar, Bab el Mandeb, Danish, Lombok, Sumba, etc).  [[BR]] The input coordinates.nc file have to contain the information [[BR]] (+ add in TOOLS a fortran program as an example of how to modify a coordinates.nc file)[[BR]] ===>>>  remove hard coded part             [[BR]]'''DONE in '''     [https://forge.ipsl.jussieu.fr/nemo/browser/branches/2015/dev_r5721_CNRS9_NOC3_LDF 2015/dev_r5721_CNRS9_NOC3_LDF] 
     35  hard coded reduction of scale factors in some straits in ORCA configurations [[BR]]  (typically straits of Gibraltar, Bab el Mandeb, Danish, Lombok, Sumba, etc).  [[BR]]  The input coordinates.nc file have to contain the information [[BR]]  (+ add in TOOLS a fortran program as an example of how to modify a coordinates.nc file)[[BR]]  ===>>>  remove hard coded part             [[BR]] ''' DONE in '''      [https://forge.ipsl.jussieu.fr/nemo/browser/branches/2015/dev_r5721_CNRS9_NOC3_LDF 2015/dev_r5721_CNRS9_NOC3_LDF] 
    3636 
    37 [[BR]] '''dommsk.F90'''        :  
     37[[BR]] '''dommsk.F90'''        : 
    3838 
    39   hard coded increase of lateral friction at the coast in some straits. [[BR]]Add a external file to be read that contains the specification of lateral friction [[BR]](+ add in TOOLS a fortran program as an example of how to specify the input file)[[BR]]'''===>>>  remove hard coded part''' 
     39  hard coded increase of lateral friction at the coast in some straits. [[BR]] Add a external file to be read that contains the specification of lateral friction [[BR]] (+ add in TOOLS a fortran program as an example of how to specify the input file)[[BR]] ''' ===>>>  remove hard coded part''' 
    4040 
    41 [[BR]] '''domvvl.F90'''        :  
     41[[BR]] '''domvvl.F90'''        : 
    4242 
    43   modifications associated with the reduction of scale factors in some straits. No more needed: [[BR]]addition of unaltered surface (e1e2u, e1e2v) in coordinates.nc when scale factors are reduced in some straits.[[BR]]===>>>  remove hard coded part, modify coordinates.nc   [[BR]]'''DONE in '''     [https://forge.ipsl.jussieu.fr/nemo/browser/branches/2015/dev_r5721_CNRS9_NOC3_LDF 2015/dev_r5721_CNRS9_NOC3_LDF] 
     43  modifications associated with the reduction of scale factors in some straits. No more needed: [[BR]] addition of unaltered surface (e1e2u, e1e2v) in coordinates.nc when scale factors are reduced in some straits.[[BR]] ===>>>  remove hard coded part, modify coordinates.nc   [[BR]] ''' DONE in '''      [https://forge.ipsl.jussieu.fr/nemo/browser/branches/2015/dev_r5721_CNRS9_NOC3_LDF 2015/dev_r5721_CNRS9_NOC3_LDF] 
    4444 
    4545[[BR]] '''dtatsd, dtauvd.F90'''        : 
    4646 
    47    in ORCA_R2 case, some hand made alterations in Red and Med Seas as well as changes associated with cross-land advection. [[BR]]Can be removed. If someone wants similar things, he has to modify the T-S data file.[[BR]]'''===>>>  remove hard coded part''' 
     47  in ORCA_R2 case, some hand made alterations in Red and Med Seas as well as changes associated with cross-land advection. [[BR]] Can be removed. If someone wants similar things, he has to modify the T-S data file.[[BR]] ''' ===>>>  remove hard coded part''' 
    4848 
    49 [[BR]] '''istate.F90'''        :  
     49[[BR]] '''istate.F90'''        : 
    5050 
    51   analytical initial state for EEL and GYRE[[BR]]'''===>>> to be kept util USER defined modules are introduced''' 
     51  analytical initial state for EEL and GYRE[[BR]] ''' ===>>> to be kept util USER defined modules are introduced''' 
    5252 
    53 [[BR]] '''ldfslp.F90'''        :  
     53[[BR]] '''ldfslp.F90'''        : 
    5454 
    55   alteration of the slope for ORCA 4° only. No more needed.[[BR]]===>>>  remove hard coded part   [[BR]]'''DONE in '''     [https://forge.ipsl.jussieu.fr/nemo/browser/branches/2015/dev_r5721_CNRS9_NOC3_LDF 2015/dev_r5721_CNRS9_NOC3_LDF] 
     55  alteration of the slope for ORCA 4° only. No more needed.[[BR]] ===>>>  remove hard coded part   [[BR]] ''' DONE in '''      [https://forge.ipsl.jussieu.fr/nemo/browser/branches/2015/dev_r5721_CNRS9_NOC3_LDF 2015/dev_r5721_CNRS9_NOC3_LDF] 
    5656 
    57 [[BR]] '''ldftra.F90 (ldf_eiv)''' :  
     57[[BR]] '''ldftra.F90 (ldf_eiv)''' : 
    5858 
    59   hard coded alteration of the eiv coef. in orca2 case. [[BR]]Now the eiv coef.  can be provided in a file[[BR]]===>>>  remove hard coded part   [[BR]]'''DONE in '''     [https://forge.ipsl.jussieu.fr/nemo/browser/branches/2015/dev_r5721_CNRS9_NOC3_LDF 2015/dev_r5721_CNRS9_NOC3_LDF] 
     59  hard coded alteration of the eiv coef. in orca2 case. [[BR]] Now the eiv coef.  can be provided in a file[[BR]] ===>>>  remove hard coded part   [[BR]] ''' DONE in '''      [https://forge.ipsl.jussieu.fr/nemo/browser/branches/2015/dev_r5721_CNRS9_NOC3_LDF 2015/dev_r5721_CNRS9_NOC3_LDF] 
    6060 
    61 [[BR]] '''p4zsbc.F90'''        :  
     61[[BR]] '''p4zsbc.F90'''        : 
    6262 
    63   hard coded enhance coastal supply of iron for ORCA2. [[BR]]Since a file is provided that can contains the specificity of ORCA 2°[[BR]]'''===>>>  remove hard coded part''' 
     63  hard coded enhance coastal supply of iron for ORCA2. [[BR]] Since a file is provided that can contains the specificity of ORCA 2°[[BR]] ''' ===>>>  remove hard coded part''' 
    6464 
    65 [[BR]] '''sbcrnf.F90'''        :  
     65[[BR]] '''sbcrnf.F90'''        : 
    6666 
    67   hard coded runoff reduction only associated to the ORCA2_LIM. [[BR]]It is associated with an old runoff file may lead to bug! [[BR]]===>>> remove hard coded part[[BR]]'''DONE in '''2015/dev_r5721_CNRS9_NOC3_ZDF 
     67  hard coded runoff reduction only associated to the ORCA2_LIM. [[BR]] It is associated with an old runoff file may lead to bug! [[BR]] ===>>> remove hard coded part[[BR]] ''' DONE in ''' 2015/dev_r5721_CNRS9_NOC3_ZDF 
    6868 
    69 [[BR]] '''traadv_cen2.F90''' :  
     69[[BR]] '''traadv_cen2.F90''' : 
    7070 
    71   hard coded upstream in vicinity of river mouth and freezing point. [[BR]]As cen2 is no more used in ORCA configuration, [[BR]]just remove everything and keep a standard 2nd order centered scheme.[[BR]]===>>>  remove hard coded part   [[BR]]'''DONE in '''     [https://forge.ipsl.jussieu.fr/nemo/browser/branches/2015/dev_r5721_CNRS9_NOC3_LDF 2015/dev_r5721_CNRS9_NOC3_LDF]     (now traadv_cen.F90) 
     71  hard coded upstream in vicinity of river mouth and freezing point. [[BR]] As cen2 is no more used in ORCA configuration, [[BR]] just remove everything and keep a standard 2nd order centered scheme.[[BR]] ===>>>  remove hard coded part   [[BR]] ''' DONE in '''      [https://forge.ipsl.jussieu.fr/nemo/browser/branches/2015/dev_r5721_CNRS9_NOC3_LDF 2015/dev_r5721_CNRS9_NOC3_LDF]      (now traadv_cen.F90) 
    7272 
    73 '''trabbl.F90''' :  
     73'''trabbl.F90''' : 
    7474 
    75   ORCA 4° & 2°, regional enhancement of ah_bbl [[BR]]===>>> to be suppress           [[BR]]'''DONE in '''2015/dev_r5721_CNRS9_NOC3_ZDF 
     75  ORCA 4° & 2°, regional enhancement of ah_bbl [[BR]] ===>>> to be suppress           [[BR]] ''' DONE in ''' 2015/dev_r5721_CNRS9_NOC3_ZDF 
    7676 
    77 '''ldfdyn.F90''' :  
     77'''ldfdyn.F90''' : 
    7878 
    79   specific viscosity in ORCA 2° and ORCA 1°. Read them in an input file[[BR]](+ add in TOOLS a fortran program as an example of how generate the input file)[[BR]]===>>>  remove hard coded part   [[BR]]'''DONE in '''     [https://forge.ipsl.jussieu.fr/nemo/browser/branches/2015/dev_r5721_CNRS9_NOC3_LDF 2015/dev_r5721_CNRS9_NOC3_LDF] 
     79  specific viscosity in ORCA 2° and ORCA 1°. Read them in an input file[[BR]] (+ add in TOOLS a fortran program as an example of how generate the input file)[[BR]] ===>>>  remove hard coded part   [[BR]] ''' DONE in '''      [https://forge.ipsl.jussieu.fr/nemo/browser/branches/2015/dev_r5721_CNRS9_NOC3_LDF 2015/dev_r5721_CNRS9_NOC3_LDF] 
    8080 
    81 '''tradmp.F90 ; trcdmp.F90''' :  
     81'''tradmp.F90 ; trcdmp.F90''' : 
    8282 
    83    
    84    hard coded definition of damping area for ORCA 2°, 1°, 0.5°. Read them in an input file [[BR]](+ add in TOOLS a fortran program as an example of how generate the input file)[[BR]]===>>> remove hard coded part[[BR]]'''DONE in''' nemo_v3_6_STABLE     
     83  hard coded definition of damping area for ORCA 2°, 1°, 0.5°. Read them in an input file [[BR]] (+ add in TOOLS a fortran program as an example of how generate the input file)[[BR]] ===>>> remove hard coded part[[BR]] ''' DONE in'''  nemo_v3_6_STABLE 
    8584 
    86 '''trcdmp.F90''' :  
     85'''trcdmp.F90''' : 
    8786 
    88  
    89  
    90      hard coded definition of damping in closed seas for ORCA 2°, 1°, 0.5°. [[BR]]'''===>>>      Find a solution''' similar to what will be done for closed seas in OPA (close.F90) 
     87  hard coded definition of damping in closed seas for ORCA 2°, 1°, 0.5°. [[BR]] ''' ===>>>      Find a solution'''  similar to what will be done for closed seas in OPA (close.F90)