Skip to content

Commit

Permalink
Add missing README.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
gdgirard committed Dec 12, 2024
1 parent 8a5c51b commit 8b5b68b
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 6 deletions.
1 change: 1 addition & 0 deletions src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
9 changes: 9 additions & 0 deletions src/math_tools/README.md
Original file line number Diff line number Diff line change
@@ -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|)`$.
6 changes: 0 additions & 6 deletions src/utils/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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|)`$.
1 change: 1 addition & 0 deletions tests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 8b5b68b

Please sign in to comment.