.. _doc.manual.param: Parametrization data ==================== After compilation and before running, one must fill parameters in namelists files and build data files. .. _doc_namelistfiles: **namelist files** -------------------- The namelist variables are dispatches in several files, depending on themes and code organization. There are : * **paramain.txt** : general namelist for the configuration (shared with all ranks) (:ref:`doc.paramain`) * **paracom.txt** : shared with all ranks (:ref:`doc.paracom`) * **paraspec.txt** : different for each rank (:ref:`doc.paraspec`) * **parasubs.txt** : need if transport substances (*key_substance*) (:ref:`doc.parasubs`) * **parasedim.txt** : need if sediment using (*key_sedim*)(:ref:`doc_parasedim`) * **parabiolo.txt** : need if using modules for biology (*key_biolo*) (:ref:`parametres.biolo`) * **paraconta.txt** : need if using modules for contaminant (*key_contaminant*) .. _doc_listnamelist: **Namelist variables** listed by theme ----------------------------------------- Definition of each variable is given into each namelist file Theme *Dates* ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +------------+----------------------+------------------------------------------+-------------+----------------------------------------------+ | namelist | namelist file | variable | CPPkey | Observations | +------------+----------------------+------------------------------------------+-------------+----------------------------------------------+ | | nmlmain | | :ref:`doc.paramain`| | date_ref = '01-Jan-1900 00:00:00‘ | | | | Do not change | +------------+----------------------+------------------------------------------+-------------+----------------------------------------------+ | | namdate | | :ref:`doc.paracom` | | date_start = '06/03/2005 00:00:00' | | | | simulatin starting date | | | | | | | date_end = '09/03/2005 00:00:00' | | | | simulation finishing date | +------------+----------------------+------------------------------------------+-------------+----------------------------------------------+ | | namdat3d | | :ref:`doc.paraspec`| | date_start3d = '03/02/2006 12:00:00' | | | | 3D run starting date (== or > date_start) | | | | | | | date_startagrif = '05/02/2008 12:00:00'| | | | AGRIF zoom starting date | | | | | | | date_startshift = 0.0 | | | | Rank management | +------------+----------------------+------------------------------------------+-------------+----------------------------------------------+ Theme *General* ^^^^^^^^^^^^^^^^^^^ +------------+-----------------------+----------------------------------------+---------------+-----------------------------------------------+ | namelist | namelist file | variable | CPPkey | Observations | +------------+-----------------------+----------------------------------------+---------------+-----------------------------------------------+ | | nmlmain | | :ref:`doc.paramain` | | comdir = '../' | | | | ./ without rank OR ../if ranks | | | | | | | jhemisph=1 | | | | 1/-1 in North/South hemisphere | +------------+-----------------------+----------------------------------------+---------------+-----------------------------------------------+ | | nmlhead | | :ref:`doc.paracom` | | file_head = '../../inputs/head.cool‘ | | | | example congif "cool" | | | | | | | confname_mother = 'cool' | | | | | | | | | | | confname = 'cool' | | | | | | | | | | | suffix = 'V10.4' | | | | | +------------+-----------------------+----------------------------------------+---------------+-----------------------------------------------+ | | namriv | | :ref:`doc.paraspec` | | icon=2 | | | | /=2 to make tests on buoyancy impact (3D) | +------------+-----------------------+----------------------------------------+---------------+-----------------------------------------------+ | namparanum | | :ref:`doc.paraspec` | | l_modele2d=.true. | | | | If set to .true., 2D run even though kmax>1 | | | | | | | cflcrt=0.6 | | | | | +------------+-----------------------+----------------------------------------+---------------+-----------------------------------------------+ Theme *SIGMA* ^^^^^^^^^^^^^^^ +--------------+-----------------------+-----------------------+----------------------+---------------------------------------------+ | namelist | namelist file | variable | CPPkey | Observations | +--------------+-----------------------+-----------------------+----------------------+---------------------------------------------+ | | namgridsig | | :ref:`doc.paraspec` | | l_equisig=.true. | | | | (3D) | | | | | | | sig(1)=0.05 | | | | (3D) | | | | | | | hc = 5. (meters) | | | | if generalized sigma | | | | | | | b_sig | | | | 0< Bottom control <1 (Genralized sigma) | | | | | | | theta_sig | | | | 0< Surface control <20 (Genralized sigma) | | | | | | | grid_angle | | key_grid_rotated | | | | | | | | | l_corio_cst=.false. | | | | | +--------------+-----------------------+-----------------------+----------------------+---------------------------------------------+ Theme *TIME STEPS* ^^^^^^^^^^^^^^^^^^^ +--------------+-----------------------+------------------+--------------+------------------------------+ | namelist | namelist file | variable | CPPkey | Observations | +--------------+-----------------------+------------------+--------------+------------------------------+ | | namparanum | | :ref:`doc.paraspec` | | dtini=400.d0 | | | | | | | | | | | dtmin=200.d0 | | | | dtmin < dt < dtmax | | | | | | | dtmax=800.d0 | | | | if generalized sigma | +--------------+-----------------------+------------------+--------------+------------------------------+ Theme *TIME INTERPOLATION* ^^^^^^^^^^^^^^^^^^^^^^^^^^ +------------+-----------------------+------------------------+----------------+------------------------------+ | namelist | namelist file | variable | CPPkey | Observations | +------------+-----------------------+------------------------+----------------+------------------------------+ | | nmlinterp| | :ref:`doc.paramain` | | perchrono=0.1 | | | | Used if reading of one | | | | | | | tobs=12.0 (hours) | | | | data.dat file | | | | | | | l_champroche=.false. | | | | DO NOT USE | +------------+-----------------------+------------------------+----------------+------------------------------+ Theme *BATHYMETRY* ^^^^^^^^^^^^^^^^^^^ +------------+-----------------------+-----------------------------------------+------------------+--------------------------------+ | namelist | namelist file | variable | CPPkey | Observations | +------------+-----------------------+-----------------------------------------+------------------+--------------------------------+ | | nambathy | | :ref:`doc.paraspec` | | file_bathy='../../inputs/hxhy.cool0' | | | | | | | | | | | name_bathy_hx='HX‘ | | key_netcdf | | | | | | | | | name_bathy_hy='HY‘ | | key_netcdf | | | | | | | | | name_bathy_h0='H0‘ | | key_netcdf | | | | | | | | | l_bathy_meanlev=.false. | | | | | | | | | | | name_bathy_meanlev='nmoy' | | | | | | | | | | | mslshift=0.0 | | | | | | | | | | | bathy_nbsmooth=0 | | | | should not be changed | | | | | | | l_bathy_comb=.false. | | | | | | | | | | | l_bathy_pit=.false. | | | | | | | | | | | hminim=-9.9 | | | | | | | | | | | hrdef=20.0 | | | | | | | | | | | h0fond=0.01 | | | | | | | | | | | dhj=0.05 | | | | | | | | | | | hminkxky=0.5 | | | | | | | | | | | l_tssubadv_over_smalldepth=.true. | | | | | | | | | | | hm=1.0 | | | | | | | | | | | l_bathy_save=.false. | | | | | | | | | | | fwetmin =1.0 | | | | | | | | | | | file_bathy_child | | | | | +------------+-----------------------+-----------------------------------------+------------------+--------------------------------+ Theme *RESTART* ^^^^^^^^^^^^^^^^^^^ +--------------+-----------------------+--------------------------+-----------------+---------------------------------------------+ | namelist | namelist file | variable | CPPkey | Observations | +--------------+-----------------------+--------------------------+-----------------+---------------------------------------------+ | | nmlrestart | | :ref:`doc.paramain` | | name_in_dt = 'DT' | | | | | | | | | | | name_in_xe = 'XE‘ | | | | | | | | | | | .... | | | | | +--------------+-----------------------+--------------------------+-----------------+---------------------------------------------+ | | namreprise | | :ref:`doc.paraspec` | | l_initfromfile | | | | Set all the boolean to .true. | | | | | | | file_init = 'save.nc‘ | | | | to get exact results when | | | | | | | l_init_restart=.false. | | | | restarting from a restart file | | | | | | | l_init_rtime=.false. | | | | after a break in the simulation. | | | | | | | l_init_rdt=.false. | | | | | | | | | | | l_init_rssh=.false. | | | | | | | | | | | l_init_rbtvel=.false. | | | | | | | | | | | l_init_r3dvel=.false. | | | | To read an input file prepared | | | | | | | l_init_rwz=.false | | | | from extract program | | | | | | | l_init_rturb=.false. | | | | specify which variables you want | | | | | | | l_init_rsal=.false. | | | | to read and | | | | | | | l_init_rtemp=.false. | | | | define l_init_restart=.false. | +--------------+-----------------------+--------------------------+-----------------+---------------------------------------------+ Theme *OUTPUT* ^^^^^^^^^^^^^^^^^^^ +------------+-----------------------+-------------------------------+---------------------+-----------------------------------------------------+ | namelist | namelist file | variable | CPPkey | Observations | +------------+-----------------------+-------------------------------+---------------------+-----------------------------------------------------+ | | nmloutput| | :ref:`doc.paramain` | | l_maxu=.true. | | | | Maximum velocities are printed on | | | | | | | name_out_h0='h0‘ | | | | the screen (iscreen=6) or in the | | | | | | | '.... ' | | | | listing file (iscreen=12) | +------------+-----------------------+-------------------------------+---------------------+-----------------------------------------------------+ | | namoutput| | :ref:`doc.paraspec` | | file_output= './output.dat' | | | | | | | | | | | iscreen=12 | | | | | | | | | | | iscreenlog=18 | | | | | | | | | | | iwarnlog=16 | | | | Get it empty | | | | | | | ierrorlog=17 | | | | The simulation is stopped if an error | | | | | | | out_dir | | | | occurs. The error si described in file | | | | | | | | | | | error_suffix.log | | | | | | | | | | | | | | | | | | l_out_nc4par | | -Dkey_MPI_2D | | True : each cpu writes its local domain | | | | | | | | | | | in a unique global file | | | | | | | l_out_pack | | | | True : the data values are packed, i.e. | | | | | | | | | | | saved in short precision | | | | | | | | | | | Packed_value = NINT((value- offset)/scale_factor | +------------+-----------------------+-------------------------------+---------------------+-----------------------------------------------------+ Theme *SAVING* ^^^^^^^^^^^^^^^^^^^ +----------------+-----------------------+----------------------------------+--------------+-------------------------------------------------+ | namelist | namelist file | variable | CPPkey | Observations | +----------------+-----------------------+----------------------------------+--------------+-------------------------------------------------+ | | nasaverestart| | :ref:`doc.paraspec` | | l_saverestart_1file = .false. | | | | | | | | | | | l_saverestart_bydate = .false. | | | | | | | | | | | file_saverestart= 'save.nc' | | | | | | | | | | | saverestart_step = 1.0d0 | | | | | +----------------+-----------------------+----------------------------------+--------------+-------------------------------------------------+ Theme *OPEN BOUNDARY CONDITIONS* ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +----------------+-----------------------+----------------------------------+------------------------+--------------------------------------------------+ | namelist | namelist file | variable | CPPkey | Observations | +----------------+-----------------------+----------------------------------+------------------------+--------------------------------------------------+ | | namobc | | :ref:`doc.paraspec` | | l_obc_ogcm_rssh=.false. | | | | Reading of data issued from another MARS | | | | | | | l_obc_ogcm_rt=.false. | | | | configuration or another model. | | | | | | | l_obc_ogcm_rs=.false. | | | | Data are spatially interpolated off-line with | | | | | | | l_obc_ogcm_rc=.false. | | | | the use of the program named extract. | | | | | | | l_obc_ogcm_ruv=.false. | | | | Data are interpolated on time during the run | | | | | | | l_obc_ogcm_ruvz=.false. | | | | l_obc_rssh=.true., the ssh relative to the | | | | | | | l_obc_relax=.false. | | | | mean circulation comes from a coarser model | | | | | | | obc_coefrel=0.7e-05 | | | | | | | | | | | l_obc_cyc=.true. | | | | l_obc_cyc=.true., If periodic | | | | | | | l_obc_cycl_x/y=.false. | | | | zonal/meridional periodicity | | | | | | | l_obc_mars=.true. | | | | No gradient of velocity at open boundary | | | | | | | l_obc_char=.true. | | | | Characteristics method | | | | | | | l_obc_diri=.true. | | | | Dirichlet | | | | | | | l_obc_tide=.true. | | | | OBCs come from a previous rank | | | | | | | l_obc_ogcm=.true. | | | | OBCs come from an OGCM | | | | | | | l_tide_harmcompo=.true. | | key_tide_fes2004 or… | | | | | | | | | l_obc2drank_save=.true. | | | | Saving of open boundary condition (rank) | | | | | | | l_obc_south=.false. | | | | | | | | | | | file_obc_ogcm_s='./‘ | | | | | | | | | | | l_obc_north=.false. | | | | | | | | | | | file_obc_ogcm_n='./‘ | | | | | | | | | | | l_obc_east=.false. | | | | | | | | | | | file_obc_ogcm_e='./‘ | | | | | | | | | | | l_obc_west=.false. | | | | | | | | | | | file_obc_ogcm_w='./‘ | | | | | +----------------+-----------------------+----------------------------------+------------------------+--------------------------------------------------+ Theme *RIVERS, TRAJECTORIES, TRACKPOINTS, DIAGNOSTIC* ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +----------------+-----------------------+---------------------------------------------+--------------+---------------------------------------------------+ | namelist | namelist file | variable | CPPkey | Observations | +----------------+-----------------------+---------------------------------------------+--------------+---------------------------------------------------+ | | namriv | | :ref:`doc.paraspec` | | file_river='../../inputs/.dat' | | | | | | | | | | | icon=2 | | | | | +----------------+-----------------------+---------------------------------------------+--------------+---------------------------------------------------+ | | namtraj | | :ref:`doc.paraspec` | | file_trajec='tache.dat' | | | | | | | | | | | itypetraj = 3 | | | | | | | | | | | ndtz = 50 | | | | | +----------------+-----------------------+---------------------------------------------+--------------+---------------------------------------------------+ | | namdiag | | :ref:`doc.paraspec` | | l_diag=.false. | | | | | | | | | | | date_startdiag = '01/01/1996 00:00:00' | | | | | | | | | | | date_enddiag = '02/01/2001 18:00:01' | | | | | | | | | | | file_diag='diag.gdg51' | | | | | | | | | | | l_points=.false. | | | | | | | | | | | file_point='points.dat' | | | | | +----------------+-----------------------+---------------------------------------------+--------------+---------------------------------------------------+ Theme *TIDE* ^^^^^^^^^^^^^^^ +----------------+---------------------+----------------------------------------------------+-----------------------+---------------------------------------------------------+ | namelist | namelist file | variable | CPPkey | Observations | +----------------+---------------------+----------------------------------------------------+-----------------------+---------------------------------------------------------+ | | namtide | | :ref:`doc.paracom`| | l_tide_M2harm=.false. | | key_tide_fes2004 | | | | | | | | | | | key_tide_schwid | | | | | | | | | l_tide_M2statcoef=.T. | | | | effective if l_tide_M2harm=.true. | | | | | | | tide_M2coef=0.0 | | | | | | | | | | | file_tide_M2coef='bidon.dat‘ | | | | effective if l_tide_M2harm=.T. + l_tide_M2statcoef=.F.| | | | | | | file_tide_harmcp='../../inputs/fes2004.nc‘ | | key_tide_fes2004 | | | | | | | | | or file_tide_harmcp='../../inputs/schwiderski.nc’| | key_tide_schwid | | | | | | | | | l_tide_admittance=.false. | | | | | | | | | | | l_genpot=.false. | | | | | +----------------+---------------------+----------------------------------------------------+-----------------------+---------------------------------------------------------+ Theme *ATMOSPHERICAL FIELDS* ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +----------------+-----------------------+---------------------------------+------------------------+----------------------------------------------------------+ | namelist | namelist file | variable | CPPkey | Observations | +----------------+-----------------------+---------------------------------+------------------------+----------------------------------------------------------+ | | nammeteo | | :ref:`doc.paraspec` | | imeteo_dragtype=0 | | | | type of surface drag coefficient | | | | | | | | | | | 0 -> constant value (= cds) if imeteo_exchtype=0 | | | | | | | | | | | 1 -> large and pond (1981) | | | | | | | | | | | 2 -> smith and banke (1975) | | | | | | | | | | | 3 -> geernaert et al. (1986) | | | | | | | | | | | 4 -> charnock's relation (1955) | | | | | | | imeteo_exchtype=0 | | | | dependency on air-sea temperature difference for | | | | | | | | | | | surf drag coefficient and thermal exchange coefficient | | | | | | | | | | | = 0 -> no dependence on tdif | | | | | | | | | | | = 1 -> as function of tdif | | | | | | | | | | | imeteo_dragtype and imeteo_exchtype not used if | | | | | | | | | | | l_meteo_hom=T or l_meteo_stat=T | | | | | | | paref=101500.0 | | | | | | | | | | | cds=0.0012 | | | | | | | | | | | l_sflx_rpa=.false. ... | | | | | | | | | | | name_sflx_sat=‘sat‘ ... | | | | | +----------------+-----------------------+---------------------------------+------------------------+----------------------------------------------------------+ Theme *WIND FIELD* ^^^^^^^^^^^^^^^^^^ +----------------+-----------------------+----------------------------------------+------------------------+----------------------------------------------------------+ | namelist | namelist file | variable | CPPkey | Observations | +----------------+-----------------------+----------------------------------------+------------------------+----------------------------------------------------------+ | | nammeteoc | | :ref:`doc.paracom` | | l_meteo_stat = .true. | | | | To use constant wind field or to read a file .dat | | | | | | | l_meteo_hom = .true. | | | | | | | | | | | wind_veloc = 0.0 | | | | | | | | | | | wind_dir = 275.0 | | | | | | | | | | | file_meteo = 'bidon.dat' | | | | | +----------------+-----------------------+----------------------------------------+------------------------+----------------------------------------------------------+ Theme *RADIATIVE HEAT FLUX* ^^^^^^^^^^^^^^^^^^^^^^^^^^^ +----------------+-----------------------+--------------------------------+------------------------+----------------------------------------------------------+ | namelist | namelist file | variable | CPPkey | Observations | +----------------+-----------------------+--------------------------------+------------------------+----------------------------------------------------------+ | | namthermo | | :ref:`doc.paraspec` | | l_sflx_radlossbot=.false. | | | | | | | | | | | l_sflx_solarcst=.true. | | | | | | | | | | | sflx_solarcst=0.0 | | | | | +----------------+-----------------------+--------------------------------+------------------------+----------------------------------------------------------+ Theme *STATE EQUATION* ^^^^^^^^^^^^^^^^^^^^^^ +----------------+-----------------------+--------------------------------+------------------------+---------------------------------------------------------+ | namelist | namelist file | variable | CPPkey | Observations | +----------------+-----------------------+--------------------------------+------------------------+---------------------------------------------------------+ | | nmlthermo | | :ref:`doc.paramain` | | rhoref=1027.34 | | | | | | | | | | | saliref=35.5 | | | | | | | | | | | tetaref=10.0 | | | | | | | | | | | l_stateeq_lin=.true. | | | | 3D | | | | | | | saliref_lin=35.5 | | | | 3D | | | | | | | tetaref_lin=10.0 | | | | 3D | +----------------+-----------------------+--------------------------------+------------------------+---------------------------------------------------------+ Theme *THERMODYNAMICS* ^^^^^^^^^^^^^^^^^^^^^^ +----------------+-----------------------+-----------------------------+------------------------+----------------------------------------+ | namelist | namelist file | variable | CPPkey | Observations | +----------------+-----------------------+-----------------------------+------------------------+----------------------------------------+ | | nmlthermo | | :ref:`doc.paramain` | | rhoair=1.25 | | | | | | | | | | | chp=3986.0 | | | | | | | | | | | coext=0.1 | | | | | +----------------+-----------------------+-----------------------------+------------------------+----------------------------------------+ Theme *EQUATION OF MOVEMENT* ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +----------------+-----------------------+--------------------------------+------------------------+----------------------------------+ | namelist | namelist file | variable | CPPkey | Observations | +----------------+-----------------------+--------------------------------+------------------------+----------------------------------+ | | namfrot | | :ref:`doc.paraspec` | | l_incbotstress=.true. | | | | | | | | | | | botstressmax=3.0 | | | | 2D | +----------------+-----------------------+--------------------------------+------------------------+----------------------------------+ Theme *ADVECTION OF TRACERS* ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +----------------+-----------------------+--------------------------------+------------------------+---------------------------------+ | namelist | namelist file | variable | CPPkey | Observations | +----------------+-----------------------+--------------------------------+------------------------+---------------------------------+ | | nmladvtra | | :ref:`doc.paramain` | | qmax = 8.0 | | | | | | | | | | | qmaxz = 10.0 | | | | 3D | +----------------+-----------------------+--------------------------------+------------------------+---------------------------------+ Theme *VISCOSITY* ^^^^^^^^^^^^^^^^^^^ +----------------+-----------------------+-------------------------------+------------------------+----------------------------------------------------------+ | namelist | namelist file | variable | CPPkey | Observations | +----------------+-----------------------+-------------------------------+------------------------+----------------------------------------------------------+ | | namvisc | | :ref:`doc.paraspec` | | l_smagor=.false. | | | | 3D | | | | | | | vismin=0.1 | | | | vismin, vismax, cosmag used for l_smagor=T | | | | | | | vismax=700.0 | | | | | | | | | | | cosmag=0.27 | | | | | | | | | | | fvisc=5.0 | | | | | | | | | | | sponge_nbcell=5 | | | | | | | | | | | vismul=5.0 | | | | | | | | | | | l_spongs=.false. | | | | | | | | | | | l_spongn=.false. | | | | | | | | | | | l_sponge=.false. | | | | | | | | | | | l_spongw=.false. | | | | | +----------------+-----------------------+-------------------------------+------------------------+----------------------------------------------------------+ Theme *DIFFUSION* ^^^^^^^^^^^^^^^^^^ +----------------+-----------------------+----------------------------+------------------------+----------------------------------+ | namelist | namelist file | variable | CPPkey | Observations | +----------------+-----------------------+----------------------------+------------------------+----------------------------------+ | | namdiff | | :ref:`doc.paraspec` | | kx = 1.0 | | | | | | | | | | | ky = 1.0 | | | | | +----------------+-----------------------+----------------------------+------------------------+----------------------------------+ Theme *TURBULENCE* ^^^^^^^^^^^^^^^^^^^^ +----------------+-----------------------+-------------------------------------+----------------+-------------------------------+ | namelist | namelist file | variable | CPPkey | Observations | +----------------+-----------------------+-------------------------------------+----------------+-------------------------------+ | | namturb | | :ref:`doc.paraspec` | | z0bot=0.0035 | | | | 3D | | | | | | | z0surf | | | | 3D | | | | | | | hminfrot | | | | 2D | | | | | | | hmaxfrot | | | | 2D | | | | | | | turb_nbeq =0 | | | | 2D | | | | | | | turb_0eq_option =2 | | | | 3D | | | | | | | turb_2eq_option=2 | | | | 3D | | | | | | | bgdiff=1.0e-6 | | | | if turb_nbeq=2 3D | | | | | | | nzinit=1.0e-4 | | | | 3D | | | | | | | kzinit=1.0e-4 | | | | 3D | | | | | | | l_stability=.false. | | | | | +----------------+-----------------------+-------------------------------------+----------------+-------------------------------+ Theme *NETCDF REFERENCE (OCO 1.2)* ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +-----------------+-----------------------+-------------------------------------+-----------------+------------------------------+ | namelist | namelist file | variable | CPPkey | Observations | +-----------------+-----------------------+-------------------------------------+-----------------+------------------------------+ | | nmlconvention | | :ref:`doc.paramain` | | riog_valid_min ...=-50.0 | | | | | | | | | | | riog_valid_max ...=5000.0 | | | | | | | | | | | cg_conv_title=CONF | | | | | | | | | | | cg_conv .... | | | | | +-----------------+-----------------------+-------------------------------------+-----------------+------------------------------+ .. toctree:: :maxdepth: 2 doc.paracomain doc.paraspec doc.parasubs