add and/or correct doxygen comments

git-svn-id: svn+ssh://svn.in2p3.fr/class@714 0e7d625b-0364-4367-a6be-d5be4a48d228

source/branches/BaM_Dev/Model/Equivalence/EQM_FBR_MLP_Keff.hxx

@@ -179,14 +179,18 @@ class EQM_FBR_MLP_Keff : public EquivalenceModel
 	double 	fTargetKeff;		//!< Use for Varying Fissile content to reach fTargetKeff at time used in the MLP Training
 	
 
-	
-	double 	GetKeffAtFixedTime(IsotopicVector FreshFuel){return ExecuteTMVA( CreateTMVAInputTree(FreshFuel,-1), false );} //!<time independant since the MLP is trained for 1 time
-
-	TGraph* BuildKeffGraph(IsotopicVector FreshFuel);
-	TGraph* BuildAverageKeffGraph(TGraph* GRAPH_KEFF);
+	/*!
+	 \name keff prediction methods & keff averaging
+	 */
+	//@{
 
-	double 	GetKeffAt(TGraph* GRAPH_KEFF, int Step);
+		double 	GetKeffAtFixedTime(IsotopicVector FreshFuel){return ExecuteTMVA( CreateTMVAInputTree(FreshFuel,-1), false );} //!<time independant since the MLP is trained for 1 time
+	
+		TGraph* BuildKeffGraph(IsotopicVector FreshFuel);
+		TGraph* BuildAverageKeffGraph(TGraph* GRAPH_KEFF);
+		double 	GetKeffAt(TGraph* GRAPH_KEFF, int Step);
 
+	//@}	
 
 
 	

source/branches/BaM_Dev/Model/Equivalence/EQM_FBR_MLP_Keff_BOUND.hxx

