Reorganisation and docs

kennethassogba · Nov 15, 2024 · 5ae472f · 5ae472f
1 parent 80ea86b
commit 5ae472f
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 43 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 Demeter<sup>1</sup> is a modern and open source deterministic neutron transport code for reactor simulations. The code is designed to perform 3D fixe source and eigenvalue calculations by solving the multi-group neutron transport equation.
 
-Numerically, the physics part is coded in C++ with Python as a user interface for easy and fast utilisations. Cmake is used to build configurations.
+The physics is coded in C++ with Python as user interface for easy and fast usage.
 
 <sub>1. DEterMinistic nEutron Transport solvER</sub>
 
@@ -14,7 +14,10 @@ Numerically, the physics part is coded in C++ with Python as a user interface fo
 - [x] Add AddressSanitizer, ThreadSanitizer, MemorySanitizer.
 - [x] Setup Github Action.
 - [x] Improve Github Action, by fixing OpenMP not found and with recent version of compiler and Eigen.
-- [x] Choose a code style (Google style eg) and setup a linter.
+- [x] Setup clang-format with Google style.
+- [ ] Setup clang-tidy.
+- [ ] Fix how to launch clang-tidy locally and on action.
+- [ ] Setup gcc analizer.
 - [ ] Code Goemetry.
 - [ ] Code mesh.
 - [ ] Setup directory structure => vector-of-bool/pitchfork.

diff --git a/src/model/core.cpp → src/model/cell.cpp b/src/model/core.cpp → src/model/cell.cpp
diff --git a/src/model/core.hpp → src/model/cell.hpp b/src/model/core.hpp → src/model/cell.hpp
diff --git a/src/model/spec.md b/src/model/spec.md
diff --git a/src/spec.md b/src/spec.md
@@ -0,0 +1,33 @@
+# Spec
+
+A good way to get early adopters might be to be a drop-in replacement for OpenMOC or OpenMC.
+But we choose to design a simplified interface.
+
+## Material and Cross section
+
+- Material : describe a material with its cross-sections
+  - vec sigma_t total or transport cross-section
+  - vec sigma_a absorption cross-section
+  - mat sigma_s scattering cross-section
+  - vec sigma_f fission cross-section
+  - vec nu_sigma_f nu*fission
+  - vec chi
+  - bool fissible
+  - str name (optional)
+
+## Geometry
+
+Cell
+PinCell : cell with concentric annular regions
+Lattice : set or PinCell or set of Lattice
+
+Symetry 1/2 1/8
+Boundary coundition : Vaccum Reflexion
+
+## Usage example
+
+Na
+
+## Solvers
+
+Na