From 8b5b68b0bf99b90fd48ac8fa623aa757a7d19eef Mon Sep 17 00:00:00 2001
From: Virginie Grandgirard <virginie.grandgirard@cea.fr>
Date: Thu, 12 Dec 2024 16:17:52 +0100
Subject: [PATCH] Add missing README.md.

---
 src/README.md            | 1 +
 src/math_tools/README.md | 9 +++++++++
 src/utils/README.md      | 6 ------
 tests/README.md          | 1 +
 4 files changed, 11 insertions(+), 6 deletions(-)
 create mode 100644 src/math_tools/README.md

diff --git a/src/README.md b/src/README.md
index e5754394e..f7bb2dcf3 100644
--- a/src/README.md
+++ b/src/README.md
@@ -13,6 +13,7 @@ The `src/` folder contains all the code necessary to build a gyrokinetic semi-La
 - [interpolation](./interpolation/README.md) - Code describing interpolation methods.
 - [io](./io/README.md) - Code describing tools for inputting and outputting data in a simulation.
 - [mapping](./mapping/README.md) - Code describing tools for handling different coordinate systems.
+- [math_tools](./math_tools/README.md) - Code describing math tools functions.
 - [multipatch](./multipatch/README.md) - Code describing multipatch geometry.
 <!-- - [paraconfpp](./paraconfpp/README.md) - Paraconf utility functions. -->
 - [mpi\_parallelisation](./mpi_parallelisation/README.md) - Code describing the MPI parallelisation.
diff --git a/src/math_tools/README.md b/src/math_tools/README.md
new file mode 100644
index 000000000..2d012cf67
--- /dev/null
+++ b/src/math_tools/README.md
@@ -0,0 +1,9 @@
+# Utility Functions
+
+This folder contains mathematical classes and functions.
+
+## Utility tools
+
+The l\_norm\_tools.hpp file contains functions computing the infinity norm. For now, it computes the infinity norm of 
+- a double: $`\Vert x \Vert_{\infty} = x`$; 
+- a coordinate: $`\Vert x \Vert_{\infty} = \max_{i} (|x_i|)`$.
diff --git a/src/utils/README.md b/src/utils/README.md
index af7c7d14f..31b8ccd8c 100644
--- a/src/utils/README.md
+++ b/src/utils/README.md
@@ -5,9 +5,3 @@ This folder contains classes and functions which facilitate the writing of the r
 The class ddcHelper exists to provide functionalities which are currently missing from DDC.
 
 The class NDTag exists to provide a way to group directional tags together. This is notably useful in order to create a vector field.
-
-## Utility tools
-
-The utils\_tools.hpp file contains functions computing the infinity norm. For now, it computes the infinity norm of 
-- a double: $`\Vert x \Vert_{\infty} = x`$; 
-- a coordinate: $`\Vert x \Vert_{\infty} = \max_{i} (|x_i|)`$.
diff --git a/tests/README.md b/tests/README.md
index 85fd344a6..49524c429 100644
--- a/tests/README.md
+++ b/tests/README.md
@@ -10,6 +10,7 @@ It is broken up into the following sub-folders:
  - geometryVparMu - Tests in the vpar-mu geometry.
  - geometryXVx - Tests in the x-vx geometry.
  - geometryXYVxVy - Tests in the x,y-vx,vy geometry.
+ - math_tools - Test for mathematical functions.
  - MPI parallelism - Tests for the templated MPI operators.
  - [multipatch](./multipatch/README.md) - Tests for the classes that work over multipatch geometries.
  - PDE solvers - Tests for the templated Partial Differential Equation solvers.