From 35d97101cb180584dd4a051f315f25d1117f5b6b Mon Sep 17 00:00:00 2001
From: Baptiste Mouginot <mouginot.baptiste@gmail.com>
Date: Thu, 29 Jan 2015 17:28:32 +0000
Subject: [PATCH] adding comments
git-svn-id: svn+ssh://svn.in2p3.fr/class@501 0e7d625b-0364-4367-a6be-d5be4a48d228
---
source/trunk/include/CLASSBackEnd.hxx | 196 +++++++++---------
source/trunk/include/CLASSFacility.hxx | 8 +-
source/trunk/include/CLASSFuel.hxx | 54 +++--
source/trunk/include/CLASSFuelPlan.hxx | 47 ++++-
source/trunk/include/CLASSLogger.hxx | 90 +++++---
source/trunk/include/CLASSNucleiFiliation.hxx | 2 +-
source/trunk/include/CLASSObject.hxx | 39 +++-
source/trunk/include/DecayDataBank.hxx | 50 ++---
source/trunk/include/EvolutionData.hxx | 16 +-
source/trunk/include/Pool.hxx | 4 +-
source/trunk/include/Reactor.hxx | 14 +-
source/trunk/include/Scenario.hxx | 2 +-
source/trunk/include/SeparationPlant.hxx | 2 +-
source/trunk/include/Storage.hxx | 6 +-
source/trunk/src/CLASSLogger.cxx | 97 +--------
source/trunk/src/EvolutionData.cxx | 16 +-
source/trunk/src/IrradiationModel.cxx | 2 +-
17 files changed, 338 insertions(+), 307 deletions(-)
diff --git a/source/trunk/include/CLASSBackEnd.hxx b/source/trunk/include/CLASSBackEnd.hxx
index c259ac307..4654bac38 100644
--- a/source/trunk/include/CLASSBackEnd.hxx
+++ b/source/trunk/include/CLASSBackEnd.hxx
@@ -38,110 +38,114 @@ typedef long long int cSecond;
class CLASSBackEnd : public CLASSFacility
{
- public :
- //{
- /// Default Constructor.
- /*!Create an empty CLASSBackEnd
- \param type
- \li -2 :SeparationPlant
- \li -1 : Storage
- \li 8 :Pool
- */
- CLASSBackEnd(int type = 0);
- //}
- //{
- /// CLASSLogger Constructor.
- /*!
- Create an empty CLASSBackEnd loading a CLASSLogger
- \param CLASSLogger CLASSLogger used for the log...
- \param type
- \li -2 :SeparationPlant
- \li -1 : Storage
- \li 8 :Pool */
- CLASSBackEnd(CLASSLogger* log,int type = 0);
- //}
- //{
- /// Cycle time Constructor.
- /*!
- Create an empty CLASSBackEnd loading a CLASSLogger
- \param CLASSLogger CLASSLogger used for the log...
- \param cycletime Cycle time of the CLASSBackend (e.g. Cooling time for the pool)
- \param type -2 :SeparationPlant -1 : Storage ; 8 :Pool
- */
- CLASSBackEnd(CLASSLogger* log, cSecond cycletime, int type = 0);
- //}
- //********* Get Method *********//
- /*!
- \name Get Function
- */
- //@{
-
-
- vector<IsotopicVector> GetIVArray() const { return fIVArray; } //!< Return the IsotopicVector Array
- vector<cSecond> GetIVArrayArrivalTime() const { return fIVArrayArrivalTime;} //!<Vector of arrival time of each IV in the CLASSBackEnd
-
- int GetIVNumber() const { return fIVArray.size();} //!< Return the number of Isotopic Vector present in the CLASSBackEnd object
- bool GetStorageType() const { return fIsStorageType;} //!< Return the storageType : True if it is a Storage
- IsotopicVector GetIV(int i) const { if(i < (int)fIVArray.size()) return fIVArray[i];
- else return IsotopicVector(); }
+ public :
+ //{
+ /// Default Constructor.
+ /*!Create an empty CLASSBackEnd
+ \param type
+ \li -2 :SeparationPlant
+ \li -1 : Storage
+ \li 8 :Pool
+ */
+ CLASSBackEnd(int type = 0);
+ //}
+
+ //{
+ /// CLASSLogger Constructor.
+ /*!
+ Create an empty CLASSBackEnd loading a CLASSLogger
+ \param log : used for the log.
+ \param type
+ \li -2 :SeparationPlant
+ \li -1 : Storage
+ \li 8 :Pool */
+ CLASSBackEnd(CLASSLogger* log,int type = 0);
+ //}
+
+ //{
+ /// Cycle time Constructor.
+ /*!
+ Create an empty CLASSBackEnd loading a CLASSLogger
+ \param log : used for the log.
+ \param cycletime Cycle time of the CLASSBackend (e.g. Cooling time for the pool)
+ \param type -2 :SeparationPlant -1 : Storage ; 8 :Pool
+ */
+ CLASSBackEnd(CLASSLogger* log, cSecond cycletime, int type = 0);
+ //}
+ //@}
+
+ //********* Get Method *********//
+ /*!
+ \name Get Function
+ */
+ //@{
+
+
+ vector<IsotopicVector> GetIVArray() const { return fIVArray; } //!< Return the IsotopicVector Array
+ vector<cSecond> GetIVArrayArrivalTime() const { return fIVArrayArrivalTime;} //!<Vector of arrival time of each IV in the CLASSBackEnd
+
+ int GetIVNumber() const { return fIVArray.size();} //!< Return the number of Isotopic Vector present in the CLASSBackEnd object
+ bool GetStorageType() const { return fIsStorageType;} //!< Return the storageType : True if it is a Storage
+ IsotopicVector GetIV(int i) const { if(i < (int)fIVArray.size()) return fIVArray[i];
+ else return IsotopicVector(); }
#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)
-
+ 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)
+
#endif
-
- //@}
-
- //********* Set Method *********//
- /*!
- \name Set Function
- */
- //@{
- void SetIsStorageType(bool val = true) { fIsStorageType = val;} //! Set the fIsStorage bool
- virtual void SetIVArray(vector<IsotopicVector> ivarray) { fIVArray = ivarray; } //!< Set The isotopicVector Array
+
+ //@}
+
+ //********* Set Method *********//
+ /*!
+ \name Set Function
+ */
+ //@{
+ void SetIsStorageType(bool val = true) { fIsStorageType = val;} //! Set the fIsStorage bool
+ virtual void SetIVArray(vector<IsotopicVector> ivarray) { fIVArray = ivarray; } //!< Set The isotopicVector Array
#ifndef __CINT__
- void SetDecayDataBank(DecayDataBank* decayDB) { fDecayDataBase = decayDB;} //! Set the Decay DataBank
- virtual void SetOutBackEndFacility(CLASSBackEnd* befacility) { fOutBackEndFacility = befacility;
- fIsStorageType = false; } //! Set an out Facility for the fuel
-
+ void SetDecayDataBank(DecayDataBank* decayDB) { fDecayDataBase = decayDB;} //! Set the Decay DataBank
+ virtual void SetOutBackEndFacility(CLASSBackEnd* befacility) { fOutBackEndFacility = befacility;
+ fIsStorageType = false; } //! Set an out Facility for the fuel
+
#endif
-
- using CLASSFacility::SetName;
-
- //@}
-
-
- /*!
- \name BackEndFacility specific Method
- */
- //@{
- virtual void AddIV(IsotopicVector isotopicvector); //!< Add an Isotopicvector to the IVArray
- void ClearIVArray(); //!< Empty the IVArray removing all fuel stored
-
- //@}
- virtual void Evolution(cSecond t) {} //!< Performs the Evolution to the Time t
- void UpdateInsideIV();
-
-
- protected :
- IsotopicVector GetDecay(IsotopicVector isotopicvector, cSecond t); //!< Get IsotopicVector Decay at time t
- vector<IsotopicVector> fIVArray; ///< Vector containning all the fuel stored.
- vector<cSecond> fIVArrayArrivalTime; ///< Vector containning the arrival time of each fuel
-
+
+ using CLASSFacility::SetName;
+
+ //@}
+
+
+ /*!
+ \name BackEndFacility specific Method
+ */
+ //@{
+ virtual void AddIV(IsotopicVector isotopicvector); //!< Add an Isotopicvector to the IVArray
+ void ClearIVArray(); //!< Empty the IVArray removing all fuel stored
+
+ //@}
+ virtual void Evolution(cSecond t) {} //!< Performs the Evolution to the Time t
+ void UpdateInsideIV();
+
+
+ protected :
+ IsotopicVector GetDecay(IsotopicVector isotopicvector, cSecond t); //!< Get IsotopicVector Decay at time t
+ vector<IsotopicVector> fIVArray; ///< Vector containning all the fuel stored.
+ vector<cSecond> fIVArrayArrivalTime; ///< Vector containning the arrival time of each fuel
+
#ifndef __CINT__
- CLASSBackEnd* fOutBackEndFacility; //!< Facility getting the fuel at the end of the cycle
+ CLASSBackEnd* fOutBackEndFacility; //!< Facility getting the fuel at the end of the cycle
#endif
-
- //********* Internal Parameter *********//
- private :
- bool fIsStorageType; //!< True if there is not OutBAckEndFacility (like a Storage...)
-
+
+ //********* Internal Parameter *********//
+ private :
+ bool fIsStorageType; //!< True if there is not OutBAckEndFacility (like a Storage...)
+
#ifndef __CINT__
- DecayDataBank* fDecayDataBase; //!< Pointer to the Decay DataBase
+ DecayDataBank* fDecayDataBase; //!< Pointer to the Decay DataBase
#endif
-
- ClassDef(CLASSBackEnd,2);
+
+ ClassDef(CLASSBackEnd,2);
};
#endif
diff --git a/source/trunk/include/CLASSFacility.hxx b/source/trunk/include/CLASSFacility.hxx
index ab919353e..6c4222397 100644
--- a/source/trunk/include/CLASSFacility.hxx
+++ b/source/trunk/include/CLASSFacility.hxx
@@ -61,7 +61,7 @@ public :
/// Special Constructor.
/*!
Make a new Facility
- \param Log CLASSLogger used for the log...
+ \param log : used for the log.
\param type identification of type of the facility :
\li 4 Reactor,
\li 8 Pool,
@@ -75,7 +75,7 @@ public :
/// Special Constructor.
/*!
Make a new Facility
- \param Log CLASSLogger used for the log...
+ \param log : used for the log.
\param cycletime duration of the cycle in second.
\param type identification of type of the facility :
\li 4 Reactor,
@@ -90,7 +90,7 @@ public :
/// Special Constructor.
/*!
Make a new Facility
- \param Log CLASSLogger used for the log...
+ \param log : used for the log.
\param creationtime creation date (in second) of the Facility.
\param lifetime operating duration in second.
\param type identification of type of the facility :
@@ -106,7 +106,7 @@ public :
/// Special Constructor.
/*!
Make a new Facility
- \param Log CLASSLogger used for the log...
+ \param log : used for the log.
\param creationtime creation date (in second) of the Facility.
\param lifetime operating duration in second.
\param cycletime duration of the cycle in second.
diff --git a/source/trunk/include/CLASSFuel.hxx b/source/trunk/include/CLASSFuel.hxx
index 84b2020f1..2e47fbc60 100644
--- a/source/trunk/include/CLASSFuel.hxx
+++ b/source/trunk/include/CLASSFuel.hxx
@@ -6,8 +6,8 @@
/*!
\file
\brief Header file for CLASSFuel class.
-
-
+
+
@author BaM
@version 2.0
*/
@@ -25,10 +25,10 @@ using namespace std;
/*!
Define a CLASS Object.
The aim of these class is synthetyse all the commum properties to all CLASS Fuel Element.
-
-
+
+
@author BaM
- @version 2.0
+ @version 3.0
*/
//________________________________________________________________________
@@ -37,26 +37,46 @@ using namespace std;
class CLASSFuel : public CLASSObject
{
public :
- ///< Normal Constructor.
+ /*!
+ \name Constructor/Desctructor
+ */
+ //@{
+
+ //{
+ /// EvolutionData Constructor.
+ /*!
+ Make a new CLASSObject
+ /param evo : EvolutionData stored
+ */
CLASSFuel(EvolutionData* evo);
+ //}
+
+ //{
+ /// PhysicsModels Constructor.
+ /*!
+ Make a new CLASSObject
+ /param evo : PhysicsModels stored
+ */
CLASSFuel(PhysicsModels* evo);
-
-
+ //}
+ //@}
+
+
virtual CLASSFuel* Clone() { return new CLASSFuel(*this); } //!< Correct way to copy a CLASSFuel in case of derivation
-
-
- EvolutionData* GetEvolutionData() {return fEvolutionData;}
- PhysicsModels* GetPhysicsModels() {return fPhysicsModels;}
+
+
+ EvolutionData* GetEvolutionData() {return fEvolutionData;} //!< Return the EvolutionData (NULL if PhysicsModels)
+ PhysicsModels* GetPhysicsModels() {return fPhysicsModels;} //!< Return the PhysicsModels (NULL if EvolutionData)
using CLASSObject::SetName;
using CLASSObject::GetName;
protected :
-
-
+
+
private :
-
- EvolutionData* fEvolutionData;
- PhysicsModels* fPhysicsModels;
+
+ EvolutionData* fEvolutionData; //!< the EvolutionData (NULL if PhysicsModels)
+ PhysicsModels* fPhysicsModels; //!< the PhysicsModels (NULL if EvolutionData)
};
#endif
diff --git a/source/trunk/include/CLASSFuelPlan.hxx b/source/trunk/include/CLASSFuelPlan.hxx
index 7fabaedd9..2c41baf1a 100644
--- a/source/trunk/include/CLASSFuelPlan.hxx
+++ b/source/trunk/include/CLASSFuelPlan.hxx
@@ -39,17 +39,50 @@ typedef long long int cSecond;
class CLASSFuelPlan : public CLASSObject
{
public :
- ///< Normal Constructor.
+ /*!
+ \name Constructor/Desctructor
+ */
+ //@{
+
+ //{
+ /// CLASSFuelPlan Constructor.
+ /*!
+ Make a new CLASSFuelPlan
+ */
CLASSFuelPlan();
- CLASSFuelPlan(CLASSLogger* log);
+ //}
+
+ //{
+ /// CLASSFuelPlan Constructor.
+ /*!
+ Make a new CLASSFuelPlan
+ \param log : used for the log.
+ */ CLASSFuelPlan(CLASSLogger* log);
+ //}
+ //@}
+
+ /*!
+ \name Adding Method
+ */
+ //@{
+
+ void AddFuel(cSecond time, CLASSFuel fuel, double BurnUp); //!< Add A new CLASSFuel at the corresponding time and Burnup
+ void AddFuel(cSecond time, EvolutionData* fuel, double BurnUp)
+ { AddFuel( time, CLASSFuel(fuel), BurnUp); } //!< Add A new EvolutionData at the corresponding time and Burnup
+ void AddFuel(cSecond time, PhysicsModels* fuel, double BurnUp)
+ { AddFuel( time, CLASSFuel(fuel), BurnUp); } //!< Add A new Physicis Model at the corresponding time and Burnup
- void AddFuel(cSecond time, CLASSFuel fuel, double BurnUp);
+ //a}
- void AddFuel(cSecond time, EvolutionData* fuel, double BurnUp) {AddFuel( time, CLASSFuel(fuel), BurnUp);}
- void AddFuel(cSecond time, PhysicsModels* fuel, double BurnUp) {AddFuel( time, CLASSFuel(fuel), BurnUp);}
+ /*!
+ \name Get Method
+ */
+ //@{
- pair< CLASSFuel, double> GetFuelAt(cSecond t);
+ pair< CLASSFuel, double> GetFuelAt(cSecond t); //!< Get fuel and associated Burnup loaded at the time t
+
+ //@}
using CLASSObject::SetName;
using CLASSObject::GetName;
protected :
@@ -57,7 +90,7 @@ class CLASSFuelPlan : public CLASSObject
private :
- map< cSecond, pair< CLASSFuel, double > > fLoadingPlan; ///< Loading PLan to change the EvolutionData (and the associetedBurnup) according to the Plan
+ map< cSecond, pair< CLASSFuel, double > > fLoadingPlan; ///< Loading PLan to change the EvolutionData (and the associeted Burnup) according to the Plan
};
diff --git a/source/trunk/include/CLASSLogger.hxx b/source/trunk/include/CLASSLogger.hxx
index 621402068..89709dc63 100755
--- a/source/trunk/include/CLASSLogger.hxx
+++ b/source/trunk/include/CLASSLogger.hxx
@@ -43,19 +43,19 @@ using namespace std;
+#ifndef _LOGTYPE_CLASS
+#define _LOGTYPE_CLASS
+
//-----------------------------------------------------------------------------//
/*!
- Define a CLASSLogger.
- The aim of this class is to centralize the all CLASS software message inside a file.
-
-
+ Define a LogType.
+ The aim of this class is to handel stream in CLASS.
+
+
@author BaM
@version 2.0
*/
//________________________________________________________________________
-#ifndef _LOGTYPE_CLASS
-#define _LOGTYPE_CLASS
-
class LogType
@@ -68,9 +68,15 @@ public:
*/
//@{
-
+ //{
+ /// Normal Constructor.
+ /*!
+ Make a new LogType
+ \param Log : ostream output
+ */
LogType(ostream &Log) { fLog = &Log; fLog2 = 0; } //!< Normal Constructor
-
+ //}
+
~LogType() {} //!< Normal Destructor
//@}
@@ -81,7 +87,7 @@ public:
\name In/Out
*/
//@{
- string GetCLASSLoggerName() const { return fCLASSLoggerName; } //!w return the CLASSLogger name
+ string GetCLASSLoggerName() const { return fCLASSLoggerName; } //!< return the CLASSLogger name
LogType &operator<<(std::ostream& (*manip)(std::ostream &))
{
@@ -100,14 +106,14 @@ public:
*(this->fLog2) << something;
return *this;
}
+ //}
-
- void SetSecondOutput(ostream &log) {fLog2 = &log;}
+ void SetSecondOutput(ostream &log) {fLog2 = &log;} // used to direct the stream into two output ostream
private :
- ostream *fLog;
- ostream *fLog2;
+ ostream *fLog; //!< Main ostream output
+ ostream *fLog2; //!< secondary ostream output
string fCLASSLoggerName; //!< Log File name
};
@@ -119,6 +125,16 @@ public:
#ifndef _CLASSLogger_CLASS_
#define _CLASSLogger_CLASS_
+//-----------------------------------------------------------------------------//
+/*!
+ Define a CLASSLogger.
+ The aim of this class is to centralize the all CLASS software message inside a file.
+
+
+ @author BaM
+ @version 2.0
+ */
+//________________________________________________________________________
class CLASSLogger
@@ -131,10 +147,24 @@ public:
\name Constructor/Desctructor
*/
//@{
- CLASSLogger();
-
- CLASSLogger(string CLASSLoggerName, int VerboseLvl = 0, int OutputLvl = 1 ); //!< Normal Constructor
-
+ //{
+ /// Normal Constructor.
+ /*!
+ Make a new LogType
+ \param CLASSLoggerName : name of the CLASSLogFile wnated for the log
+ \param VerboseLvl : verbose level in terminal
+ \param OutputLvl : verbose level in the CLASSLogFile
+
+ The different available levels are :
+ \li 0 : ERROR only
+ \li 1 : WARNING + lvl 0
+ \li 2 : INFO + lvl 1
+ \li 3 : DEBUG + lvl 2
+
+ */
+ CLASSLogger(string CLASSLoggerName = "CLASS_OUTPUT.log", int VerboseLvl = 0, int OutputLvl = 1 );
+ //}
+
~CLASSLogger(); //!< Normal Destructor
//@}
@@ -145,14 +175,14 @@ public:
\name In/Out
*/
//@{
- string GetCLASSLoggerName() const { return fCLASSLoggerName; } //!w return the CLASSLogger name
- int GetMaxOutPutLVL() const { return fMaxOutPutLVL; }
+ string GetCLASSLoggerName() const { return fCLASSLoggerName; } //!< return the CLASSLogger name
+ int GetMaxOutPutLVL() const { return fMaxOutPutLVL; } //!< Return File Output lvl
int GetVerboseLVL() const { return fVerboseLVL; }
- LogType E() {return *fError;}
- LogType W() {return *fWarning;}
- LogType D() {return *fDebug;}
- LogType I() {return *fInfo;}
+ LogType E() {return *fError;} //!< Return the ERROR Streamer
+ LogType W() {return *fWarning;} //!< Return the WARNING Streamer
+ LogType I() {return *fInfo;} //!< Return the INFO Streamer
+ LogType D() {return *fDebug;} //!< Return the DEBUG Streamer
//@}
@@ -160,15 +190,15 @@ public:
private :
- int fMaxOutPutLVL;
+ int fMaxOutPutLVL; //!< Maximal output/verbose lvl
int fVerboseLVL;
- LogType* fError;
- LogType* fInfo;
- LogType* fWarning;
- LogType* fDebug;
+ LogType* fError; //!< ERROR streamer
+ LogType* fInfo; //!< INFO streamer
+ LogType* fWarning; //!< WARNING streamer
+ LogType* fDebug; //!< DEBUG streamer
- ofstream fOutPutFile;
+ ofstream fOutPutFile; //!< Log Output File name
string fCLASSLoggerName; //!< Log File name
};
diff --git a/source/trunk/include/CLASSNucleiFiliation.hxx b/source/trunk/include/CLASSNucleiFiliation.hxx
index e28664e55..3b3113a37 100644
--- a/source/trunk/include/CLASSNucleiFiliation.hxx
+++ b/source/trunk/include/CLASSNucleiFiliation.hxx
@@ -44,7 +44,7 @@ public:
~CLASSNucleiFiliation(); ///< Normal Destructor.
- //}
+ //@}
//********* Get Method *********//
diff --git a/source/trunk/include/CLASSObject.hxx b/source/trunk/include/CLASSObject.hxx
index 4a7118861..b4fe7beae 100644
--- a/source/trunk/include/CLASSObject.hxx
+++ b/source/trunk/include/CLASSObject.hxx
@@ -37,18 +37,51 @@ using namespace std;
class CLASSObject : public TNamed
{
public :
- ///< Normal Constructor.
+ /*!
+ \name Constructor/Desctructor
+ */
+ //@{
+
+ //{
+ /// Normal Constructor.
+ /*!
+ Make a new CLASSObject
+ */
CLASSObject();
+ //}
+
+ //{
+ /// Log Constructor.
+ /*!
+ Make a new CLASSObject
+ \param log : used for the log.
+ */
+
CLASSObject(CLASSLogger* log);
+ //}
+ //@}
+
+ /*!
+ \name Clone
+ */
+ //@{
-
virtual CLASSObject* Clone() { return new CLASSObject(*this); } //!< Correct way to copy a CLASSObject in case of derivation
+ //}
+ //@}
+
+
+ /*!
+ \name Set/Get
+ */
+ //@{
+
#ifndef __CINT__
void SetLog(CLASSLogger* log) { fLog = log;} //!< Set the CLASSLogger
CLASSLogger* GetLog() { return fLog; } //!< Return the Pointer to the Log
#endif
-
+ //@}
using TNamed::SetName;
using TNamed::GetName;
diff --git a/source/trunk/include/DecayDataBank.hxx b/source/trunk/include/DecayDataBank.hxx
index af502e18c..1809ffa05 100644
--- a/source/trunk/include/DecayDataBank.hxx
+++ b/source/trunk/include/DecayDataBank.hxx
@@ -61,22 +61,21 @@ class DecayDataBank : public CLASSObject
//{
/// Special Constructor.
/*!
- Use to load a CLASSLogger
- \param CLASSLogger CLASSLogger used for the log...
- \param DB_index_file path to the index file
- \param setlog if the log are stored in the CLASSLogger
- \param olfreadmethod true if the old format of EvolutionData are used (ie without the key word such as Inv, XSFiss...)
+ Use to load a DecayDataBank
+ \param DB_index_file : path to the index file
+ \param setlog if the : log are stored in the CLASSLogger
+ \param olfreadmethod : true if the old format of EvolutionData are used (ie without the key word such as Inv, XSFiss...)
*/
DecayDataBank(string DB_index_file, bool olfreadmethod = false );
//}
//{
/// Special Constructor.
/*!
- Use to load a CLASSLogger
- \param CLASSLogger CLASSLogger used for the log...
- \param DB_index_file path to the index file
- \param setlog if the log are stored in the CLASSLogger
- \param olfreadmethod true if the old format of EvolutionData are used (ie without the key word such as Inv, XSFiss...)
+ Use to load a DecayDataBank
+ \param Log : CLASSLogger used for the log.
+ \param DB_index_file : path to the index file
+ \param setlog : if the log are stored in the CLASSLogger
+ \param olfreadmethod : true if the old format of EvolutionData are used (ie without the key word such as Inv, XSFiss...)
*/
DecayDataBank(CLASSLogger* Log, string DB_index_file, bool olfreadmethod = false );
//}
@@ -107,14 +106,11 @@ class DecayDataBank : public CLASSObject
\name Get Method
*/
//@{
- map<ZAI ,EvolutionData > GetDecayDataBank() const { return fDecayDataBank; } //!< Return the DecayDataBank
- string GetDataBaseIndex() const { return fDataBaseIndex; } //!< Return the index Name
- bool IsDefine(const ZAI& zai) const; //!< True the key is define, false unstead
-
- string GetDataFileName() const { return fDataFileName; }
- string GetDataDirectoryName() const { return fDataDirectoryName; }
-
- double GetShorstestHalflife() const { return fShorstestHalflife; }
+ map<ZAI ,EvolutionData > GetDecayDataBank() const { return fDecayDataBank; } //!< Return the DecayDataBank
+ bool IsDefine(const ZAI& zai) const; //!< True the key is define, false unstead
+
+ string GetDataBaseIndex() const { return fDataBaseIndex; } //!< Return the index Name
+
IsotopicVector GetDecay(IsotopicVector isotopicvector, cSecond t); //!< Get IsotopicVector Decay at the t time
//@}
@@ -129,11 +125,12 @@ class DecayDataBank : public CLASSObject
*/
//@{
- void SetDecayDataBank(map<ZAI ,EvolutionData > mymap) { fDecayDataBank = mymap; } //!< Set the DecayDataBank map
+ void SetDecayDataBank(map<ZAI ,EvolutionData > mymap)
+ { fDecayDataBank = mymap; } //!< Set the DecayDataBank map
- void SetDataBaseIndex(string database) { fDataBaseIndex = database;; ReadDataBase(); } //!< Set the Name of the database index
+ void SetDataBaseIndex(string database) { fDataBaseIndex = database;; ReadDataBase(); } //!< Set the Name of the database index
- void SetOldReadMethod(bool val) { fOldReadMethod = val; ReadDataBase();} ///< use the old reading method
+ void SetOldReadMethod(bool val) { fOldReadMethod = val; ReadDataBase();} ///< use the old reading method
//}
@@ -148,7 +145,6 @@ class DecayDataBank : public CLASSObject
*/
//@{
-
IsotopicVector Evolution(const ZAI& zai, double dt); ///< Return the Product IsotopicVector evolution from zai during a dt time
//@}
@@ -173,16 +169,8 @@ class DecayDataBank : public CLASSObject
protected :
- double fShorstestHalflife;
- int fZAIThreshold; //!< Highest Mass deal bye the evolution (default 90)
-
- string fDataFileName; ///< Name of the decay list
- string fDataDirectoryName; ///< Path to the decay list file
-
map<ZAI, EvolutionData> fDecayDataBank; ///< DataBanck map
-
- string fDataBaseIndex; ///< Name of the index
-
+ string fDataBaseIndex; ///< Name of the index
bool fOldReadMethod; ///< use old DB format
};
diff --git a/source/trunk/include/EvolutionData.hxx b/source/trunk/include/EvolutionData.hxx
index 2cb296e50..0115bf3c5 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 CLASSLogger CLASSLogger used for the log.
*/
EvolutionData(CLASSLogger* log); ///< Make a new Evolutive Product evolution
//}
@@ -77,7 +77,7 @@ public :
/// Special Constructor.
/*!
Make a new EvolutionData
- \param Log CLASSLogger used for the log...
+ \param log : used for the log.
\param DB_file path to the DataBase file
\param oldread true if the oldmethod should be use to read the DatBase File
\param zai set the ZAI if you want to add a stable nuclei.
@@ -157,7 +157,7 @@ public :
string GetReactorType() const { return fReactorType; } //!< return the type of reactor (string)
TGraph* GetEvolutionTGraph(const ZAI& zai); //!< return the evolution of the ZAI quantity (TGraph*)
- IsotopicVector GetIsotopicVectorAt(double t); ///< Return the Product IsotopicVector at t time
+ IsotopicVector GetIsotopicVectorAt(double t); ///< Return the Product IsotopicVector at t time
double GetHeavyMetalMass() const { return fHeavyMetalMass; } //!< Return the HeavyMetal Mass in the Core at the begining of the cycle
@@ -208,11 +208,11 @@ protected :
#ifndef __CINT__
map<ZAI ,TGraph* > fInventoryEvolution; //!< evolution map
- map<ZAI ,TGraph* > fFissionXS; //!< fission cross section map
- map<ZAI ,TGraph* > fCaptureXS; //!< capture cross section map
- map<ZAI ,TGraph* > fn2nXS; //!< (n,2n) cross section map
- TGraph* fKeff; //!< Keff evolution
- TGraph* fFlux; //!< Flux evolution
+ map<ZAI ,TGraph* > fFissionXS; //!< fission cross section map
+ map<ZAI ,TGraph* > fCaptureXS; //!< capture cross section map
+ map<ZAI ,TGraph* > fn2nXS; //!< (n,2n) cross section map
+ TGraph* fKeff; //!< Keff evolution
+ TGraph* fFlux; //!< Flux evolution
#endif
cSecond fFinalTime; ///< time of the last point
diff --git a/source/trunk/include/Pool.hxx b/source/trunk/include/Pool.hxx
index 12229ec16..4c4ecaba0 100755
--- a/source/trunk/include/Pool.hxx
+++ b/source/trunk/include/Pool.hxx
@@ -49,7 +49,7 @@ public :
/// Special Constructor.
/*!
Make a new Pool
- \param Log CLASSLogger used for the log...
+ \param log : used for the log.
\param coolingtime duration of the cooling.
*/
Pool(CLASSLogger* Log, cSecond coolingtime = 5*3600.*24.*365.25); //!<
@@ -60,7 +60,7 @@ public :
/// Special Special Constructor.
/*!
Make a new Pool
- \param Log CLASSLogger used for the log...
+ \param log : used for the log.
\param CLASSBackEnd backend which get the fuel after the cooling
\param coolingtime duration of the cooling.
*/
diff --git a/source/trunk/include/Reactor.hxx b/source/trunk/include/Reactor.hxx
index 3212d8097..6883df4ba 100755
--- a/source/trunk/include/Reactor.hxx
+++ b/source/trunk/include/Reactor.hxx
@@ -56,7 +56,7 @@ public :
/// CLASSLogger Constructor.
/*!
Use create an empty Reactor loading a CLASSLogger
- \param CLASSLogger CLASSLogger used for the log...
+ \param CLASSLogger CLASSLogger used for the log.
*/
Reactor(CLASSLogger* log);
//}
@@ -65,7 +65,7 @@ public :
/// Special Constructor for reprocessed fuel using cycletime and Burn-Up.
/*!
Make a new reactor
- \param CLASSLogger CLASSLogger used for the log...
+ \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.
@@ -82,7 +82,7 @@ public :
/// Special Constructor for reprocessed fuel using cycletime and Burn-Up.
/*!
Make a new reactor
- \param CLASSLogger CLASSLogger used for the log...
+ \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.
@@ -100,7 +100,7 @@ public :
/// Special Constructor for reprocessed fuel using cycletime and Burn-Up.
/*!
Make a new reactor
- \param CLASSLogger CLASSLogger used for the log...
+ \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
@@ -119,7 +119,7 @@ public :
/// Special Constructor for reprocessed fuel using Power and Burn-Up.
/*!
Make a new reactor
- \param CLASSLogger CLASSLogger used for the log...
+ \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
@@ -139,7 +139,7 @@ public :
/// Special Constructor for fixed fuel using Power and Burn-Up.
/*!
Make a new reactor
- \param CLASSLogger CLASSLogger used for the log...
+ \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
@@ -158,7 +158,7 @@ public :
/// Special Constructor for fixed fuel using Power and Burn-Up.
/*!
Make a new reactor
- \param CLASSLogger CLASSLogger used for the log...
+ \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
diff --git a/source/trunk/include/Scenario.hxx b/source/trunk/include/Scenario.hxx
index 29d88d5dd..2e82bf118 100755
--- a/source/trunk/include/Scenario.hxx
+++ b/source/trunk/include/Scenario.hxx
@@ -56,7 +56,7 @@ public :
Scenario(CLASSLogger* Log, cSecond abstime = 0); ///< Log Constructor.
/*!
Use to load a CLASSLogger
- \param CLASSLogger: CLASSLogger used for the log...
+ \param CLASSLogger: CLASSLogger used for the log.
*/
Scenario(cSecond abstime); ///< Time Constructor.
diff --git a/source/trunk/include/SeparationPlant.hxx b/source/trunk/include/SeparationPlant.hxx
index 7f972d28a..0307ab0fc 100644
--- a/source/trunk/include/SeparationPlant.hxx
+++ b/source/trunk/include/SeparationPlant.hxx
@@ -49,7 +49,7 @@ public :
/// Special Constructor.
/*!
Make a new SeparationPlant
- \param Log CLASSLogger used for the log...
+ \param log : used for the log.
\param separationtime duration of the SeparationPlant
*/
SeparationPlant(CLASSLogger* Log); //!<
diff --git a/source/trunk/include/Storage.hxx b/source/trunk/include/Storage.hxx
index 7b7df5f96..580c22f18 100644
--- a/source/trunk/include/Storage.hxx
+++ b/source/trunk/include/Storage.hxx
@@ -49,7 +49,7 @@ public :
/// CLASSLogger Constructor.
/*!
Use create an empty Stotarage loading a CLASSLogger
- \param CLASSLogger CLASSLogger used for the log...
+ \param CLASSLogger CLASSLogger used for the log.
*/
Storage(CLASSLogger* log);
//}
@@ -59,7 +59,7 @@ public :
/// Special Constructor.
/*!
Make a new reactor
- \param CLASSLogger CLASSLogger used for the log...
+ \param CLASSLogger CLASSLogger used for the log.
\param evolutivedb DataBank for decay management
*/
Storage(CLASSLogger* log, DecayDataBank* evolutivedb);
@@ -139,7 +139,7 @@ public :
/// Write the Isotope composition of all IsotopicVector stored.
/*!
Make a new reactor
- \param filenam CLASSLogger used for the log...
+ \param filenam CLASSLogger used for the log.
\param data only use to srite a date in the file, theyr is not treatment of the date in this method....
*/
void Write(string filename,cSecond date = -1);
diff --git a/source/trunk/src/CLASSLogger.cxx b/source/trunk/src/CLASSLogger.cxx
index d5b95630f..31839ca64 100755
--- a/source/trunk/src/CLASSLogger.cxx
+++ b/source/trunk/src/CLASSLogger.cxx
@@ -14,13 +14,8 @@ using namespace std;
//
//
//________________________________________________________________________
-CLASSLogger::CLASSLogger()
+CLASSLogger::CLASSLogger(string CLASSLoggerName, int VerboseLvl, int OutputLvl )
{
- string CLASSLoggerName = "CLASS_OUTPUT.log";
- int VerboseLvl = 0;
- int OutputLvl = 1;
-
-
fCLASSLoggerName = CLASSLoggerName;
fOutPutFile.open(CLASSLoggerName.c_str());
fVerboseLVL = VerboseLvl;
@@ -34,12 +29,12 @@ CLASSLogger::CLASSLogger()
fWarning = 0;
fDebug = 0;
fInfo = 0;
-
+
if (VerboseLvl <= OutputLvl)
fMaxOutPutLVL = OutputLvl;
else
fMaxOutPutLVL = VerboseLvl;
-
+
if(VerboseLvl >= 0)
{
if (!fError)
@@ -47,6 +42,7 @@ CLASSLogger::CLASSLogger()
else
fError->SetSecondOutput(std::cout);
}
+
if(VerboseLvl >= 1)
{
if (!fWarning)
@@ -68,93 +64,8 @@ CLASSLogger::CLASSLogger()
else
fDebug->SetSecondOutput(std::cout);
}
- if(OutputLvl >= 0)
- {
- if (!fError)
- fError = new LogType(fOutPutFile);
- else
- fError->SetSecondOutput(fOutPutFile);
- }
- if(OutputLvl >= 1)
- {
- if (!fWarning)
- fWarning = new LogType(fOutPutFile);
- else
- fWarning->SetSecondOutput(fOutPutFile);
- }
- if(OutputLvl >= 2)
- {
- if (!fInfo)
- fInfo = new LogType(fOutPutFile);
- else
- fInfo->SetSecondOutput(fOutPutFile);
- }
- if(OutputLvl >= 3)
- {
- if (!fDebug)
- fDebug = new LogType(fOutPutFile);
- else
- fDebug->SetSecondOutput(fOutPutFile);
- }
-
-}
-
-
-
-CLASSLogger::CLASSLogger(string CLASSLoggerName, int VerboseLvl, int OutputLvl )
-{
- fCLASSLoggerName = CLASSLoggerName;
- fOutPutFile.open(CLASSLoggerName.c_str());
- fVerboseLVL = VerboseLvl;
- if(!fOutPutFile)
- {
- cout << "Could not open the CLASSLogger: " << CLASSLoggerName << " !" << endl;
- exit(-1);
- }
-
- fError = 0;
- fWarning = 0;
- fDebug = 0;
- fInfo = 0;
-
- if (VerboseLvl <= OutputLvl)
- fMaxOutPutLVL = OutputLvl;
- else
- fMaxOutPutLVL = VerboseLvl;
-
- if(VerboseLvl >= 0)
- {
- if (!fError)
- fError = new LogType(std::cout);
- else
- fError->SetSecondOutput(std::cout);
- }
-
- if(VerboseLvl >= 1)
- {
- if (!fWarning)
- fWarning = new LogType(std::cout);
- else
- fWarning->SetSecondOutput(std::cout);
- }
- if(VerboseLvl >= 2)
- {
- if (!fInfo)
- fInfo = new LogType(std::cout);
- else
- fInfo->SetSecondOutput(std::cout);
- }
- if(VerboseLvl >= 3)
- {
- if (!fDebug)
- fDebug = new LogType(std::cout);
- else
- fDebug->SetSecondOutput(std::cout);
- }
-
-
if(OutputLvl >= 0)
{
if (!fError)
diff --git a/source/trunk/src/EvolutionData.cxx b/source/trunk/src/EvolutionData.cxx
index 371b63b30..572fdfdc9 100755
--- a/source/trunk/src/EvolutionData.cxx
+++ b/source/trunk/src/EvolutionData.cxx
@@ -340,8 +340,20 @@ EvolutionData Sum(EvolutionData const& evol1, EvolutionData const& evol2)
- //________________________________________________________________________
- //________________________________________________________________________
+//________________________________________________________________________
+//________________________________________________________________________
+//________________________________________________________________________
+//________________________________________________________________________
+//________________________________________________________________________
+//________________________________________________________________________
+//________________________________________________________________________
+//________________________________________________________________________
+//________________________________________________________________________
+//________________________________________________________________________
+//________________________________________________________________________
+//________________________________________________________________________
+//________________________________________________________________________
+//________________________________________________________________________
ClassImp(EvolutionData)
diff --git a/source/trunk/src/IrradiationModel.cxx b/source/trunk/src/IrradiationModel.cxx
index 2055a9b62..657873270 100644
--- a/source/trunk/src/IrradiationModel.cxx
+++ b/source/trunk/src/IrradiationModel.cxx
@@ -440,7 +440,7 @@ void IrradiationModel::NuclearDataInitialization()
}
-void IrradiationModel::BuildReactionFiliation()
+void IrradiationModel::BuildReactionFiliation()
{
DBGL
--
GitLab