Geant4  10.01.p01
G4Solver.hh
Go to the documentation of this file.
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 //
27 // $Id: G4Solver.hh 67983 2013-03-13 10:42:03Z gcosmo $
28 //
29 // Hadronic Process: Nuclear De-excitations
30 // by V. Lara
31 
32 #ifndef G4Solver_h
33 #define G4Solver_h 1
34 
35 #include "globals.hh"
36 
37 #include <cmath>
38 
39 #define DefaultTolerance 5.0e-14
40 
41 template <class Function> class G4Solver
42 {
43 public:
44  enum {DefaultMaxIter = 100};
45 
46  // default constructor
48  a(0.0), b(0.0), root(0.0) {};
49 
50  G4Solver(const G4int iterations, const G4double tol) :
51  MaxIter(iterations), tolerance(tol),
52  a(0.0), b(0.0), root(0.0) {};
53 
54  // copy constructor
55  G4Solver(const G4Solver & right);
56 
57  // destructor
58  ~G4Solver() {};
59 
60  // operators
61  G4Solver & operator=(const G4Solver & right);
62  G4bool operator==(const G4Solver & right) const;
63  G4bool operator!=(const G4Solver & right) const;
64 
65  G4int GetMaxIterations(void) const {return MaxIter;}
66  void SetMaxIterations(const G4int iterations) {MaxIter=iterations;}
67 
68  G4double GetTolerance(void) const {return tolerance;}
69  void SetTolerance(const G4double epsilon) {tolerance = epsilon;}
70 
71 
72  G4double GetIntervalLowerLimit(void) const {return a;}
73  G4double GetIntervalUpperLimit(void) const {return b;}
74 
75  void SetIntervalLimits(const G4double Limit1, const G4double Limit2);
76 
77  G4double GetRoot(void) const {return root;}
78 
79  // Calculates the root by the Bisection method
80  G4bool Bisection(Function & theFunction);
81 
82  // Calculates the root by the Regula-Falsi method
83  G4bool RegulaFalsi(Function & theFunction);
84 
85 
86  // Calculates the root by the Brent's method
87  G4bool Brent(Function & theFunction);
88 
89  // Calculates the root by the Inverse Parabolic Interpolation method
90  // due to Jack Crenshaw
91  G4bool Crenshaw(Function & theFunction);
92 
93 private:
94 
95  // Maximum number of iterations
97 
98  //
100 
101  // interval limits [a,b] which should bracket the root
104 
105  // The root
107 
108 };
109 
110 #include "G4Solver.icc"
111 
112 #endif
G4bool operator==(const G4Solver &right) const
Definition: G4Solver.cc:58
G4Solver()
Definition: G4Solver.hh:47
G4double GetIntervalLowerLimit(void) const
Definition: G4Solver.hh:72
G4bool operator!=(const G4Solver &right) const
Definition: G4Solver.cc:65
G4Solver(const G4int iterations, const G4double tol)
Definition: G4Solver.hh:50
G4double root
Definition: G4Solver.hh:106
G4double GetTolerance(void) const
Definition: G4Solver.hh:68
void SetIntervalLimits(const G4double Limit1, const G4double Limit2)
int G4int
Definition: G4Types.hh:78
G4bool Brent(Function &theFunction)
G4double a
Definition: G4Solver.hh:102
G4int GetMaxIterations(void) const
Definition: G4Solver.hh:65
#define DefaultTolerance
Definition: G4Solver.hh:39
G4double GetIntervalUpperLimit(void) const
Definition: G4Solver.hh:73
bool G4bool
Definition: G4Types.hh:79
void SetMaxIterations(const G4int iterations)
Definition: G4Solver.hh:66
G4bool Bisection(Function &theFunction)
G4int MaxIter
Definition: G4Solver.hh:96
G4double GetRoot(void) const
Definition: G4Solver.hh:77
G4bool RegulaFalsi(Function &theFunction)
G4double tolerance
Definition: G4Solver.hh:99
void SetTolerance(const G4double epsilon)
Definition: G4Solver.hh:69
G4double b
Definition: G4Solver.hh:103
~G4Solver()
Definition: G4Solver.hh:58
G4Solver & operator=(const G4Solver &right)
Definition: G4Solver.cc:47
G4bool Crenshaw(Function &theFunction)
double G4double
Definition: G4Types.hh:76