SURFEX

A few recommendations from Rimvydas Jasinskas

2015-03-03T09:16:11Z

Try to avoid these:

identically named different variables in different modules
explicit kinds (except where needed for I/O or computationally sensitive algorithms)
tab and non ASCII characters (specially in namelists)
pointer like structures in structures (compiler bugs, very hard to debug).

A few rules for programming (from Meso-NH)

2012-04-17T14:33:56Z

The following few rules are intended for SURFEX developers. They must be seen as a facility to read and update the code more than a constraint.

The DOCTOR norm must be respected, following article193.
Every routine must include the command IMPLICIT NONE at the beginning, and therefore every variable must be declared.
A namelist for developers is available for all the programs (NAM_BLANK declared in the module MODN_BLANK and the associated declarative module MODD_BLANK) with a lot of variables not used in the standard code. The use of these modules is advised.
If the introduction of a new namelist NAM_xxx is absolutely necessary, a namelist module (MODN_xxx) and a declarative module (MODD_xxx) must be declared.
An objective is to limit the duplication of the code. Therefore, a subroutine or a function aaa, included with a CONTAINS at the end of the routine yyy.f 90 must be only called in yyy. If it is necessary to call again this routine aaa in an other routine zzz, it mustn't be duplicated with a CONTAINS in the routine zzz.f 90. A new routine aaa.f 90 must be created, and will be called both in yyy and zzz. As a general rule, the use of the CONTAINS must be limited to low level routines.
You can't use modules with $n in routines without $n.

The DOCTOR norm (from Meso-NH)

2012-04-17T14:20:01Z

The SURFEX code follows the DOCTOR norm. We only recall the following simple rules for prefixing the variable names :

type status	INTEGER	REAL	LOGICAL	CHARACTER	TYPE
global or MODULE	N	X	L	C	T
dummy arguments	K	P	O	H	TP
local variables	I	Z	G	Y	TZ
loop control	J	-	-	-	-
PARAMETER	JP	PP	LP	YP	-
SAVE	IS	ZS	GS	YS	TS

Prefixing module names : The modules which contain only:
- Declarative instructions have the prefix MODD ;
- Executive instructions have the prefix MODE ;
- Interface instructions have the prefix MODI ;
- Namelists have the prefix MODN .

Modifications of the covers files for ECOCLIMAP

2011-11-25T17:16:21Z

The mode_cover files are replaced by some ASC/BIN files ( ecoclimapI_covers_param.bin/dat, ecoclimapII_eu_covers_param.bin/dat, ecoclimapII_af_covers_param.bin/dat), with a little program to convert data from one format to the other, convert_ecoclimap_param.f90.

These files are present in directory MY_RUN/ECOCLIMAP.

Possible modifications can be done in the ASC files, then the f90 program has to be adapted to read these ASC modified files.

And the Surfex subroutine that reads theses files too: read_covers_param.F90.

Keys of C-precompilation

2011-11-25T17:15:40Z

For the different possible types of I/O files:

Until before v7, to manage the types of i/o files not present in certain configurations, some dummy files were needed.

Now, keys of precompilation (1 by type of files) are used.

When, in the code, there is a reference to a particular type of file, lines must be framed byÂ :

#ifdef SFX_ASC

#endif

for example for the ASC format.

Keys associated to I/O types are SFX_ASC, SFX_TXT, SFX_BIN, SFX_OL, SFX_LFI, SFX_FA, SFX_MNH, SFX_ARO, SFX_NC.

For GELATO:

Not to require GELATO files from the coupled part, it's needed to compile with the key -Din_surfex.

For OASIS:

To compile OASIS in surfex offline, the key SFXOASIS is used.

Suppression of the allocatable arrays in the time loop of the model

2011-11-25T17:14:00Z

The allocatable arrays have been suppressed (in principle) from the time loop of the model (DO JSURF_STEP=1,INB_ATM). So, no new allocatable arrays may be added.

- Rules of coding

Reading of NAMELISTS in one time at the beginning

2011-11-25T17:12:54Z

For the steps PREP and INIT, the reading of namelists is effected by a subroutine READ_ALL_NAMELISTS which is called by the main programs prep.F90 and offline.F90.

In case of the add of a new namelist, it will be now requested to copy the way the reading is now done.

Compilation and modules of interfaces self-generated

2011-11-25T17:00:48Z

Two options of compilation for gfortran are automatically activated (Rules.LXgfortran.mk)Â :

-fbacktrace to traceback compilation errors
-fopenmp to verify the directives openmp in the code

From Surfex v7, the modules of interfaces were suppressed in files that contain only one subroutine.

Nevertheless, they are automatically generated during the compilation.

So that the USE MODI_... are still topical.

They are not always necessary (as it was the case before), but they allow to verify the consistency between the arguments passed at the call of a subroutine and the declared arguments into the subroutine.

So it's recommended to include them for all called subroutines.

In case of compilation problems, the suppression of interfaces allows that the indicated line is this of the original file present in SURFEX directory.

A script to include missing USE MODI_... exists here.