Guide for good coding - Revision history

Emillour: /* To know when coding with a code parallelized with OpenMP */

2025-03-17T15:31:05Z

‎To know when coding with a code parallelized with OpenMP

Aurelien.falco: /* Export variables in the diagfi.nc file */

2025-03-05T10:05:06Z

‎Export variables in the diagfi.nc file

Maxime Maurice: /* Add a new user-input variable in physics modules */

2025-02-28T09:06:16Z

‎Add a new user-input variable in physics modules

Aurelien.falco: /* Add a new user-input variable in physics modules */

2025-02-28T08:48:32Z

‎Add a new user-input variable in physics modules

Aurelien.falco: /* Add a new user-input variable in physics modules */

2025-02-28T08:47:46Z

‎Add a new user-input variable in physics modules

Maxime Maurice at 09:51, 23 January 2025

2025-01-23T09:51:44Z

Emillour at 11:17, 23 October 2023

2023-10-23T11:17:42Z

Emillour at 06:28, 23 October 2023

2023-10-23T06:28:50Z

Abierjon: /* To know when coding with a code parallelized with OpenMP */

2023-05-10T11:46:55Z

‎To know when coding with a code parallelized with OpenMP

Abierjon: /* To know when coding with a code parallelized with OpenMP */

2023-05-10T11:46:12Z

‎To know when coding with a code parallelized with OpenMP

@@ Line 237: / Line 237: @@
 !$OMP THREADPRIVATE(variable)
 </syntaxhighlight>
 == General guide ==

@@ Line 169: / Line 169: @@
 == Export variables in the diagfi.nc file ==
-Simply use the writediagfi routine:
-<syntaxhighlight lang="Fortran" line>
+The new way is to use the '''write_output()''' method as described in [[diagfi.nc]] page. It should look like this:
 call writediagfi(ngrid,"name_in_netcdf_file","description_in_netcdf_file","units",dimensions,myvariable)
 </syntaxhighlight>

@@ Line 150: / Line 150: @@
 How to properly add a new variable read from callphys.def
 * Declare your variable in the callkeys module:
 <syntaxhighlight lang="Fortran" line>
@@ Line 156: / Line 155: @@
 !$OMP THREADPRIVATE(myvariable)
 </syntaxhighlight>
-* Import it your module:
+* Import it from the callkeys module into your module:
 <syntaxhighlight lang="Fortran" line>
 use callkeys_mod, only myvariable
 </syntaxhighlight>
-* Look for the flag in callphys.def ('myvariableflag' in the example below) during physics' initialization, or give it a default value if not found (666 in the example below) (in module inifis_mod.F90 for the Generic model, conf_phys for the Mars PCM):
+* Look for the flag in callphys.def ('myvariableflag' in the example below) during physics' initialization, or give it a default value if not found (666 in the example below) (in module inifis_mod.F90 for the Generic, Pluto and Titan PCMs, conf_phys for Mars and Venus PCMs):
 <syntaxhighlight lang="Fortran" line>
 if (is_master) write(*,*)trim(rname)//": Variable description"
@@ Line 167: / Line 166: @@
 if (is_master) write(*,*)trim(rname)//": myvariable = ",myvariable
 </syntaxhighlight>
-notice that you don't need to import your variable specifically in inifis_mod because all variables from callkeys_mod are imported.
+notice that you don't need to import your variable specifically into inifis_mod / conf_phys because all variables from callkeys_mod are imported.
 == Export variables in the diagfi.nc file ==

@@ Line 160: / Line 160: @@
 use callkeys_mod, only myvariable
 </syntaxhighlight>
-* Look for the flag in callphys.def ('myvariableflag' in the example below) during physics' initialization, or give it a default value if not found (666 in the example below) (in module inifis_mod.F90):
+* Look for the flag in callphys.def ('myvariableflag' in the example below) during physics' initialization, or give it a default value if not found (666 in the example below) (in module inifis_mod.F90 for the Generic model, conf_phys for the Mars PCM):
 <syntaxhighlight lang="Fortran" line>
 if (is_master) write(*,*)trim(rname)//": Variable description"
@@ Line 167: / Line 167: @@
 if (is_master) write(*,*)trim(rname)//": myvariable = ",myvariable
 </syntaxhighlight>
-notice that you don't need to import your variable specifically in inifis_mod (conf_phys for the Mars PCM) because all variables from callkeys_mod are imported.
+notice that you don't need to import your variable specifically in inifis_mod because all variables from callkeys_mod are imported.
 == Export variables in the diagfi.nc file ==

@@ Line 167: / Line 167: @@
 if (is_master) write(*,*)trim(rname)//": myvariable = ",myvariable
 </syntaxhighlight>
-notice that you don't need to import your variable specifically in inifis_mod because all variables from callkeys_mod are imported.
+notice that you don't need to import your variable specifically in inifis_mod (conf_phys for the Mars PCM) because all variables from callkeys_mod are imported.
 == Export variables in the diagfi.nc file ==

