Naming Conventions

The purpose of the naming conventions is to use prefix letters to classify model variables. These conventions allow the variable type to be easily known and rapidly identified. The naming conventions are summarised in the Table below:


Type

/ Status

integer real logical character structure double

precision

complex
public

or

module variable

m n

but not

nn_ np_

a b e f g h o q r

t to x

but not

fs rn_

l

but not

lp ld

ll ln_

c

but not

cp cd

cl cn_

s

but not

sd sd

sl sn_

d

but not

dp dd

dl dn_

y

but not

yp yd

yl yn

dummy

argument

k

but not

kf

p

but not

pp pf

ld cd sd dd yd
local

variable

i z ll cl sl dl yl
loop

control

j

but not

jp

           
parameter jp np_ pp lp cp sp dp yp
namelist nn_ rn_ ln_ cn_ sn_ dn_ yn_
CPP

macro

kf fs

         

N.B. Parameter here, in not only parameter in the FORTRAN acceptation, it is also used for code variables that are read in namelist and should never been modified during a simulation. It is the case, for example, for the size of a domain (jpi,jpj,jpk).

Gurvan Madec and the NEMO Team
NEMO European Consortium2016-11-22