@@ -31,7 +31,7 @@ typedef void (EQM_FBR_MLP_Keff_BOUND::*FBR_MLP_Keff_BOUND_DMthPtr)( const string
  
  \warning
  it is not guaranted that there is a solution for Pu content verifying :
- @f$<k_{\infty}>^{batch}(t) = \frac{1}{N}\sum_{i}^{N}k_{\infty}(t+\frac{iT}{N} )@f$
+ @f$ k_{\infty Max} \geq <k_{\infty}>^{batch}(T/N) \geq k_{\infty Min} @f$
  
  @author BLG
  @author BaM
@@ -183,7 +183,11 @@ class EQM_FBR_MLP_Keff_BOUND : public EquivalenceModel
 	
 	
 	
-	
+	/*!
+	 \name kinf prediction methods & keff averaging
+	 */
+	//@{
+	 
 	double 	GetKeffAtFixedTime(IsotopicVector FreshFuel){return ExecuteTMVA( CreateTMVAInputTree(FreshFuel,-1), false );} //!<time independant since the MLP is trained for 1 time
 	
 	TGraph* BuildKeffGraph(IsotopicVector FreshFuel);
@@ -191,6 +195,7 @@ class EQM_FBR_MLP_Keff_BOUND : public EquivalenceModel
 	
 	double 	GetKeffAt(TGraph* GRAPH_KEFF, int Step);
 	
+	//@}
 	
 	
 	

source/branches/BaM_Dev/Model/Equivalence/EQM_MLP_Kinf.hxx

@@ -25,7 +25,7 @@ average @f$\langle k_{\infty}\rangle (t)@f$ is calculated according :
 
 @f$\langle k_{\infty}\rangle ^{batch}(t) = \frac{1}{N}\sum_{i}^{N}k_{\infty}(t+\frac{iT}{N})@f$
 The maximal reachable burnup has to verify the following conditions :
-@f$\langle k_{\infty}\rangle ^{batch}(T/N) = <\langle k_{\infty}\rangle ^{batch}(2T/N)  = ... = k_{Threshold}@f$
+@f$\langle k_{\infty}\rangle ^{batch}(T/N) = \langle k_{\infty}\rangle ^{batch}(2T/N)  = ... = k_{Threshold}@f$
 Where @f$k_{Threshold}@f$ is the criticality threshold which take into account leakage and capture
 in non simulated devices such as control rods and mixing grid.
 
@@ -115,17 +115,34 @@ class EQM_MLP_Kinf : public EquivalenceModel
 
 	void SetBurnUpPrecision(double prop){fBurnUpPrecision = prop;} //!< Set the precision on Burnup : proportion of the targeted burnup
 	void SetPCMprecision(double pcm){fPCMprecision = pcm;}		  //!< Set the precision on @f$\langle k \rangle@f$ prediction [pcm]. Neural network predictor constructors
-
 	double GetBurnUpPrecision(){return fBurnUpPrecision;}//!< Get the precision on Burnup : proportion of the targeted burnup
 	double GetPCMprecision(){return fPCMprecision/1e5;}//!< Get the precision on @f$\langle k \rangle@f$ prediction []. Neural network predictor constructors
-	double GetMaximumBurnUp_MLP(IsotopicVector TheFuel, double TargetBU);
+	
+	double GetMaximumBurnUp(IsotopicVector TheFuel, double TargetBU);//!<Get the maximum reachable burnup according the freshfuel composition
+	void   GetModelInformation();//!<Read the fMLPInformationFile and fill containers and variables
+	
+	//@}
+
+	/*!
+	 \name Time <-> Burnup conversion
+	 */
+	//@{
+
+	double SecondToBurnup(double Second){return Second*fSpecificPower/(24*3.6e6);}
+	double BurnupToSecond(double BurnUp){return BurnUp/fSpecificPower*(24*3.6e6);}
 
 	//@}
+
+	/*!
+	 \name TMVA related methods
+	 */
+	//@{
+
 	TTree* CreateTMVAInputTree(IsotopicVector FreshFuel, double ThisTime);//!<Create input tmva tree to be read by ExecuteTMVA
 	double ExecuteTMVA(TTree* theTree, string WeightPath, bool IsTimeDependant);//!<Execute the MLP according to the input tree created by CreateTMVAInputTree
-	double SecondToBurnup(double Second){return Second*fSpecificPower/(24*3.6e6);}
 
-	
+	//@}
+
 	/*!
 	 \name Reading NFO related Method
 	 */
@@ -179,13 +196,15 @@ class EQM_MLP_Kinf : public EquivalenceModel
 	
 	map<ZAI,string> fMapOfTMVAVariableNames;//!<  List of TMVA input variable names (read from fMLPInformationFile ) , name depends on the training step
 
-	
-	
+	/*!
+	 \name private Get/Set methods
+	 */
+	//@{
+
+	double GetMaximumBurnUp_MLP(IsotopicVector TheFuel, double TargetBU);
 	double GetMaximumBurnUp_Pol2(IsotopicVector TheFuel, double TargetBU);
-	double GetMaximumBurnUp(IsotopicVector TheFuel, double TargetBU);//!<Get the maximum reachable burnup according the freshfuel composition
-	void   GetModelInformation();//!<Read the fMLPInformationFile and fill containers and variables
-	
-	double BurnupToSecond(double BurnUp){return BurnUp/fSpecificPower*(24*3.6e6);}
+
+	//@}
 
 	int 	fNumberOfBatch;		//!< The number of batches for the loading plan
 	double 	fKThreshold;		//!< The @f$k_{Threshold}@f$

source/branches/BaM_Dev/Model/Equivalence/EQM_PWR_MLP_MOX.hxx

@@ -56,10 +56,17 @@ class EQM_PWR_MLP_MOX : public EquivalenceModel
 	virtual double GetFissileMolarFraction(IsotopicVector Fissil,IsotopicVector Fertil,double BurnUp);
 	//}
 	
+	/*!
+	 \name TMVA related methods
+	 */
+	//@{
+
+		TTree* CreateTMVAInputTree(IsotopicVector Fissil,IsotopicVector Fertil,double BurnUp);//!<Create input tmva tree to be read by ExecuteTMVA
+		double ExecuteTMVA(TTree* theTree);//!<Execute the MLP according to the input tree created by CreateTMVAInputTree
+		
+	//@}	
+
 	private :
-	
-	TTree* CreateTMVAInputTree(IsotopicVector Fissil,IsotopicVector Fertil,double BurnUp);//!<Create input tmva tree to be read by ExecuteTMVA
-	double ExecuteTMVA(TTree* theTree);//!<Execute the MLP according to the input tree created by CreateTMVAInputTree
 
 
 	string fTMVAWeightPath;;//!<The weight needed by TMVA to construct and execute the multilayer perceptron

source/branches/BaM_Dev/Model/Equivalence/EQM_PWR_MLP_MOX_Am.hxx

@@ -56,11 +56,18 @@ class EQM_PWR_MLP_MOX_AM : public EquivalenceModel
 	virtual double GetFissileMolarFraction(IsotopicVector Fissil,IsotopicVector Fertil,double BurnUp);
 	//}
 	
+	/*!
+	 \name TMVA related methods
+	 */
+	//@{
+
+		TTree* CreateTMVAInputTree(IsotopicVector Fissil,IsotopicVector Fertil,double BurnUp);//!<Create input tmva tree to be read by ExecuteTMVA
+		double ExecuteTMVA(TTree* theTree);//!<Execute the MLP according to the input tree created by CreateTMVAInputTree
+
+	//@}	
+
 	private :
 	
-	TTree* CreateTMVAInputTree(IsotopicVector Fissil,IsotopicVector Fertil,double BurnUp);//!<Create input tmva tree to be read by ExecuteTMVA
-	double ExecuteTMVA(TTree* theTree);//!<Execute the MLP according to the input tree created by CreateTMVAInputTree
-
 
 	string fTMVAWeightPath;;//!<The weight needed by TMVA to construct and execute the multilayer perceptron