src/ODE/ODESolvers/RK/RK.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::RK
  26
  27 Description
  28     Fifth-order Cash-Karp embedded Runge-Kutta scheme with error control and
  29     adjustive time-step size
  30     Numerical Recipes in C, Secn 16.2 page 714-722
  31     Alternative reference in Numerical Recipes in C++
  32
  33 SourceFiles
  34     RK.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef RK_H
  39 #define RK_H
  40
  41 #include "ODESolver.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                                 Class RK Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class RK
  53 :
  54     public ODESolver
  55 {
  56     // Private data
  57
  58         mutable scalarField yTemp_;
  59         mutable scalarField ak2_;
  60         mutable scalarField ak3_;
  61         mutable scalarField ak4_;
  62         mutable scalarField ak5_;
  63         mutable scalarField ak6_;
  64
  65         mutable scalarField yErr_;
  66         mutable scalarField yTemp2_;
  67
  68         static const scalar safety, pGrow, pShrink, errCon;
  69
  70         static const scalar
  71             a2, a3, a4, a5, a6,
  72             b21, b31, b32, b41, b42, b43,
  73             b51, b52, b53, b54, b61, b62, b63, b64, b65,
  74             c1, c3, c4, c6,
  75             dc1, dc3, dc4, dc5, dc6;
  76
  77
  78     // Private Member Functions
  79
  80         void solve
  81         (
  82             const scalar x,
  83             const scalarField& y,
  84             const scalarField& dydx,
  85             const scalar h,
  86             scalarField& yout,
  87             scalarField& yerr
  88         ) const;
  89
  90
  91 public:
  92
  93     //- Runtime type information
  94     TypeName("RK");
  95
  96
  97     // Constructors
  98
  99         //- Construct from ODE
 100         RK(ODE& ode);
 101
 102
 103     // Destructor
 104
 105         virtual ~RK()
 106         {}
 107
 108
 109     // Member Functions
 110
 111         virtual void solve
 112         (
 113             scalar& x,
 114             scalarField& y,
 115             scalarField& dydx,
 116             const scalar eps,
 117             const scalarField& yScale,
 118             const scalar hTry,
 119             scalar& hDid,
 120             scalar& hNext
 121         ) const;
 122 };
 123
 124
 125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 126
 127 } // End namespace Foam
 128
 129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 130
 131 #endif
 132
 133 // ************************************************************************* //