Skip to content

Changes

Page history
Update Code Architecture and Organization authored by Alain O' Miniussi's avatar Alain O' Miniussi
Hide whitespace changes
Inline Side-by-side
Developer's-corner/Code-Architecture-and-Organization.md
View page @ d9e557ae
...@@ -145,17 +145,17 @@ This object store the data as a [std::valarray<double>](http://www.cplusplus.com ...@@ -145,17 +145,17 @@ This object store the data as a [std::valarray<double>](http://www.cplusplus.com
Used to represent think la velocities, they are mostly a triplet of **[ScalarField](#scalarfield)**. Used to represent think la velocities, they are mostly a triplet of **[ScalarField](#scalarfield)**.
## [Disk](https://disc.pages.oca.eu/fargOCA/public/doxy/classfargOCA_1_1Disk.html) ### [Disk](https://disc.pages.oca.eu/fargOCA/public/doxy/classfargOCA_1_1Disk.html)
A **Disk** object represent the state of the system. It keep track of the gas state through a set of **ScalarField**s representing the density, energy, temperature, velocity etc... of the gas. A **Disk** object represent the state of the system. It keep track of the gas state through a set of **ScalarField**s representing the density, energy, temperature, velocity etc... of the gas.
Part of this description is optional and will only exists if required by the physic considered in a given simulation. Part of this description is optional and will only exists if required by the physic considered in a given simulation.
## [PlanetarySystem](https://disc.pages.oca.eu/fargOCA/public/doxy/classfargOCA_1_1PlanetarySystem.html) ### [PlanetarySystem](https://disc.pages.oca.eu/fargOCA/public/doxy/classfargOCA_1_1PlanetarySystem.html)
Mostly a set of named planets with position, velocity, mass state. Mostly a set of named planets with position, velocity, mass state.
## [DiskPhysic](https://disc.pages.oca.eu/fargOCA/public/doxy/classfargOCA_1_1DiskPhysic.html) ### [DiskPhysic](https://disc.pages.oca.eu/fargOCA/public/doxy/classfargOCA_1_1DiskPhysic.html)
This is a read only object representing the physical characteristic of the simulation. There is typically only one instance in the whole program (since all the actors are considering the same physic... for now). This is a read only object representing the physical characteristic of the simulation. There is typically only one instance in the whole program (since all the actors are considering the same physic... for now).
It mimic quite closely the configuration file provided by the user. It mimic quite closely the configuration file provided by the user.
...@@ -169,7 +169,7 @@ To check that the radiative part of the physic has been requested, we will use a ...@@ -169,7 +169,7 @@ To check that the radiative part of the physic has been requested, we will use a
} }
``` ```
## [Simulation](https://disc.pages.oca.eu/fargOCA/public/doxy/classfargOCA_1_1Simulation.html) ### [Simulation](https://disc.pages.oca.eu/fargOCA/public/doxy/classfargOCA_1_1Simulation.html)
This is the "engine" of the simulation. This is the "engine" of the simulation.
...@@ -177,9 +177,12 @@ The disk geometry and physic configuration are described through a set of classe ...@@ -177,9 +177,12 @@ The disk geometry and physic configuration are described through a set of classe
The "almost" is important, as in the mid/long term, it will allow close to trivial implementation of multi-grid decomposition by providing one instance by sub-domain. The "almost" is important, as in the mid/long term, it will allow close to trivial implementation of multi-grid decomposition by providing one instance by sub-domain.
* **DiskPhysic** provide the physical parameter of the disk. It is close to a direct mapping of the user provided property tree. ### [GridDispatch](https://disc.pages.oca.eu/fargOCA/public/doxy/classfargOCA_1_1GridDispatch.html)
* **SystemPhysic** play a similar role for the planetary system. It describe the discretisation of the (possibly flat) cylinder containing the gas. That include the grid points (stored in **GridCoords**) aperture, etc.. and some useful pre computed values. More than one **GridDispatch** object exist when the grid resolution is modified and a polar grid need to be re-mapped.
* **GridDispatch** is . It describe discretisation of the (possibly flat) cylinder containing the gas. That include the grid points, aperture, etc.. and some useful pre computed values. More than one **GridDispatch** object exist when the grid resolution is modified and a polar grid need to be re-mapped.
### [GridCoords](https://disc.pages.oca.eu/fargOCA/public/doxy/classfargOCA_1_1GridCoords.html)
The grid coordinates.
## Boundaries Conditions ## Boundaries Conditions
......