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