include/Geant4/G4AdjointInterpolator.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 ////////////////////////////////////////////////////////////////////////////////
0027 //  Class:    G4AdjointInterpolator
0028 //  Author:         L. Desorgher
0029 //  Organisation:   SpaceIT GmbH
0030 //
0031 //  Used by  G4AdjointCSManager for interpolation purpose.
0032 ////////////////////////////////////////////////////////////////////////////////
0033
0034 #ifndef G4AdjointInterpolator_h
0035 #define G4AdjointInterpolator_h 1
0036
0037 #include "globals.hh"
0038
0039 #include <vector>
0040
0041 class G4AdjointInterpolator
0042 {
0043  public:
0044   static G4AdjointInterpolator* GetAdjointInterpolator();
0045   static G4AdjointInterpolator* GetInstance();
0046
0047   ~G4AdjointInterpolator();
0048
0049   // Caution: everywhere it is considered that x_vec increases monotically
0050
0051   G4double LinearInterpolation(G4double& x, G4double& x1, G4double& x2,
0052                                G4double& y1, G4double& y2);
0053
0054   G4double LogarithmicInterpolation(G4double& x, G4double& x1, G4double& x2,
0055                                     G4double& y1, G4double& y2);
0056
0057   G4double ExponentialInterpolation(G4double& x, G4double& x1, G4double& x2,
0058                                     G4double& y1, G4double& y2);
0059
0060   G4double Interpolation(G4double& x, G4double& x1, G4double& x2, G4double& y1,
0061                          G4double& y2, G4String InterPolMethod = "Log");
0062
0063   size_t FindPosition(G4double& x, std::vector<G4double>& x_vec,
0064                       size_t ind_min = 0, size_t ind_max = 0);
0065
0066   size_t FindPositionForLogVector(G4double& x, std::vector<G4double>& x_vec);
0067
0068   // xvec should monotically increase
0069   G4double Interpolate(G4double& x, std::vector<G4double>& x_vec,
0070                        std::vector<G4double>& y_vec,
0071                        G4String InterPolMethod = "Log");
0072
0073   G4double InterpolateWithIndexVector(
0074     G4double& x, std::vector<G4double>& x_vec, std::vector<G4double>& y_vec,
0075     std::vector<size_t>& index_vec, G4double x0,
0076     G4double dx);  // xvec should monotically increase
0077
0078   G4double InterpolateForLogVector(G4double& x, std::vector<G4double>& x_vec,
0079                                    std::vector<G4double>& y_vec);
0080
0081   G4AdjointInterpolator(G4AdjointInterpolator&) = delete;
0082   G4AdjointInterpolator& operator=(const G4AdjointInterpolator& right) = delete;
0083
0084  private:
0085   G4AdjointInterpolator();
0086
0087   static G4ThreadLocal G4AdjointInterpolator* fInstance;
0088 };
0089 #endif