From 7018f110722fc1c3a100c2252d0a6803251c07a7 Mon Sep 17 00:00:00 2001
From: Baptiste LENIAU <baptiste.leniau@subatech.in2p3.fr>
Date: Sun, 19 Jul 2015 20:42:16 +0000
Subject: [PATCH] Add comments for doxygen to work properly
git-svn-id: svn+ssh://svn.in2p3.fr/class@712 0e7d625b-0364-4367-a6be-d5be4a48d228
---
.../Equivalence/EQM_FBR_BakerRoss_MOX.hxx | 9 ----
.../Model/Equivalence/EQM_FBR_MLP_Keff.hxx | 40 +++++++-----------
.../Equivalence/EQM_FBR_MLP_Keff_BOUND.hxx | 33 +++++----------
.../Model/Equivalence/EQM_MLP_Kinf.hxx | 41 ++++++++-----------
.../Model/Equivalence/EQM_PWR_LIN_MOX.hxx | 9 ----
.../Model/Equivalence/EQM_PWR_MLP_MOX.hxx | 11 -----
.../Model/Equivalence/EQM_PWR_MLP_MOX_Am.hxx | 11 -----
.../Model/Equivalence/EQM_PWR_POL_UO2.hxx | 2 -
.../Model/Equivalence/EQM_PWR_QUAD_MOX.hxx | 9 ----
9 files changed, 41 insertions(+), 124 deletions(-)
diff --git a/source/branches/BaM_Dev/Model/Equivalence/EQM_FBR_BakerRoss_MOX.hxx b/source/branches/BaM_Dev/Model/Equivalence/EQM_FBR_BakerRoss_MOX.hxx
index 40718a7fd..b6125293b 100644
--- a/source/branches/BaM_Dev/Model/Equivalence/EQM_FBR_BakerRoss_MOX.hxx
+++ b/source/branches/BaM_Dev/Model/Equivalence/EQM_FBR_BakerRoss_MOX.hxx
@@ -5,15 +5,6 @@
#include <string>
-/*!
- \file
- \brief Header file for EQM_FBR_BakerRoss_MOX class.
-
-
- @author BLG
- @version 1.0
- */
-
using namespace std;
//-----------------------------------------------------------------------------//
diff --git a/source/branches/BaM_Dev/Model/Equivalence/EQM_FBR_MLP_Keff.hxx b/source/branches/BaM_Dev/Model/Equivalence/EQM_FBR_MLP_Keff.hxx
index f9060977d..02802dbad 100644
--- a/source/branches/BaM_Dev/Model/Equivalence/EQM_FBR_MLP_Keff.hxx
+++ b/source/branches/BaM_Dev/Model/Equivalence/EQM_FBR_MLP_Keff.hxx
@@ -10,47 +10,35 @@
#include <map>
#include <vector>
-/*!
- \file
- \brief Header file for EQM_FBR_MLP_Keff class.
-
-
- @author BLG
- @author BaM
- @version 1.0
- */
-
-
using namespace std;
+class EQM_FBR_MLP_Keff;
+#ifndef __CINT__
+typedef void (EQM_FBR_MLP_Keff::*FBR_MLP_Keff_DMthPtr)( const string & ) ;
+#endif
+
//-----------------------------------------------------------------------------//
-//! Defines an EquivalenceModel based on neural network to predict @f$k_{eff}@f$
+//! Defines an EquivalenceModel based on neural network to predict @f$k_{eff}@f$.
+
/*!
The aim of these class is to constuct a fuel from an equivalence model
-based on a Multi layer perceptron (MLP).
-This MLP aims to predict either :
-
-The Pu content is set such as it has to verify
+based on a Multi layer perceptron (MLP).
+This MLP aims to predict the Pu content such as it has to verify
@f$ k(WantedTime) = k_{target}@f$ with @f$k_{target}@f$ is often close to 1.0
but can be set by user. The wanted time is often either
the begining of cycle or end of cycle. WantedTime can't be set by user since it is
contain in the .xml file. Indeed this method suppose you have trained your MLP to predict
- the keffective either at BOC or EOC (or any other time)
+ the @f$k_{eff}@f$ either at BOC or EOC (or any other time)
@author BLG
@author BaM
@version 1.0
*/
//________________________________________________________________________
-class EQM_FBR_MLP_Keff;
-#ifndef __CINT__
-typedef void (EQM_FBR_MLP_Keff::*FBR_MLP_Keff_DMthPtr)( const string & ) ;
-#endif
-
class EQM_FBR_MLP_Keff : public EquivalenceModel
{
- public :
+ public:
/*!
\name Constructor
*/
@@ -99,8 +87,8 @@ class EQM_FBR_MLP_Keff : public EquivalenceModel
\name Get/Set methods
*/
//@{
- void SetPCMprecision(double pcm){fPCMprecision = pcm;} //!< Set the precision on <k> prediction [pcm]. Neural network predictor constructors
- double GetPCMprecision(){return fPCMprecision/1e5;} //!< Get the precision on <k> prediction []. Neural network predictor constructors
+ void SetPCMprecision(double pcm){fPCMprecision = pcm;} //!< Set the precision on @f$\langle k \rangle@f$ prediction [pcm]. Neural network predictor constructors
+ double GetPCMprecision(){return fPCMprecision/1e5;} //!< Get the precision on @f$\langle k \rangle@f$ prediction []. Neural network predictor constructors
//@}
@@ -186,7 +174,7 @@ class EQM_FBR_MLP_Keff : public EquivalenceModel
int fNumberOfBatch; //!< The number of batches for the loading plan
double fKThreshold; //!< The @f$k_{Threshold}@f$
- double fPCMprecision; //!< precision on <k> prediction [pcm]
+ double fPCMprecision; //!< precision on @f$\langle k \rangle@f$ prediction [pcm]
double fTargetKeff; //!< Use for Varying Fissile content to reach fTargetKeff at time used in the MLP Training
diff --git a/source/branches/BaM_Dev/Model/Equivalence/EQM_FBR_MLP_Keff_BOUND.hxx b/source/branches/BaM_Dev/Model/Equivalence/EQM_FBR_MLP_Keff_BOUND.hxx
index 8c75199bd..b72a7f001 100644
--- a/source/branches/BaM_Dev/Model/Equivalence/EQM_FBR_MLP_Keff_BOUND.hxx
+++ b/source/branches/BaM_Dev/Model/Equivalence/EQM_FBR_MLP_Keff_BOUND.hxx
@@ -5,21 +5,16 @@
#include "TTree.h"
#include "TGraph.h"
-/*!
- \file
- \brief Header file for EQM_FBR_MLP_Keff_BOUND class.
-
-
- @author BLG
- @author BaM
- @version 1.0
- */
-
-
using namespace std;
+class EQM_FBR_MLP_Keff_BOUND;
+#ifndef __CINT__
+typedef void (EQM_FBR_MLP_Keff_BOUND::*FBR_MLP_Keff_BOUND_DMthPtr)( const string & ) ;
+#endif
+
//-----------------------------------------------------------------------------//
-//! Defines an EquivalenceModel based on neural network to predict @f$k_{eff}@f$
+//! Defines an EquivalenceModel based on neural network to predict @f$k_{\infty}@f$
+
/*!
The aim of these class is to constuct a fuel from an equivalence model
based on a Multi layer perceptron (MLP).
@@ -44,15 +39,9 @@ using namespace std;
*/
//________________________________________________________________________
-class EQM_FBR_MLP_Keff_BOUND;
-#ifndef __CINT__
-typedef void (EQM_FBR_MLP_Keff_BOUND::*FBR_MLP_Keff_BOUND_DMthPtr)( const string & ) ;
-#endif
-
-
class EQM_FBR_MLP_Keff_BOUND : public EquivalenceModel
{
- public :
+ public:
/*!
\name Constructor
*/
@@ -104,8 +93,8 @@ class EQM_FBR_MLP_Keff_BOUND : public EquivalenceModel
\name Get/Set methods
*/
//@{
- void SetPCMprecision(double pcm){fPCMprecision = pcm;} //!< Set the precision on <k> prediction [pcm]. Neural network predictor constructors
- double GetPCMprecision(){return fPCMprecision/1e5;} //!< Get the precision on <k> prediction []. Neural network predictor constructors
+ void SetPCMprecision(double pcm){fPCMprecision = pcm;} //!< Set the precision on @f$\langle k \rangle@f$ prediction [pcm]. Neural network predictor constructors
+ double GetPCMprecision(){return fPCMprecision/1e5;} //!< Get the precision on @f$\langle k \rangle@f$ prediction []. Neural network predictor constructors
//@}
@@ -185,7 +174,7 @@ class EQM_FBR_MLP_Keff_BOUND : public EquivalenceModel
int fNumberOfBatch; //!< The number of batches for the loading plan
double fKThreshold; //!< The @f$k_{Threshold}@f$
- double fPCMprecision; //!< precision on <k> prediction [pcm]
+ double fPCMprecision; //!< precision on @f$\langle k \rangle@f$ prediction [pcm]
double fKmin; //!< Lower edge of kedd Used by second constructor (fissile content prediction using keff at BOC (or other time)
double fKmax; //!< Upper edge of kedd Used by second constructor (fissile content prediction using keff at BOC (or other time)
double fTargetKeff; //!< Use for Varying Fissile content to reach fTargetKeff at time used in the MLP Training
diff --git a/source/branches/BaM_Dev/Model/Equivalence/EQM_MLP_Kinf.hxx b/source/branches/BaM_Dev/Model/Equivalence/EQM_MLP_Kinf.hxx
index 9710a6803..fd3ee1aea 100644
--- a/source/branches/BaM_Dev/Model/Equivalence/EQM_MLP_Kinf.hxx
+++ b/source/branches/BaM_Dev/Model/Equivalence/EQM_MLP_Kinf.hxx
@@ -5,31 +5,27 @@
#include "TTree.h"
#include <map>
-/*!
- \file
- \brief Header file for EQM_MLP_Kinf class.
-
-
- @author BLG
- @version 1.0
- */
-
-
using namespace std;
+class EQM_MLP_Kinf;
+#ifndef __CINT__
+typedef void (EQM_MLP_Kinf::*PWR_MLP_KINF_DMthPtr)( const string & ) ;
+#endif
+
//-----------------------------------------------------------------------------//
-//! Defines an EquivalenceModel based on neural network to predict @f$k_{\infty}@f$
+//! Defines an EquivalenceModel based on neural network to predict @f$k_{\infty}@f$.
+
/*!
The aim of these class is to constuct a fuel from an equivalence model
-based on a Multi layer perceptron (MLP).
+based on a Multi layer perceptron (MLP)
This MLP aims to predict the @f$k_{\infty}(t)@f$ of a PWR-MOX from a given fresh fuel
-composition.
+composition
With this MLP prediction and a given number of batch (for the loading plan) an
-average @f$<k_{\infty}>(t)@f$ is calculated according :
+average @f$\langle k_{\infty}\rangle (t)@f$ is calculated according :
-@f$<k_{\infty}>^{batch}(t) = \frac{1}{N}\sum_{i}^{N}k_{\infty}(t+\frac{iT}{N})@f$
+@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$<k_{\infty}>^{batch}(T/N) = <k_{\infty}>^{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.
@@ -38,15 +34,10 @@ in non simulated devices such as control rods and mixing grid.
*/
//________________________________________________________________________
-class EQM_MLP_Kinf;
-#ifndef __CINT__
-typedef void (EQM_MLP_Kinf::*PWR_MLP_KINF_DMthPtr)( const string & ) ;
-#endif
-
class EQM_MLP_Kinf : public EquivalenceModel
{
- public :
+ public:
/*!
\name Constructor
*/
@@ -123,10 +114,10 @@ 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 <k> prediction [pcm]. Neural network predictor constructors
+ 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 <k> prediction []. Neural network predictor constructors
+ 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);
//@}
@@ -202,7 +193,7 @@ class EQM_MLP_Kinf : public EquivalenceModel
double fMaximalBU; //!< The approx. maximum burnup reachable by the MLP model
double fMaximalContent; //!< The approx. maximum fissile content reachable by the MLP model
double fBurnUpPrecision; //!< precision on Burnup
- double fPCMprecision; //!< precision on <k> prediction [pcm]
+ double fPCMprecision; //!< precision on @f$\langle k \rangle@f$ prediction [pcm]
};
diff --git a/source/branches/BaM_Dev/Model/Equivalence/EQM_PWR_LIN_MOX.hxx b/source/branches/BaM_Dev/Model/Equivalence/EQM_PWR_LIN_MOX.hxx
index 3f09d0765..4946ad7d7 100644
--- a/source/branches/BaM_Dev/Model/Equivalence/EQM_PWR_LIN_MOX.hxx
+++ b/source/branches/BaM_Dev/Model/Equivalence/EQM_PWR_LIN_MOX.hxx
@@ -5,15 +5,6 @@
#include <string>
-/*!
- \file
- \brief Header file for EQM_PWR_LIN_MOX class.
-
-
- @author BaM
- @version 1.0
- */
-
using namespace std;
//-----------------------------------------------------------------------------//
diff --git a/source/branches/BaM_Dev/Model/Equivalence/EQM_PWR_MLP_MOX.hxx b/source/branches/BaM_Dev/Model/Equivalence/EQM_PWR_MLP_MOX.hxx
index 0512a47ca..1a9f4f818 100644
--- a/source/branches/BaM_Dev/Model/Equivalence/EQM_PWR_MLP_MOX.hxx
+++ b/source/branches/BaM_Dev/Model/Equivalence/EQM_PWR_MLP_MOX.hxx
@@ -4,16 +4,6 @@
#include "EquivalenceModel.hxx"
#include "TTree.h"
-/*!
- \file
- \brief Header file for EQM_PWR_MLP_MOX class.
-
-
- @author BLG
- @version 1.0
- */
-
-
using namespace std;
//-----------------------------------------------------------------------------//
@@ -28,7 +18,6 @@ using namespace std;
*/
//________________________________________________________________________
-
class EQM_PWR_MLP_MOX : public EquivalenceModel
{
public :
diff --git a/source/branches/BaM_Dev/Model/Equivalence/EQM_PWR_MLP_MOX_Am.hxx b/source/branches/BaM_Dev/Model/Equivalence/EQM_PWR_MLP_MOX_Am.hxx
index 0fe9d541c..1ec8a4e78 100755
--- a/source/branches/BaM_Dev/Model/Equivalence/EQM_PWR_MLP_MOX_Am.hxx
+++ b/source/branches/BaM_Dev/Model/Equivalence/EQM_PWR_MLP_MOX_Am.hxx
@@ -4,16 +4,6 @@
#include "EquivalenceModel.hxx"
#include "TTree.h"
-/*!
- \file
- \brief Header file for EQM_PWR_MLP_MOX_AM class.
-
-
- @author BLG
- @version 1.0
- */
-
-
using namespace std;
//-----------------------------------------------------------------------------//
@@ -28,7 +18,6 @@ using namespace std;
*/
//________________________________________________________________________
-
class EQM_PWR_MLP_MOX_AM : public EquivalenceModel
{
public :
diff --git a/source/branches/BaM_Dev/Model/Equivalence/EQM_PWR_POL_UO2.hxx b/source/branches/BaM_Dev/Model/Equivalence/EQM_PWR_POL_UO2.hxx
index 5c8b878e5..d6b855dd5 100644
--- a/source/branches/BaM_Dev/Model/Equivalence/EQM_PWR_POL_UO2.hxx
+++ b/source/branches/BaM_Dev/Model/Equivalence/EQM_PWR_POL_UO2.hxx
@@ -21,8 +21,6 @@ using namespace std;
*/
//________________________________________________________________________
-
-
class EQM_PWR_POL_UO2 : public EquivalenceModel
{
diff --git a/source/branches/BaM_Dev/Model/Equivalence/EQM_PWR_QUAD_MOX.hxx b/source/branches/BaM_Dev/Model/Equivalence/EQM_PWR_QUAD_MOX.hxx
index 7906fa90f..94bbe4c65 100644
--- a/source/branches/BaM_Dev/Model/Equivalence/EQM_PWR_QUAD_MOX.hxx
+++ b/source/branches/BaM_Dev/Model/Equivalence/EQM_PWR_QUAD_MOX.hxx
@@ -5,15 +5,6 @@
#include <string>
-/*!
- \file
- \brief Header file for EQM_PWR_QUAD_MOX class.
-
-
- @author BaM
- @version 1.0
- */
-
using namespace std;
//-----------------------------------------------------------------------------//
--
GitLab