src/ODE/ODESolvers/RK/RK.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::RK
  26
  27 Description
  28     Runge-Kutta ODE solver
  29
  30 SourceFiles
  31     RKCK.C
  32     RKQS.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef RK_H
  37 #define RK_H
  38
  39 #include "ODESolver.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                            Class RK Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class RK
  51 :
  52     public ODESolver
  53 {
  54     // Private data
  55         static const scalar safety, pGrow, pShrink, errCon;
  56
  57         static const scalar
  58             a2, a3, a4, a5, a6,
  59             b21, b31, b32, b41, b42, b43,
  60             b51, b52, b53, b54, b61, b62, b63, b64, b65,
  61             c1, c3, c4, c6,
  62             dc1, dc3, dc4, dc5, dc6;
  63
  64
  65         mutable scalarField yTemp_;
  66         mutable scalarField ak2_;
  67         mutable scalarField ak3_;
  68         mutable scalarField ak4_;
  69         mutable scalarField ak5_;
  70         mutable scalarField ak6_;
  71
  72         mutable scalarField yErr_;
  73         mutable scalarField yTemp2_;
  74
  75 public:
  76
  77     //- Runtime type information
  78     TypeName("RK");
  79
  80
  81     // Constructors
  82
  83         //- Construct from ODE
  84         RK(const ODE& ode);
  85
  86
  87     // Member Functions
  88
  89         void solve
  90         (
  91             const ODE& ode,
  92             const scalar x,
  93             const scalarField& y,
  94             const scalarField& dydx,
  95             const scalar h,
  96             scalarField& yout,
  97             scalarField& yerr
  98         ) const;
  99
 100
 101         void solve
 102         (
 103             const ODE& ode,
 104             scalar& x,
 105             scalarField& y,
 106             scalarField& dydx,
 107             const scalar eps,
 108             const scalarField& yScale,
 109             const scalar hTry,
 110             scalar& hDid,
 111             scalar& hNext
 112         ) const;
 113 };
 114
 115
 116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 117
 118 } // End namespace Foam
 119
 120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 121
 122 #endif
 123
 124 // ************************************************************************* //