... | @@ -127,7 +127,7 @@ SimulationTracker o--> Simulation |
... | @@ -127,7 +127,7 @@ SimulationTracker o--> Simulation |
|
|
|
|
|
The code is mostly an Objet Oriented[^2] library. Two two small programs, *fargoInit* (in [mainInit.cpp](https://gitlab.oca.eu/DISC/fargOCA/-/blob/master/mainInit.cpp)) and *fargOCA* (in [mainOCA.cpp](https://gitlab.oca.eu/DISC/fargOCA/-/blob/master/mainOCA.cpp)), are provided to initialize the simulation and to run it, respectivelly.
|
|
The code is mostly an Objet Oriented[^2] library. Two two small programs, *fargoInit* (in [mainInit.cpp](https://gitlab.oca.eu/DISC/fargOCA/-/blob/master/mainInit.cpp)) and *fargOCA* (in [mainOCA.cpp](https://gitlab.oca.eu/DISC/fargOCA/-/blob/master/mainOCA.cpp)), are provided to initialize the simulation and to run it, respectivelly.
|
|
|
|
|
|
The code of the class **ClassName** is usually dispatched between a header file in *src/className.hpp* and a source file in *src/className.cpp*.
|
|
The code of the class **ClassName** is usually dispatched between a header file in *include/className.hpp* and a source file in *src/className.cpp*.
|
|
|
|
|
|
Utilities are in the *utils* directory.
|
|
Utilities are in the *utils* directory.
|
|
|
|
|
... | @@ -153,10 +153,19 @@ Part of this description is optional and will only exists if required by the phy |
... | @@ -153,10 +153,19 @@ Part of this description is optional and will only exists if required by the phy |
|
|
|
|
|
## [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.
|
|
|
|
|
|
## [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 caracteristic 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.
|
|
|
|
|
|
|
|
To check that the radiative part of the physic has been requested, we will use a piece of code like (note that as radiative is a special case of adiabatic, we fist check that adiabatic physic is also requested):
|
|
|
|
```
|
|
|
|
if (physic().adiabatic && physic().adiabatic->radiative) {
|
|
|
|
... do what need to be done
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
## [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)
|
|
|
|
|
... | | ... | |