TSobol.h

Go to the documentation of this file.

// Copyright (C) 2013-2024 CEA/DES
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published
// by the Free Software Foundation, either version 3 of the License, or any
// later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
// $Id$
// $Author$
// $Date$
// $Revision$
// $State$

#ifndef TSobol_H
#define TSobol_H
#include "TString.h"
#ifndef ROOT_TMethodCall
#include "TMethodCall.h"
#endif
#ifndef ROOT_TNtupleD
#include "TNtupleD.h"
#endif

// Uranie
#include "TStochAttribut.h"
#include "TSensitivity.h"
#include "TSampling.h"
#include "TQMC.h"

using std::cout;
using std::endl;

namespace URANIE {
namespace Sensitivity {
class TSobol: public TSensitivity {

public:
    enum ESamplerMethod
    {
        kSRS, kLHS, kqMCSobol, kqMCHalton
    };    
    enum EMatrixMiNi
    {
        kMiNiSobol, kMiNiSaltelli
    };              
    enum ESiAlgorithm
    {
      kSiSobol93=0, kSiSaltelli02, kSiJansen99, kSiSumo10, kSiMartinez11, kSiOnlyNi=26, kSiAll=31
    };            
    enum EStiAlgorithm
    {
        kStiHomma96=0,
        kStiSobol07,
        kStiJansen99,
        kStiSumo10,
        kStiMartinez11,
  kStiOnlyNi=25,
        kStiAll=31
    };     

    // Operations
private:

protected:
    //---------------------------------------------
    void initSample(Int_t ns, Option_t * option = "");

    void prepareSizePerIndex(Option_t * option= "");
    //---------------------------------------------

    virtual void parseOption(Option_t *option = "");

    //---------------------------------------------
    void preTreatment();

public:
    //---------------------------------------------
    TSobol();
    /*
     \param tds (URANIE::DataServer::TDataServer *) the dataserver
     \param fcn (void *) The function to analyze
     \param ns (Int_t) The size (total) of the sampling
     \param varexpinput(const char*)[""] The list of input attributes to pass to the function separated by the caracter ":"
     \param varexpoutput (const char *)[""]  The list of output attributes separated by the caracter ":"
     \param
     */
#ifdef ROOT5
    TSobol(URANIE::DataServer::TDataServer *tds, void *fcn, Int_t ns,
            const char *varexpinput = "", const char *varexpoutput = "",
            Option_t * option = "");
#else
    TSobol(URANIE::DataServer::TDataServer *tds, void (*fcn)(Double_t*,Double_t*),
            const char *varexpinput, const char *varexpoutput,
            Int_t ns, Option_t * option = "");
#endif
    /*
     \param tds (URANIE::DataServer::TDataServer *) the dataserver
     \param fcn (const char*) The function to analyze
     \param ns (Int_t) The size (total) of the sampling
     \param varexpinput(const char*)[""] The list of input attributes to pass to the function separated by the caracter ":"
     \param varexpoutput (const char *)[""]  The list of output attributes separated by the caracter ":"
     \param
     */
    TSobol(URANIE::DataServer::TDataServer *tds, const char *fcn,
     Int_t ns, const char *varexpinput, const char *varexpoutput,
     Option_t* option="");
    TSobol(URANIE::DataServer::TDataServer *tds, const char *varexpinput,
            const char *varexpoutput, Option_t * option = "");

    TSobol(URANIE::DataServer::TDataServer *tds, URANIE::Launcher::TCode *fcode,
            Int_t ns, Option_t * option = "");
    TSobol(URANIE::DataServer::TDataServer *tds, URANIE::Relauncher::TRun *run,
            Int_t ns, Option_t * option = "");
    virtual ~TSobol();

    //---------------------------------------------
    void initForRun(Option_t *option);

    
    //---------------------------------------------
    void createTuple(Option_t *option = "");

    //---------------------------------------------
    /*
     \li from a TDS empty of data . Run the method \ref initSample
     \li from a TDS with data. First Half of the data is M and the other is N

     After mix the data to create the \f$ M_{i}\f$ and \f$ N_{i}\f$ matrix
     */
    virtual void generateSample(Option_t * option = "");

    void loadOtherSobolFile(const char *filename);

    //---------------------------------------------
    /*
     The TDS must contain an attribute Name + "n__iter__sobol" with values
     \li            -1 : for the M matrix
     \li             0 : for the N matrix
     \li          ix+1 : for the matrix Mi
     \li 100*_nX+ ix+1 : for the matrix Ni
     */
    void evaluateIndexes(Option_t * option = "");

    //---------------------------------------------
    virtual void printLog();

    ClassDef(URANIE::Sensitivity::TSobol, ID_SENSITIVITY)

    //---------------------------------------------
    Bool_t _bSM;          
    Bool_t _bWithSample;    
    Bool_t _bWithData;    
    Bool_t _bCVM; 

    ESamplerMethod _nSamplerMethod; 
    EMatrixMiNi _nMatrixMiNi; 

    ESiAlgorithm _nSiAlgorithm; 
    EStiAlgorithm _nStiAlgorithm; 

    //---------------------------------------------
    Int_t _nSimPerIndex;     
    Int_t _nMethodComputed; 
    TMatrixD _matM;             
    TMatrixD _matN;             

    TEventList *_telm, *_teln;  
    TMatrixD _valN, _valM;  
    TMatrixD _valSi, _valSti;  
    TMatrixD _valMeanMN, _valSigmaMN; 
    vector<double> _valMeanYN, _valMeanYM, _valVarYN, _valVarYM;
    URANIE::DataServer::TDSNtupleD *_withdatantp;
    URANIE::DataServer::TDSNtupleD *_preloadedntp;
    int *_useless;

};

} // End Of namespace Sensitivity
} // End Of namespace URANIE
#endif