← Older revision		Revision as of 09:51, 23 January 2025
Line 145:		Line 145:

	One should only use (import) a variable from a module if it used as "read-only" information. e.g. gravity constant, aerosol optical properties, etc.		One should only use (import) a variable from a module if it used as "read-only" information. e.g. gravity constant, aerosol optical properties, etc.
		+
		+	== Add a new user-input variable in physics modules ==
		+
		+	How to properly add a new variable read from callphys.def
		+
		+	=== Generic PCM's physics ===
		+	* Declare your variable in the callkeys module:
		+	<syntaxhighlight lang="Fortran" line>
		+	real,save :: myvariable
		+	!$OMP THREADPRIVATE(myvariable)
		+	</syntaxhighlight>
		+	* Import it your module:
		+	<syntaxhighlight lang="Fortran" line>
		+	use callkeys_mod, only myvariable
		+	</syntaxhighlight>
		+	* Look for the flag in callphys.def ('myvariableflag' in the example below) during physics' initialization, or give it a default value if not found (666 in the example below) (in module inifis_mod.F90):
		+	<syntaxhighlight lang="Fortran" line>
		+	if (is_master) write(,)trim(rname)//": Variable description"
		+	myvariable=666. ! default value
		+	call getin_p("myvariableflag",myvariable)
		+	if (is_master) write(,)trim(rname)//": myvariable = ",myvariable
		+	</syntaxhighlight>
		+	notice that you don't need to import your variable specifically in inifis_mod because all variables from callkeys_mod are imported.
		+
		+	== Export variables in the diagfi.nc file ==
		+	Simply use the writediagfi routine:
		+	<syntaxhighlight lang="Fortran" line>
		+	call writediagfi(ngrid,"name_in_netcdf_file","description_in_netcdf_file","units",dimensions,myvariable)
		+	</syntaxhighlight>

	== Naming variables convention ==		== Naming variables convention ==

@@ Line 212: / Line 212: @@
 == External resources ==
-* You can check this page for some guidelines and advice: https://www.fortran90.org/src/best-practices.html
+You can check these pages for some guidelines and advice:
 [[Category:Generic-Model]]

@@ Line 6: / Line 6: @@
 First you can define all the variable that belongs to the module and could be used at another place.
 A good thing is also to create a subroutine that allocate and initialise module variables.
-If the variable is only modified inside the module it should be taged as protected.
+If the variable is only modified inside the module it should be tagged as protected.
 If the variable belongs only to the module it can be specified to be private.
@@ Line 177: / Line 177: @@
 == How to use the INTENT ==
-Argument of a function can come in 3 different way: IN, OUT, INOUT.
+Argument of a routine/function can come in 3 different way: IN, OUT, INOUT.
 All arguments should be specified as :
 * intent(in) : input only, i.e. not modified by the routine (or routines it passes the argument on to)
@@ Line 187: / Line 187: @@
 * '''In english'''
 * '''As much as possible'''
-* '''By using <code>!</code>''' (also known as the "bang" character) rather than <code>c</code> (which is not interpreted as a comment by fortran90+ compilers)
+* '''By using <code>!</code>''' (also known as the "bang" character) rather than <code>c</code> (which is not interpreted as a comment if in free form, e.g. .F90 files)
 * '''Variable definition''' : explain what it is, the dimension, the units etc...
 * '''Subroutine''' : Explain what it does, who wrote it, who modify it and why if it is a big change
@@ Line 202: / Line 202: @@
 == General guide ==
-* Create .F90 instead of .F
+* Always check your modifications and additions by compiling and running in "debug" mode!
-* Delete unused argument in a function call if you see one
+* Create .F90 (i.e. free form) instead of .F (i.e. fixed form); but this doesn't mean you should make lines too long!
 * Delete unused variables
-* Choose meaningful names of variables
+* Choose meaningful names for variables and mention physical unit where they are declared
 * Don't hesitate to comment as much as possible, a code is never too commented
 * Delete unused commented code lines
 [[Category:Generic-Model]]

@@ Line 195: / Line 195: @@
 == To know when coding with a code parallelized with OpenMP ==
 In Fortran, any variable from a <code>module</code>, written in a <code>COMMON</code>, declared <code>SAVE</code> or initialized at the declaration (using <code>DATA</code> or <code>=</code>) is considered a ''static variable''.
-When your code is parallelized using OpenMP, these static variables are SHARED by default. '''For the PCM, in 90% cases, you want each thread on which the code is parallelized to have its own private version of the variable''', so you should add, after the declaration of your variable, the following line:
+When your code is parallelized using OpenMP, these static variables are SHARED by default. '''For the PCM physics, in 90% cases, you want each thread on which the code is parallelized to have its own private version of the variable''', so you should add, after the declaration of your variable, the following line:
 <syntaxhighlight lang="Fortran">
 !$OMP THREADPRIVATE(variable)