From 20ed46853778b7b61ed8296be08e7eb46b5ff33e Mon Sep 17 00:00:00 2001 From: Antoine Hoffmann <antoine.hoffmann@epfl.ch> Date: Tue, 25 Oct 2022 16:46:06 +0200 Subject: [PATCH] finalize format of the readme --- README.md | 80 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 41 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index b2922776..dcad3c76 100644 --- a/README.md +++ b/README.md @@ -25,80 +25,82 @@ along with this program. If not, see <https://www.gnu.org/licenses/>. 8. You can obtain various plots and gifs using gyacomo/wk/gyacomo_analysis.m once the simulation is done. The directory where the results are located must be given in the scripts. It is not a function (yet...) // Comment : For some collision operators (Sugama and Full Coulomb) you have to run COSOlver from B.J.Frei first in order to generate the required matrices in gyacomo/iCa folder. // + + # Changelog -4. GYACOMO +### 4.x GYACOMO + +> 4.1 Miller geometry is added and benchmarked for CBC adiabatic electrons - 4.1 Miller geometry is added and benchmarked for CBC adiabatic electrons +>4.0 new naming and opening the code with GNU GPLv3 license - 4.0 new naming and opening the code with GNU GPLv3 license +### 3.x HeLaZ 3D -3. HeLaZ 3D +>3.9 HeLaZ can now evolve electromagnetic fluctuations by solving Ampere equations (benchmarked linearly) - 3.9 HeLaZ can now evolve electromagnetic fluctuations by solving Ampere equations (benchmarked linearly) +>3.8 HeLaZ has been benchmarked for CBC with GENE for various gradients values (see Dimits_fig3.m) - 3.8 HeLaZ has been benchmarked for CBC with GENE for various gradients values (see Dimits_fig3.m) +>3.7 The frequency plane has been transposed from positive kx to positive ky for easier implementation of shear. Also added 3D zpinch geometry - 3.7 The frequency plane has been transposed from positive kx to positive ky for easier implementation of shear. Also added 3D zpinch geometry +>3.6 HeLaZ is now parallelized in p, kx and z and benchmarked for each parallel options with gbms (new molix) for linear fluxtube shearless. - 3.6 HeLaZ is now parallelized in p, kx and z and benchmarked for each parallel options with gbms (new molix) for linear fluxtube shearless. +>3.5 Staggered grid for parallel odd/even coupling - 3.5 Staggered grid for parallel odd/even coupling +>3.4 HeLaZ can run with adiabatic electrons now! - 3.4 HeLaZ can run with adiabatic electrons now! +>3.3 HeLaZ 3D has been benchmarked in fluxtube salphaB geometry linear run with molix (B.J.Frei) code and works now for shear = 0 with periodic z BC - 3.3 HeLaZ 3D has been benchmarked in fluxtube salphaB geometry linear run with molix (B.J.Frei) code and works now for shear = 0 with periodic z BC +>3.2 Stopping file procedure like in GBS is added - 3.2 Stopping file procedure like in GBS is added +>3.1 Implementation of mirror force - 3.1 Implementation of mirror force +>3.0 HeLaZ is now 3D and works like HeLaZ 2D if Nz = 1, the axis were renamed from r and z to x,y and z. Now the parallel direction is ez. All arrays have been extended, diagnostics and analysis too. The linear coefficients are now precomputed with geometry routines. - 3.0 HeLaZ is now 3D and works like HeLaZ 2D if Nz = 1, the axis were renamed (r,z) -> (x,y,z) and now the parallel direction is ez. All arrays have been extended, diagnostics and analysis too. The linear coefficients are now precomputed with lin_coeff_and_geometry routines. +### 2.x MPI parallel version -2. MPI parallel version +>2.7 Versatile interpolation of kperp for the cosolver matrices and corrections done on DGGK - 2.7 Versatile interpolation of kperp for the cosolver matrices and corrections done on DGGK +>2.6 Change of collisionality normalisation (from nu_ei to nu_ii), implementation of FCGK - 2.6 Change of collisionality normalisation (from nu_ei to nu_ii), implementation of FCGK +>2.5 GK cosolver collision implementation - 2.5 GK cosolver collision implementation +>2.4 2D cartesian parallel (along p and kr) - 2.4 2D cartesian parallel (along p and kr) +>2.3 GK Dougherty operator - 2.3 GK Dougherty operator +>2.2 Allow restart with different P,J values (results are not concluents) - 2.2 Allow restart with different P,J values (results are not concluents) +>2.1 First compilable parallel version (1D parallel along kr) - 2.1 First compilable parallel version (1D parallel along kr) +### 1.x Implementation of the non linear Poisson brackets term -1. Implementation of the non linear Poisson brackets term +>1.4 Quantitative study with stationary average particle flux \Gamma_\infty - 1.4 Quantitative study with stationary average particle flux \Gamma_\infty +>1.3 Linear analysis showed that a certain amount of PJ are recquired to trigger mode - 1.3 Linear analysis showed that a certain amount of PJ are recquired to trigger mode +>1.2 Zonal flows are observed in a similar way to Ricci Rogers 2006 with GS2 - 1.2 Zonal flows are observed in a similar way to Ricci Rogers 2006 with GS2 +>1.1 Qualitative test : find similar turbulences as Hasegawa Wakatani system with few moments - 1.1 Qualitative test : find similar turbulences as Hasegawa Wakatani system with few moments +>1.1 Methods in fourier_mod.f90 have been validated by tests on Hasegawa Wakatani system - 1.1 Methods in fourier_mod.f90 have been validated by tests on Hasegawa Wakatani system +>1.1 Methods in fourier_mod.f90 have been validated by tests on Hasegawa Wakatani system - 1.1 Methods in fourier_mod.f90 have been validated by tests on Hasegawa Wakatani system +>1.0 FFTW3 has been used to treat the convolution as a product and discrete fourier transform - 1.0 FFTW3 has been used to treat the convolution as a product and discrete fourier transform +### 0.x Write MOLI matlab solver in Fortran using Monli1D as starting point -0. Write MOLI matlab solver in Fortran using Monli1D as starting point +>0.6 Benchmarks now include Dougherty, Lenard-Bernstein and Full Coulomb collision operators - 0.6 Benchmarks now include Dougherty, Lenard-Bernstein and Full Coulomb collision operators +>0.5 Load COSOlver matrices - 0.5 Load COSOlver matrices +>0.4 Benchmark with MOLI matlab results for Z-pinch (cf. kz_linear script) - 0.4 Benchmark with MOLI matlab results for Z-pinch (cf. kz_linear script) +>0.3 RK4 time solver - 0.3 RK4 time solver +>0.2 implement moment hierarchy linear terms - 0.2 implement moment hierarchy linear terms +>0.1 implement linear Poisson equation in fourier space - 0.1 implement linear Poisson equation in fourier space - - 0.0 go from 1D space to 2D fourier and from Hermite basis to Hermite-Laguerre basis +>0.0 go from 1D space to 2D fourier and from Hermite basis to Hermite-Laguerre basis -- GitLab