From 93e7e646284ded26a310a7d03bc2b08ef184cd3b Mon Sep 17 00:00:00 2001 From: Baptiste LENIAU <baptiste.leniau@subatech.in2p3.fr> Date: Thu, 5 Feb 2015 13:53:08 +0000 Subject: [PATCH] add comments git-svn-id: svn+ssh://svn.in2p3.fr/class@541 0e7d625b-0364-4367-a6be-d5be4a48d228 --- source/trunk/include/CLASSBackEnd.hxx | 2 ++ source/trunk/include/CLASSFacility.hxx | 2 ++ source/trunk/include/CLASSFuel.hxx | 2 ++ source/trunk/include/CLASSFuelPlan.hxx | 2 ++ source/trunk/include/CLASSLogger.hxx | 4 ++++ source/trunk/include/CLASSNucleiFiliation.hxx | 2 ++ source/trunk/include/CLASSObject.hxx | 2 ++ source/trunk/include/DecayDataBank.hxx | 2 ++ source/trunk/include/EquivalenceModel.hxx | 2 ++ source/trunk/include/EvolutionData.hxx | 2 ++ source/trunk/include/FabricationPlant.hxx | 2 ++ source/trunk/include/IrradiationModel.hxx | 2 ++ source/trunk/include/IsotopicVector.hxx | 2 ++ source/trunk/include/PhysicsModels.hxx | 2 ++ source/trunk/include/Pool.hxx | 3 ++- source/trunk/include/Reactor.hxx | 3 ++- source/trunk/include/Scenario.hxx | 3 ++- source/trunk/include/SeparationPlant.hxx | 5 +++-- source/trunk/include/Storage.hxx | 3 ++- source/trunk/include/XSModel.hxx | 3 ++- source/trunk/include/ZAI.hxx | 2 ++ source/trunk/include/ZAIMass.hxx | 3 ++- 22 files changed, 47 insertions(+), 8 deletions(-) diff --git a/source/trunk/include/CLASSBackEnd.hxx b/source/trunk/include/CLASSBackEnd.hxx index 9b355b04f..fb36d17d0 100644 --- a/source/trunk/include/CLASSBackEnd.hxx +++ b/source/trunk/include/CLASSBackEnd.hxx @@ -25,6 +25,8 @@ using namespace std; typedef long long int cSecond; //-----------------------------------------------------------------------------// +//! Class defining the common properties of all back end fuel cycle facilities + /*! Define a CLASS Facility. The aim of these class is to gather all the commom properties of the diff --git a/source/trunk/include/CLASSFacility.hxx b/source/trunk/include/CLASSFacility.hxx index 96d4eccca..2ba95437c 100644 --- a/source/trunk/include/CLASSFacility.hxx +++ b/source/trunk/include/CLASSFacility.hxx @@ -23,6 +23,8 @@ typedef long long int cSecond; class Scenario; //-----------------------------------------------------------------------------// +//! Defines the common properties of all facilities + /*! Define a CLASS Facility. The aim of these class is to gather all the commom properties of the facilities. diff --git a/source/trunk/include/CLASSFuel.hxx b/source/trunk/include/CLASSFuel.hxx index d39826aa7..89c3826e4 100644 --- a/source/trunk/include/CLASSFuel.hxx +++ b/source/trunk/include/CLASSFuel.hxx @@ -22,6 +22,8 @@ using namespace std; //-----------------------------------------------------------------------------// +//! Allows to define PhysicsModels & EvolutionData as a CLASSFuel + /*! Define a CLASS Object. The aim of these class is to handle PhysicsModels & diff --git a/source/trunk/include/CLASSFuelPlan.hxx b/source/trunk/include/CLASSFuelPlan.hxx index 17f0983b9..e0042f747 100644 --- a/source/trunk/include/CLASSFuelPlan.hxx +++ b/source/trunk/include/CLASSFuelPlan.hxx @@ -24,6 +24,8 @@ typedef long long int cSecond; //-----------------------------------------------------------------------------// +//! Allows a Reactor to change its CLASSFuel and/or burnup + /*! Define a CLASS Object. The aim of these class is to allow a Reactor to change its CLASSFuel and/or burnup diff --git a/source/trunk/include/CLASSLogger.hxx b/source/trunk/include/CLASSLogger.hxx index 995650e29..09ec4690a 100755 --- a/source/trunk/include/CLASSLogger.hxx +++ b/source/trunk/include/CLASSLogger.hxx @@ -47,6 +47,8 @@ using namespace std; #define _LOGTYPE_CLASS //-----------------------------------------------------------------------------// +//!handle output stream in CLASS + /*! Define a LogType. The aim of this class is to handle output stream in CLASS. @@ -126,6 +128,8 @@ public: #define _CLASSLogger_CLASS_ //-----------------------------------------------------------------------------// +//! Object to handle output messages + /*! Define a CLASSLogger. The aim of this class is to centralize the all CLASS software message inside a file. diff --git a/source/trunk/include/CLASSNucleiFiliation.hxx b/source/trunk/include/CLASSNucleiFiliation.hxx index 030c75561..9f9452761 100644 --- a/source/trunk/include/CLASSNucleiFiliation.hxx +++ b/source/trunk/include/CLASSNucleiFiliation.hxx @@ -12,6 +12,8 @@ using namespace std; //-----------------------------------------------------------------------------// +//! Handle connection between nuclei (decay/reaction) + /*! Define a nuclei as : Z A I. The aim of this class is to discribe each CLASSNucleiFiliation. It connects nuclei to their daughter nuclei through a nuclear process using the correct branching ratio. diff --git a/source/trunk/include/CLASSObject.hxx b/source/trunk/include/CLASSObject.hxx index 062a9bb21..f18179731 100644 --- a/source/trunk/include/CLASSObject.hxx +++ b/source/trunk/include/CLASSObject.hxx @@ -22,6 +22,8 @@ using namespace std; //-----------------------------------------------------------------------------// +//! Define common proporties of all objects + /*! Define a CLASS Object. The aim of these class is to gather all the commom properties of all CLASS objects. diff --git a/source/trunk/include/DecayDataBank.hxx b/source/trunk/include/DecayDataBank.hxx index ac5eef7cd..25842bf85 100644 --- a/source/trunk/include/DecayDataBank.hxx +++ b/source/trunk/include/DecayDataBank.hxx @@ -27,6 +27,8 @@ double ReactionRateWeightedDistance(IsotopicVector IV1, EvolutionData DB ); double ReactionRateWeightedDistance(EvolutionData DB, IsotopicVector IV1 ); //-----------------------------------------------------------------------------// +//! Describe outcore radioactive decays + /*! Define a DecayDataBank. The aim of these class is to describe the evolution of "all" evoluting systems in CLASS. diff --git a/source/trunk/include/EquivalenceModel.hxx b/source/trunk/include/EquivalenceModel.hxx index e7d7288e9..60ecb6b2e 100644 --- a/source/trunk/include/EquivalenceModel.hxx +++ b/source/trunk/include/EquivalenceModel.hxx @@ -19,6 +19,8 @@ using namespace std; //-----------------------------------------------------------------------------// + +//! Determines how to build a fresh fuel /*! Define an EquivalenceModel. The aim of these class is to gather all the commum properties of all diff --git a/source/trunk/include/EvolutionData.hxx b/source/trunk/include/EvolutionData.hxx index cef1f37fe..4ec7c0b5b 100755 --- a/source/trunk/include/EvolutionData.hxx +++ b/source/trunk/include/EvolutionData.hxx @@ -35,6 +35,8 @@ double Distance(IsotopicVector IV1, EvolutionData Evd1 ); double Distance(EvolutionData Evd1, IsotopicVector IV1 ); //-----------------------------------------------------------------------------// +//! Store fuel inventory evolution , mean cross sections evolution, flux evolution, power , ... + /*! Define an EvolutionData. The aim of these class is to describe the evolution of a single evoluting system in CLASS. diff --git a/source/trunk/include/FabricationPlant.hxx b/source/trunk/include/FabricationPlant.hxx index fae39682f..742229bab 100644 --- a/source/trunk/include/FabricationPlant.hxx +++ b/source/trunk/include/FabricationPlant.hxx @@ -26,6 +26,8 @@ using namespace std; typedef long long int cSecond; //-----------------------------------------------------------------------------// +//! CLASS object to build the fresh fuel (do chemical separation) & store it until core loading + /*! Define a FabricationPLant. The aim of these class is to manage the manufacturing of reprocessed fuel. diff --git a/source/trunk/include/IrradiationModel.hxx b/source/trunk/include/IrradiationModel.hxx index aaac53f73..6d87333ab 100644 --- a/source/trunk/include/IrradiationModel.hxx +++ b/source/trunk/include/IrradiationModel.hxx @@ -31,6 +31,8 @@ typedef long long int cSecond; class ZAI; class CLASSLogger; //-----------------------------------------------------------------------------// +//! The Bateman equation solver + /*! Define an IrradiationModel. An IrradiationModel is a Bateman equation solving method. diff --git a/source/trunk/include/IsotopicVector.hxx b/source/trunk/include/IsotopicVector.hxx index 9e2aba115..cf3488799 100755 --- a/source/trunk/include/IsotopicVector.hxx +++ b/source/trunk/include/IsotopicVector.hxx @@ -18,6 +18,8 @@ using namespace std; typedef long long int cSecond; //-----------------------------------------------------------------------------// +//! Allows to store & operate on radioactive sample + /*! Define an Isotopicvector. An isotopicVector is a map of ZAI and double (e.g number of atoms). diff --git a/source/trunk/include/PhysicsModels.hxx b/source/trunk/include/PhysicsModels.hxx index 7b8589214..93802e148 100644 --- a/source/trunk/include/PhysicsModels.hxx +++ b/source/trunk/include/PhysicsModels.hxx @@ -21,6 +21,8 @@ using namespace std; typedef long long int cSecond; //-----------------------------------------------------------------------------// +//! Container object of XSModel, EquivalenceModel and IrradiationModel + /*! Define a contener of all physics models used for a specific couple (reactor,fuel). diff --git a/source/trunk/include/Pool.hxx b/source/trunk/include/Pool.hxx index 151a79fb9..cc068c3ba 100755 --- a/source/trunk/include/Pool.hxx +++ b/source/trunk/include/Pool.hxx @@ -20,8 +20,9 @@ class CLASSLogger; class DecayDataBank; //-----------------------------------------------------------------------------// +//! Define the spent fuel pool + /*! - Define a Pool. This class deal with the management of the spent fuel pool diff --git a/source/trunk/include/Reactor.hxx b/source/trunk/include/Reactor.hxx index ddf7b9b6b..ea213e8d7 100755 --- a/source/trunk/include/Reactor.hxx +++ b/source/trunk/include/Reactor.hxx @@ -26,8 +26,9 @@ class Storage; class CLASSLogger; //-----------------------------------------------------------------------------// +//! Define the Reactor + /*! - Define a reactor. The aim of this class is to deal the evolution of the fuel inside a reactor. The fuel state in the reactor is describe in the IsotopicVector. Its evolution is contained in an EvolutionData diff --git a/source/trunk/include/Scenario.hxx b/source/trunk/include/Scenario.hxx index 236446210..8b3e83ecd 100755 --- a/source/trunk/include/Scenario.hxx +++ b/source/trunk/include/Scenario.hxx @@ -28,8 +28,9 @@ class Pool; class Storage; //-----------------------------------------------------------------------------// +//! Define a Scenario (the whole electro-nuclear system) + /*! - Define a Scenario . The aim of these Scenario is to manage the park and its evolution and to lead all Storage, FabricationPlant, Reactor, Pool,... diff --git a/source/trunk/include/SeparationPlant.hxx b/source/trunk/include/SeparationPlant.hxx index 612012ce6..8c396e406 100644 --- a/source/trunk/include/SeparationPlant.hxx +++ b/source/trunk/include/SeparationPlant.hxx @@ -21,9 +21,10 @@ class CLASSLogger; class DecayDataBank; //-----------------------------------------------------------------------------// +//! Define a SeparationPlant. + /*! - Define a SeparationPlant. - The aim of this class is to separate an IV into several IV (MA, Pu, PF, etc...) and + The aim of this class is to separate an IV into several IV (MA, Pu, PF, etc...) and to send it to one or several Storage @author NT diff --git a/source/trunk/include/Storage.hxx b/source/trunk/include/Storage.hxx index eecb6bc96..2433b0141 100644 --- a/source/trunk/include/Storage.hxx +++ b/source/trunk/include/Storage.hxx @@ -20,8 +20,9 @@ class CLASSLogger; class DecayDataBank; //-----------------------------------------------------------------------------// +//! Define a Storage object + /*! - Define a Storage object A Storage is a CLASSBackEnd facility. It is almost the same as a Pool with a infinite cooling time. A CLASSFacility can take IsotopicVector(s) contained in a Storage but a Storage diff --git a/source/trunk/include/XSModel.hxx b/source/trunk/include/XSModel.hxx index c7b123eee..4720a5fa9 100644 --- a/source/trunk/include/XSModel.hxx +++ b/source/trunk/include/XSModel.hxx @@ -19,8 +19,9 @@ using namespace std; class IsotopicVector; //-----------------------------------------------------------------------------// +//! Define a mean cross section predictor + /*! - Define a XS Interpolator This is the mother class for methods related to XS prediction \warning diff --git a/source/trunk/include/ZAI.hxx b/source/trunk/include/ZAI.hxx index 632b4d94f..c035e91ad 100755 --- a/source/trunk/include/ZAI.hxx +++ b/source/trunk/include/ZAI.hxx @@ -13,6 +13,8 @@ using namespace std; //-----------------------------------------------------------------------------// +//! Define a nucleus + /*! Define a nuclei as 3 integer Z,A,I: \li its charge number : Z diff --git a/source/trunk/include/ZAIMass.hxx b/source/trunk/include/ZAIMass.hxx index d4d84b1ac..59bfeddb6 100644 --- a/source/trunk/include/ZAIMass.hxx +++ b/source/trunk/include/ZAIMass.hxx @@ -22,8 +22,9 @@ using namespace std; class IsotopicVector; //-----------------------------------------------------------------------------// +//! Define the molar mass of a ZAI + /*! -Define a ZAIMass Object The aims of this class is to handle the molar mass of each ZAI @author BaM, BaL -- GitLab