src/ODE/findRoot/BisectionRoot/BisectionRoot.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software; you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     BisectionRoot
  27
  28 Description
  29     Bisection root Based on Numerical Recipes in C++, Section 9.1, page 358.
  30     Function is provided as a template parameter function object, evaluated
  31     using operator()(const scalar x)
  32
  33 Author
  34     Hrvoje Jasak, Wikki Ltd.  All rights reserved.
  35
  36 SourceFiles
  37     BisectionRoot.C
  38
  39 \*---------------------------------------------------------------------------*/
  40
  41 #ifndef BisectionRoot_H
  42 #define BisectionRoot_H
  43
  44 #include "scalar.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 /*---------------------------------------------------------------------------*\
  52                            Class BisectionRoot Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 template<class Func>
  56 class BisectionRoot
  57 {
  58 private:
  59
  60     // Private data
  61
  62         //- Reference to a function
  63         const Func& f_;
  64
  65         //- Required accuracy
  66         const scalar eps_;
  67
  68
  69 public:
  70
  71     // Static data members
  72
  73         //- Maximum number of iterations
  74         static const label maxIter;
  75
  76
  77     // Constructors
  78
  79         //- Construct given a function
  80         BisectionRoot(const Func& f, const scalar eps);
  81
  82
  83     // Destructor - default
  84
  85
  86     // Member Functions
  87
  88         //- Return root
  89         scalar root(const scalar x0, const scalar x1) const;
  90 };
  91
  92
  93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  94
  95 } // End namespace Foam
  96
  97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  98
  99 #ifdef NoRepository
 100 #   include "BisectionRoot.C"
 101 #endif
 102
 103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 104
 105 #endif
 106
 107 // ************************************************************************* //