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