| Geant4 Cross Reference |
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 // INCL++ intra-nuclear cascade model
27 // Alain Boudard, CEA-Saclay, France
28 // Joseph Cugnon, University of Liege, Belgium
29 // Jean-Christophe David, CEA-Saclay, France
30 // Pekka Kaitaniemi, CEA-Saclay, France, and Helsinki Institute of Physics, Finland
31 // Sylvie Leray, CEA-Saclay, France
32 // Davide Mancusi, CEA-Saclay, France
33 //
34 #define INCLXX_IN_GEANT4_MODE 1
35
36 #include "globals.hh"
37
38 /** \file G4INCLIFunction1D.hh
39 * \brief Functor for 1-dimensional mathematical functions
40 *
41 * \date 16 July 2012
42 * \author Davide Mancusi
43 */
44
45 #ifndef G4INCLIFUNCTION1D_HH_
46 #define G4INCLIFUNCTION1D_HH_ 1
47
48 #include <vector>
49
50 namespace G4INCL {
51
52 // Forward declaration
53 class InterpolationTable;
54
55 /**
56 * 1D function interface
57 */
58 class IFunction1D {
59 public:
60 IFunction1D() :
61 xMin(0.),
62 xMax(0.)
63 {};
64 IFunction1D(const G4double x0, const G4double x1) :
65 xMin(x0),
66 xMax(x1)
67 {};
68
69 virtual ~IFunction1D() {};
70
71 /// \brief Return the minimum allowed value of the independent variable
72 virtual inline G4double getXMinimum() const { return xMin; }
73
74 /// \brief Return the maximum allowed value of the independent variable
75 virtual inline G4double getXMaximum() const { return xMax; }
76
77 /// \brief Compute the value of the function
78 virtual G4double operator()(const G4double x) const = 0;
79
80 /** \brief Integrate the function between two values
81 *
82 * \param x0 lower integration bound
83 * \param x1 upper integration bound
84 * \param step largest integration step size; if <0, 45 steps will be used
85 * \return \f$\int_{x_0}^{x_1} f(x) dx\f$
86 */
87 virtual G4double integrate(const G4double x0, const G4double x1, const G4double step=-1.) const;
88
89 /// \brief Return a pointer to the (numerical) primitive to this function
90 IFunction1D *primitive() const;
91
92 /// \brief Typedef to simplify the syntax of inverseCDFTable
93 typedef G4double (* const ManipulatorFunc)(const G4double);
94
95 /** \brief Return a pointer to the inverse of the CDF of this function
96 *
97 * The function parameter fWrap is wrapped around the return value of
98 * operator(). If fWrap=NULL (default), fWrap=identity.
99 */
100 InterpolationTable *inverseCDFTable(ManipulatorFunc fWrap=0, const G4int nNodes=60) const;
101
102 protected:
103 /// \brief Minimum value of the independent variable
104 G4double xMin;
105 /// \brief Maximum value of the independent variable
106 G4double xMax;
107
108 private:
109 /// \brief Coefficients for numerical integration
110 static const G4double integrationCoefficients[];
111 };
112
113 }
114
115 #endif // G4INCLIFUNCTION1D_HH_
116