From 2029adcb8315712e5579ae3f4982f7562a6d535a Mon Sep 17 00:00:00 2001
From: Baptiste Mouginot <mouginot.baptiste@gmail.com>
Date: Fri, 30 Jan 2015 14:08:23 +0000
Subject: [PATCH] adding and formatting comments
git-svn-id: svn+ssh://svn.in2p3.fr/class@519 0e7d625b-0364-4367-a6be-d5be4a48d228
---
source/trunk/include/CLASSBackEnd.hxx | 2 +-
source/trunk/include/EvolutionData.hxx | 2 +-
source/trunk/include/FabricationPlant.hxx | 2 +-
source/trunk/include/Pool.hxx | 12 +-
source/trunk/include/Reactor.hxx | 299 +++++++++++-----------
source/trunk/include/Storage.hxx | 4 +-
6 files changed, 157 insertions(+), 164 deletions(-)
diff --git a/source/trunk/include/CLASSBackEnd.hxx b/source/trunk/include/CLASSBackEnd.hxx
index 4654bac38..a8c10c0d3 100644
--- a/source/trunk/include/CLASSBackEnd.hxx
+++ b/source/trunk/include/CLASSBackEnd.hxx
@@ -91,7 +91,7 @@ class CLASSBackEnd : public CLASSFacility
#ifndef __CINT__
DecayDataBank* GetDecayDataBank() { return fDecayDataBase;} //!< Return the pointer to the decay DataBank
CLASSBackEnd* GetOutBackEndFacility() const { return fOutBackEndFacility;} //!<Return the pointer to the OUtBackEndFacility
- virtual map<cSecond,int> GetTheBackEndTimePath(); //!< Get the time when a CLASSBackend is connected to an other(for a CLASSBackend connected to 2 or more out CLASSBackend)
+ virtual map<cSecond,int> GetTheBackEndTimePath(); //!< Get the full path
#endif
diff --git a/source/trunk/include/EvolutionData.hxx b/source/trunk/include/EvolutionData.hxx
index 0115bf3c5..cd062afdd 100755
--- a/source/trunk/include/EvolutionData.hxx
+++ b/source/trunk/include/EvolutionData.hxx
@@ -68,7 +68,7 @@ public :
/// CLASSLogger Constructor.
/*!
Use create an empty EvolutionData loading a CLASSLogger
- \param CLASSLogger CLASSLogger used for the log.
+ \param log : used for the log.
*/
EvolutionData(CLASSLogger* log); ///< Make a new Evolutive Product evolution
//}
diff --git a/source/trunk/include/FabricationPlant.hxx b/source/trunk/include/FabricationPlant.hxx
index 1651d09ca..311908b8f 100644
--- a/source/trunk/include/FabricationPlant.hxx
+++ b/source/trunk/include/FabricationPlant.hxx
@@ -68,7 +68,7 @@ public :
/// Special Constructor.
/*!
Make a new FabricationPlant
- \param CLASSLogger CLASSLogger used for the log.
+ \param log : used for the log.
\param fabricationtime duration of the fabrication process (default : 2 years).
*/
FabricationPlant(CLASSLogger* log, double fabricationtime = cYear*2);
diff --git a/source/trunk/include/Pool.hxx b/source/trunk/include/Pool.hxx
index e4c9d0400..ab48a8cbc 100755
--- a/source/trunk/include/Pool.hxx
+++ b/source/trunk/include/Pool.hxx
@@ -50,8 +50,8 @@ public :
/// Special Constructor.
/*!
Make a new Pool
- \param Log CLASSLogger used for the log.
- \param coolingtime duration of the cooling (default : 5 years).
+ \param log : used for the log.
+ \param coolingtime : duration of the cooling (default : 5 years).
*/
Pool(CLASSLogger* Log, cSecond coolingtime = 5*cYear); //!<
//}
@@ -61,11 +61,11 @@ public :
/// Special Constructor.
/*!
Make a new Pool
- \param Log CLASSLogger used for the log...
- \param CLASSBackEnd backend which get the fuel after the cooling
- \param coolingtime duration of the cooling (default : 5 years).
+ \param log : used for the log.
+ \param backend : CLASSBackend which get the fuel after the cooling
+ \param coolingtime : duration of the cooling (default : 5 years).
*/
- Pool(CLASSLogger* log, CLASSBackEnd* Storage,
+ Pool(CLASSLogger* log, CLASSBackEnd* backend,
cSecond coolingtime = 5*cYear); //!<
//}
diff --git a/source/trunk/include/Reactor.hxx b/source/trunk/include/Reactor.hxx
index 6883df4ba..7baebefef 100755
--- a/source/trunk/include/Reactor.hxx
+++ b/source/trunk/include/Reactor.hxx
@@ -3,7 +3,7 @@
/*!
\file
- \brief Header file for reactor classes.
+ \brief Header file for reactor classes.
*/
#include <string>
@@ -30,7 +30,7 @@ class CLASSLogger;
Define a reactor.
The aim of this class is to deal the evolution of the fuel inside a reactor.
The fuel state of the reactor is describe in the IsotopicVector. Its evolution is contain in the EvolutionData
-
+
@author BaM
@version 2.0
*/
@@ -40,148 +40,148 @@ class CLASSLogger;
class Reactor : public CLASSFacility
{
-public :
-
-
-//********* Constructor/Destructor Method *********//
-
+ public :
+
+
+ //********* Constructor/Destructor Method *********//
+
/*!
\name Constructor/Desctructor
*/
//@{
-
+
Reactor(); ///< Normal Constructor.
-
+
//{
/// CLASSLogger Constructor.
/*!
Use create an empty Reactor loading a CLASSLogger
- \param CLASSLogger CLASSLogger used for the log.
+ \param log: used for the log.
*/
Reactor(CLASSLogger* log);
//}
-
+
//{
/// Special Constructor for reprocessed fuel using cycletime and Burn-Up.
/*!
Make a new reactor
- \param CLASSLogger CLASSLogger used for the log.
- \param CLASSBAckEnd Pool used facility wich get the fuel after iradiation
- \param creationtime creation time
- \param lifetime working time duration.
- \param cycletime duration of a cycle
- \param HMMass Mass of Heavy Metal in the Reactor
- \param BurnUp Burnup reach by the fuel at the end of the cycle
+ \param log: used for the log,
+ \param backend: CLASSBackend which get the fuel after the cooling,
+ \param creationtime: creation time in [s],
+ \param lifetime: working time duration in [s],
+ \param cycletime: duration of a cycle in [s],
+ \param HMMass: Mass of Heavy Metal in the Reactor in [t] of heavy metal,
+ \param BurnUp: Burnup reach by the fuel at the end of the cycle in [GWd/t].
*/
- Reactor(CLASSLogger* log, CLASSBackEnd* Pool,
+ Reactor(CLASSLogger* log, CLASSBackEnd* backend,
cSecond creationtime , cSecond lifetime, double Power,
double HMMass, double CapacityFactor = 1);
//}
-
+
//{
/// Special Constructor for reprocessed fuel using cycletime and Burn-Up.
/*!
Make a new reactor
- \param CLASSLogger CLASSLogger used for the log.
- \param CLASSBAckEnd Pool used facility wich get the fuel after iradiation
- \param creationtime creation time
- \param lifetime working time duration.
- \param cycletime duration of a cycle
- \param HMMass Mass of Heavy Metal in the Reactor
- \param BurnUp Burnup reach by the fuel at the end of the cycle
+ \param log: used for the log.
+ \param backend: CLASSBackend which get the fuel after the cooling,
+ \param creationtime: creation time in [s],
+ \param lifetime: working time duration in [s],
+ \param cycletime: duration of a cycle in [s],
+ \param HMMass: Mass of Heavy Metal in the Reactor in [t] of heavy metal,
+ \param BurnUp: Burnup reach by the fuel at the end of the cycle in [GWd/t].
*/
Reactor(CLASSLogger* log,
- FabricationPlant* fabricationplant, CLASSBackEnd* Pool,
+ FabricationPlant* fabricationplant, CLASSBackEnd* backend,
cSecond creationtime , cSecond lifetime, double Power,
double HMMass, double CapacityFactor = 1);
//}
-
+
//{
- /// Special Constructor for reprocessed fuel using cycletime and Burn-Up.
- /*!
- Make a new reactor
- \param CLASSLogger CLASSLogger used for the log.
- \param fueltypeDB Databank describing the evolution of the fuel
- \param CLASSBAckEnd Pool used facility wich get the fuel after iradiation
- \param creationtime creation time
- \param lifetime working time duration.
- \param cycletime duration of a cycle
- \param HMMass Mass of Heavy Metal in the Reactor
- \param BurnUp Burnup reach by the fuel at the end of the cycle
+ /// Special Constructor for reprocessed fuel using cycletime and Burn-Up.
+ /*!
+ Make a new reactor
+ \param log: used for the log,
+ \param fueltypeDB Databank describing the evolution of the fuel;
+ \param backend: CLASSBackend which get the fuel after the cooling,
+ \param creationtime: creation time in [s],
+ \param lifetime: working time duration in [s],
+ \param cycletime: duration of a cycle in [s],
+ \param HMMass: Mass of Heavy Metal in the Reactor in [t] of heavy metal,
+ \param BurnUp: Burnup reach by the fuel at the end of the cycle in [GWd/t].
*/
Reactor(CLASSLogger* log, PhysicsModels* fueltypeDB,
FabricationPlant* fabricationplant, CLASSBackEnd* Pool,
cSecond creationtime , cSecond lifetime, cSecond cycletime,
double HMMass, double BurnUp);
//}
-
+
//{
/// Special Constructor for reprocessed fuel using Power and Burn-Up.
/*!
Make a new reactor
- \param CLASSLogger CLASSLogger used for the log.
- \param fueltypeDB Databank describing the evolution of the fuel
- \param CLASSBAckEnd Pool used facility wich get the fuel after iradiation
- \param creationtime creation time
- \param lifetime working time duration.
- \param Power Thermal power of the reactor
- \param HMMass Mass of Heavy Metal in the Reactor
- \param BurnUp Burnup reach by the fuel at the end of the cycle
- \param CapacityFactor effective charge of the reactor.
+ \param log: used for the log,
+ \param fueltypeDB Databank describing the evolution of the fuel,
+ \param backend: CLASSBackend which get the fuel after the cooling,
+ \param creationtime: creation time in [s],
+ \param lifetime: working time duration in [s],
+ \param Power: Thermal power of the reactor in [W],
+ \param HMMass: Mass of Heavy Metal in the Reactor in [t] of heavy metal,
+ \param BurnUp: Burnup reach by the fuel at the end of the cycle in [GWd/t],
+ \param CapacityFactor effective charge of the reactor, fraction between 0 & 1.
*/
Reactor(CLASSLogger* log, PhysicsModels* fueltypeDB,
- FabricationPlant* fabricationplant, CLASSBackEnd* Pool,
+ FabricationPlant* fabricationplant, CLASSBackEnd* backend,
cSecond creationtime , cSecond lifetime,
double Power, double HMMass, double BurnUp, double CapacityFactor);
//}
-
+
//{
/// Special Constructor for fixed fuel using Power and Burn-Up.
/*!
Make a new reactor
- \param CLASSLogger CLASSLogger used for the log.
- \param evolutivedb EvolutionData describing the evolution of the fuel
- \param CLASSBAckEnd Pool used facility wich get the fuel after iradiation
- \param creationtime creation time
- \param lifetime working time duration.
- \param Power Thermal power of the reactor
- \param HMMass Mass of Heavy Metal in the Reactor
- \param BurnUp Burnup reach by the fuel at the end of the cycle
- \param CapacityFactor effective charge of the reactor.
+ \param log: used for the log,
+ \param evolutivedb: EvolutionData describing the evolution of the fuel,
+ \param backend: CLASSBackend which get the fuel after the cooling,
+ \param creationtime: creation time in [s],
+ \param lifetime: working time duration in [s],
+ \param Power: Thermal power of the reactor in [W],
+ \param HMMass: Mass of Heavy Metal in the Reactor in [t] of heavy metal,
+ \param BurnUp: Burnup reach by the fuel at the end of the cycle in [GWd/t],
+ \param CapacityFactor: effective charge of the reactor, fraction between 0 & 1.
*/
- Reactor(CLASSLogger* log, EvolutionData* evolutivedb, CLASSBackEnd* Pool,
+ Reactor(CLASSLogger* log, EvolutionData* evolutivedb, CLASSBackEnd* backend,
cSecond creationtime, cSecond lifetime,
double power, double HMMass, double BurnUp, double CapacityFactor);
//}
-
+
//{
/// Special Constructor for fixed fuel using Power and Burn-Up.
/*!
Make a new reactor
- \param CLASSLogger CLASSLogger used for the log.
- \param evolutivedb EvolutionData describing the evolution of the fuel
- \param CLASSBAckEnd Pool used facility wich get the fuel after iradiation
- \param creationtime creation time
- \param lifetime working time duration.
- \param Power Thermal power of the reactor
- \param HMMass Mass of Heavy Metal in the Reactor
- \param BurnUp Burnup reach by the fuel at the end of the cycle
- \param CapacityFactor effective charge of the reactor.
+ \param log: used for the log,
+ \param evolutivedb: EvolutionData describing the evolution of the fuel,
+ \param backend: CLASSBackend which get the fuel after the cooling,
+ \param creationtime: creation time in [s],
+ \param lifetime: working time duration in [s]
+ \param Power: Thermal power of the reactor in [W],
+ \param HMMass: Mass of Heavy Metal in the Reactor in [t] of heavy metal,
+ \param BurnUp: Burnup reach by the fuel at the end of the cycle in [GWd/t],
+ \param CapacityFactor effective charge of the reactor, fraction between 0 & 1.
*/
- Reactor(CLASSLogger* log, EvolutionData* evolutivedb, CLASSBackEnd* Pool,
+ Reactor(CLASSLogger* log, EvolutionData* evolutivedb, CLASSBackEnd* backend,
cSecond creationtime, cSecond lifetime,
cSecond cycletime, double HMMass, double BurnUp);
//}
-
+
~Reactor(); ///< Normal Destructor
-
+
//@}
-
-
-
-
-//********* Get Method *********//
-
+
+
+
+
+ //********* Get Method *********//
+
/*!
\name Get Method
*/
@@ -189,79 +189,72 @@ public :
IsotopicVector GetIVReactor() const { return GetInsideIV(); } //!< Return the IV contain in the Reactor
IsotopicVector GetIVBeginCycle() const { return fIVBeginCycle; } //!< Return the Starting Cycle IV
- //!< (Note : IVBegin != IVIn, only if using charging plan)
-
+ //!< (Note : IVBegin != IVIn, only if using charging plan)
IsotopicVector GetIVOutCycle() const { return fIVOutCycle; } //!< Return the Out Cycle IV
IsotopicVector GetIVInCycle() const { return fIVInCycle; } //!< Return the In Cycle IV
- //!< (Note : IVIn != IVBegin, only if using charging plan)
+ //!< (Note : IVIn != IVBegin, only if using charging plan)
+
+
+
+ bool IsFuelFixed() const { return fFixedFuel; } //!< True if using fixed Fuel, False otherwise
+ double GetHeavyMetalMass() const { return fHeavyMetalMass; } //!< Return the HeavyMetal Mass in the Core at the begining of the cycle
+ double GetBurnUp() const { return fBurnUp; } //!< Return the Burn Up of the Fuel at the end of the cycle
+ double GetPower() const { return fPower; } //!< Return the cycle time of the Reactor
-
-
- bool IsFuelFixed() const { return fFixedFuel; } //!< True if using fixed Fuel, False otherwise
- double GetHeavyMetalMass() const { return fHeavyMetalMass; } //!< Return the HeavyMetal Mass in the Core at the begining of the cycle
- double GetBurnUp() const { return fBurnUp; } //!< Return the Burn Up of the Fuel at the end of the cycle
- double GetPower() const { return fPower; } //!< Return the cycle time of the Reactor
-
#ifndef __CINT__
-
+
EvolutionData GetEvolutionDB() const { return fEvolutionDB; } //!< Return the Evolution database of the Fuel
-
- CLASSBackEnd* GetOutBackEndFacility() const { return fOutBackEndFacility; } //!< Return the pointer to Associeted BackEnd Facility
+ CLASSBackEnd* GetOutBackEndFacility() const { return fOutBackEndFacility; } //!< Return the pointer to Associeted BackEnd Facility
FabricationPlant* GetFabricationPlant() const { return fFabricationPlant; } //!< Return the Pointer to the FabricationPlant
-
-
+
+
CLASSFuelPlan* GetFuelPlan() const { return fFuelPlan; } //!< return the LoadingPlan
-
+
#endif
//@}
-
-
-
-
-//********* Set Method *********//
-
+
+
+
+
+ //********* Set Method *********//
+
/*!
\name Set Method
*/
//@{
- void SetFuelPlan(CLASSFuelPlan* fuelplan) { fFuelPlan = fuelplan; } //!< return the LoadingPlan
-
-
- void SetHMMass(double Mass) {fHeavyMetalMass = Mass;} //!< Set the HeavyMetal Mass in the Core at the begining of the cycle
-
- void SetIVReactor(IsotopicVector isotopicvector)
- { fInsideIV = isotopicvector; } //!< Set the IV inside the Reactor Core
- void SetIVBeginCycle(IsotopicVector isotopicvector)
- { fIVBeginCycle = isotopicvector; } //!< Set the IV at the Beginging of the Reactor Cycle
- void SetIVOutCycle(IsotopicVector isotopicvector)
- { fIVOutCycle = isotopicvector; } //!< Set the IV Going Out at the End of the Cycle
- void SetIVInCycle(IsotopicVector isotopicvector)
- { fIVInCycle = isotopicvector; } //!< Set the IV Coming In at the Beginning of the Cycle
-
-
- void SetCycleTime(double cycletime); //!< Set the Cycle time (Power fixed)
- void SetPower(double Power); //!< Set the Power (BurnUp cte)
- void SetBurnUp(double BU); //!< Set the BurnUp reach at end of cycle (Power cte)
-
-
+
+ void SetFuelPlan(CLASSFuelPlan* fuelplan) { fFuelPlan = fuelplan; } //!< return the LoadingPlan
+ void SetHMMass(double Mass) {fHeavyMetalMass = Mass;} //!< Set the HeavyMetal Mass in the Core at the begining of the cycle
+ void SetCycleTime(double cycletime); //!< Set the Cycle time (Power fixed)
+ void SetPower(double Power); //!< Set the Power (BurnUp cte)
+ void SetBurnUp(double BU); //!< Set the BurnUp reach at end of cycle (Power cte)
+
+ void SetIVReactor(IsotopicVector isotopicvector) { fInsideIV = isotopicvector; } //!< Set the IV inside the Reactor Core
+ void SetIVBeginCycle(IsotopicVector isotopicvector) { fIVBeginCycle = isotopicvector;} //!< Set the IV at the Beginging of the Reactor Cycle
+ void SetIVOutCycle(IsotopicVector isotopicvector){ fIVOutCycle = isotopicvector;} //!< Set the IV Going Out at the End of the Cycle
+ void SetIVInCycle(IsotopicVector isotopicvector) { fIVInCycle = isotopicvector;} //!< Set the IV Coming In at the Beginning of the Cycle
+
+
+
+
#ifndef __CINT__
-
+
void SetOutBackEndFacility(CLASSBackEnd* pool) { fOutBackEndFacility = pool; } //!< Return the pointer to OutBackEnd Facility
void SetStorage(Storage* storage) { fStorage = storage; fIsStorage = true;} //!< Set the Pointer to the Storage
void SetFabricationPlant(FabricationPlant* FP) { fFabricationPlant = FP;} //!< Set the Pointer to the FabricationPlant
void SetEvolutionDB(EvolutionData evolutionDB); //!< Set the Pointer to the DB Evolution of the Reactor
#endif
-
+
using CLASSFacility::SetName;
using CLASSFacility::GetName;
-
+
//@}
-
-
-
-
-//********* Evolution & Modification Method *********//
-
+
+
+
+
+ //********* Evolution & Modification Method *********//
+
/*!
\name Evolution & Modification Method
*/
@@ -272,44 +265,44 @@ public :
void SetNewFuel(EvolutionData ivdb); //!< Change the Evolutive DB of the Reactor
//@}
-
-
-
-protected :
+
+
+
+ protected :
bool fFixedFuel; //!< true if the fuel is fixed (not reprocessed)
bool fIsStorage; //!< true if a storage has been define (to approximate the reprocessing using fixed fuel)
-//********* Internal Parameter *********//
-
+ //********* Internal Parameter *********//
+
double fPower; ///< Power (in Watt)
IsotopicVector fIVBeginCycle; ///< Fuel IV at the Beginning of a Cycle
IsotopicVector fIVInCycle; ///< IVBegin add at the Beginning of the Cycle
IsotopicVector fIVOutCycle; ///< IV wich get out at the End of a Cycle
-
+
#ifndef __CINT__
EvolutionData fEvolutionDB; //!< Pointer to the Actual Evolution DataBase
-
+
CLASSBackEnd* fOutBackEndFacility; //!< Pointer to the BackEnd Facility which collect the spend fuel
-
-
- CLASSFuelPlan* fFuelPlan;
-
+
+
+ CLASSFuelPlan* fFuelPlan; //!< Pointer to the fuel Plan
+
FabricationPlant* fFabricationPlant; //!< Poitner to the FabricationPlant
-
+
Storage* fStorage; //!< Pointer to the Stock (only for reprocessing fuel in fixed base...)
-
-
+
+
#endif
-//********* Unfixed Fuel Parameter *********//
-
-
+ //********* Unfixed Fuel Parameter *********//
+
+
double fHeavyMetalMass; ///< In tons
double fBurnUp; ///< In GWd/tHM
-
- ClassDef(Reactor,3);
- };
+
+ ClassDef(Reactor,3);
+};
#endif
diff --git a/source/trunk/include/Storage.hxx b/source/trunk/include/Storage.hxx
index b72cf3092..c6875dd53 100644
--- a/source/trunk/include/Storage.hxx
+++ b/source/trunk/include/Storage.hxx
@@ -52,7 +52,7 @@ public :
/// CLASSLogger Constructor.
/*!
Use create an empty Stotarage loading a CLASSLogger
- \param CLASSLogger CLASSLogger used for the log.
+ \param log : used for the log.
*/
Storage(CLASSLogger* log);
//}
@@ -62,7 +62,7 @@ public :
/// Special Constructor.
/*!
Make a new reactor
- \param CLASSLogger CLASSLogger used for the log.
+ \param log : used for the log.
\param evolutivedb DataBank for decay management
*/
Storage(CLASSLogger* log, DecayDataBank* evolutivedb);
--
GitLab