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 1 and Version 2 of 2014WP/2014_SystemSimplification_hard_coding


Ignore:
Timestamp:
2014-11-20T15:15:49+01:00 (9 years ago)
Author:
gm
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • 2014WP/2014_SystemSimplification_hard_coding

    v1 v2  
    1  
    2  
    3  
    4 = '''disappearance of “configuration hard coding”'' =   
    5 [[BR]] 
    6  
     1= '''disappearance of “configuration hard coding”''''''' = 
    72Last edited [[Timestamp]] 
    83 
     
    105 
    116---- 
     7---- 
     8== User interface  == 
    129 
    13 Brief description of "hard coding" associated to build in configuration (mostly ORCA configuration) and suggestion about what we plan to done with them 
     10The 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. 
     11This strategy will be applied for the standard configurations (GYRE, ORCA2, AMM, ...)   
     12For 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. 
    1413 
    15 [[BR]] 
    16 '''cla.F90, domzgr.F90, dynspg_flt.F90'''       :  cross land advection only defined in ORCA2 case (gibraltar and Bad el Mendeb straits) and no more used   
    17                 '''===>>>  module to be suppress'''  
     14Typically, the my_...  will be related to forcing, horizontal mesh, vertical grid.  
     15In 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.  
    1816 
    19 [[BR]] 
     17---- 
    2018 
    21 '''closea.F90'''        :  suppress closed seas in forced mode (typically Caspian Sea, Azov Sea…) or balance their fresh water budget in coupled mode …   
    22                  '''===>>>  How to deal with that ? ''' 
    2319 
    24 [[BR]] 
    25 '''diafwb.F90'''        :  only diagnostics of the global fresh water budget and of transport of mass salt and heat in some straits (Gibraltar, Red Sea, Baltic Sea etc. for ORCA 4°, 2° & 1°)           
    26                 ''' ===>>>  module to be suppress''' 
     20== Inside the ocean code (OPA) == 
     21  
    2722 
    28 [[BR]] 
    29 '''diaptr.F90'''        :  Computes meridional transports and zonal means (of heat salt velocities). Inefficient on MPP as require global communication. Better to compute off line. Suppress the module and add the output of the vertical average of u.T , v.T , u.S, v.S from which exact poleward heat transport can be computed…  
    30                 '''===>>>  module to be suppress (?)''' 
     23Here follows a brief description of "hard coding" associated to build in configuration (mostly ORCA configuration) and suggestion about what we plan to done with them 
    3124 
    32 [[BR]] 
    33 '''domhgr.F90'''        :  hard coded reduction of scale factors in some straits in ORCA configurations (typically straits of Gibraltar, Bab el Mandeb, Danish, Lombok, Sumba, etc).  The input coordinates.nc file have to contain the information (+ add in TOOLS a fortran program as an example of how to modify a coordinates.nc file)  
    34                 '''===>>>  remove hard coded part ''' 
    3525 
    36 [[BR]] 
    37 '''dommsk.F90'''        :  hard coded increase of lateral friction at the coast in some straits. Add a external file to be read that contains the specification of lateral friction (+ add in TOOLS a fortran program as an example of how to specify the input file) 
    38                 '''===>>>  remove hard coded part ''' 
     26[[BR]] '''cla.F90, domzgr.F90, dynspg_flt.F90'''         :  cross land advection only defined in ORCA2 case (gibraltar and Bad el Mendeb straits) and no more used 
    3927 
    40 [[BR]] 
    41 '''domvvl.F90'''        :  modifications associated with the reduction of scale factors in some straits. No more necessary (addition of unaltered surface (e1e2u, e1e2v) in coordinates.nc when scale factors are reduced in some straits. 
    42                 '''===>>>  remove hard coded part, modify coordinates.nc ''' 
     28  '''  ===>>>  module to be suppress''' 
    4329 
    44 [[BR]] 
    45 '''dtatsd, dtauvd.F90'''        :  in ORCA_R2 case, some hand made alterations in Red and Med Seas as well as changes associated with cross-land advection. Can be removed. If someone wants similar things, he has to modify the T-S data file. 
    46                 '''===>>>  remove hard coded part ''' 
     30'''closea.F90'''        :  suppress closed seas in forced mode (typically Caspian Sea, Azov Sea…) or balance their fresh water budget in coupled mode … 
    4731 
    48 [[BR]] 
    49 '''istate.F90'''        :  analytical initial state for EEL and GYRE  
    50                 '''===>>> to be kept''' 
     32  '''  ===>>>  How to deal with that ? ''' 
    5133 
    52 [[BR]] 
    53 '''ldfslp.F90'''        :  alteration of the slope for ORCA 4° only. No more necessary 
    54                 '''===>>>  remove hard coded part ''' 
     34[[BR]] '''diafwb.F90'''        :  only diagnostics of the global fresh water budget and of transport of mass salt and heat in some straits (Gibraltar, Red Sea, Baltic Sea etc. for ORCA 4°, 2° & 1°) 
    5535 
    56 [[BR]] 
    57 '''ldftra.F90 (ldf_eiv)''' :  hard coded alteration of the eiv coef. in orca2 case. Now the eiv coef.  can be provided in a file 
    58                 '''===>>>  remove hard coded part ''' 
     36  '''   ===>>>  module to be suppress''' 
    5937 
    60 [[BR]] 
    61 '''p4zsbc.F90'''        :  hard coded enhance coastal supply of iron for ORCA2. Since a file is provided that can contains the specificity of ORCA 2° 
    62                 '''===>>>  remove hard coded part ''' 
     38[[BR]] '''diaptr.F90'''        :  Computes meridional transports and zonal means (of heat salt velocities). Inefficient on MPP as require global communication. Better to compute off line. Suppress the module and add the output of the vertical average of u.T , v.T , u.S, v.S from which exact poleward heat transport can be computed… 
    6339 
    64 [[BR]] 
    65 '''sbcrnf.F90'''        :  hard coded uunoff reduction only associated to the ORCA2_LIM. It is associated with an old runoff file may lead to bug!   
    66                 '''===>>>  remove hard coded part ''' 
     40  '''  ===>>>  module to be suppress (?)''' 
    6741 
    68 [[BR]] 
    69 '''traadv_cen2.F90''' :  hard coded upstream in vicinity of river mouth and freezing point. As cen2 is no more used in ORCA configuration, juste remove everything and keep a standard 2nd order centered scheme. 
    70                 '''===>>>  remove hard coded part ''' 
     42[[BR]] '''domhgr.F90'''        :  hard coded reduction of scale factors in some straits in ORCA configurations (typically straits of Gibraltar, Bab el Mandeb, Danish, Lombok, Sumba, etc).  The input coordinates.nc file have to contain the information (+ add in TOOLS a fortran program as an example of how to modify a coordinates.nc file) 
    7143 
    72 [[BR]] 
    73 trabbl.F90      :  ORCA 4° & 2°, regional enhancement of ah_bbl   
    74  '''===>>>  to be suppress ''' 
     44  '''  ===>>>  remove hard coded part ''' 
     45 
     46[[BR]] '''dommsk.F90'''        :  hard coded increase of lateral friction at the coast in some straits. Add a external file to be read that contains the specification of lateral friction (+ add in TOOLS a fortran program as an example of how to specify the input file) 
     47 
     48  '''  ===>>>  remove hard coded part ''' 
     49 
     50[[BR]] '''domvvl.F90'''        :  modifications associated with the reduction of scale factors in some straits. No more necessary (addition of unaltered surface (e1e2u, e1e2v) in coordinates.nc when scale factors are reduced in some straits. 
     51 
     52  '''  ===>>>  remove hard coded part, modify coordinates.nc ''' 
     53 
     54[[BR]] '''dtatsd, dtauvd.F90'''        :  in ORCA_R2 case, some hand made alterations in Red and Med Seas as well as changes associated with cross-land advection. Can be removed. If someone wants similar things, he has to modify the T-S data file. 
     55 
     56  '''  ===>>>  remove hard coded part ''' 
     57 
     58[[BR]] '''istate.F90'''        :  analytical initial state for EEL and GYRE 
     59 
     60  '''  ===>>> to be kept''' 
     61 
     62[[BR]] '''ldfslp.F90'''        :  alteration of the slope for ORCA 4° only. No more necessary 
     63 
     64  '''  ===>>>  remove hard coded part ''' 
     65 
     66[[BR]] '''ldftra.F90 (ldf_eiv)''' :  hard coded alteration of the eiv coef. in orca2 case. Now the eiv coef.  can be provided in a file 
     67 
     68  '''  ===>>>  remove hard coded part ''' 
     69 
     70[[BR]] '''p4zsbc.F90'''        :  hard coded enhance coastal supply of iron for ORCA2. Since a file is provided that can contains the specificity of ORCA 2° 
     71 
     72  '''  ===>>>  remove hard coded part ''' 
     73 
     74[[BR]] '''sbcrnf.F90'''        :  hard coded uunoff reduction only associated to the ORCA2_LIM. It is associated with an old runoff file may lead to bug! 
     75 
     76  '''  ===>>>  remove hard coded part ''' 
     77 
     78[[BR]] '''traadv_cen2.F90''' :  hard coded upstream in vicinity of river mouth and freezing point. As cen2 is no more used in ORCA configuration, juste remove everything and keep a standard 2nd order centered scheme. 
     79 
     80  '''  ===>>>  remove hard coded part ''' 
     81 
     82[[BR]] trabbl.F90        :  ORCA 4° & 2°, regional enhancement of ah_bbl 
     83 
     84  '''  ===>>>  to be suppress ''' 
    7585 
    7686'''ldfdyn.F90''' :  specific viscosity in ORCA 2° and ORCA 1°. Read them in an input file (+ add in TOOLS a fortran program as an example of how generate the input file) 
    77                  '''===>>>  remove hard coded part  ''' 
    7887 
    79 [[BR]] 
    80 '''tradmp.F90 ; trcdmp.F90''' :   hard coded definition of damping area for ORCA 2°, 1°, 0.5°. Read them in an input file (+ add in TOOLS a fortran program as an example of how generate the input file) 
    81                  '''===>>>  remove hard coded part ''' 
     88  '''  ===>>>  remove hard coded part  ''' 
    8289 
     90[[BR]] '''tradmp.F90 ; trcdmp.F90''' :   hard coded definition of damping area for ORCA 2°, 1°, 0.5°. Read them in an input file (+ add in TOOLS a fortran program as an example of how generate the input file) 
    8391 
     92  '''  ===>>>  remove hard coded part ''' 
    8493 
    8594----