src/ODE/ODESolvers/ODESolver/ODESolver.C

   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 \*---------------------------------------------------------------------------*/
  26
  27 #include "ODESolver.H"
  28
  29 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  30
  31 defineTypeNameAndDebug(Foam::ODESolver, 0);
  32 namespace Foam
  33 {
  34     defineRunTimeSelectionTable(ODESolver, ODE);
  35 };
  36
  37
  38 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  39
  40 Foam::ODESolver::ODESolver(const ODE& ode)
  41 :
  42     n_(ode.nEqns()),
  43     yScale_(n_),
  44     dydx_(n_)
  45 {}
  46
  47
  48 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  49
  50 void Foam::ODESolver::solve
  51 (
  52     const ODE& ode,
  53     const scalar xStart,
  54     const scalar xEnd,
  55     scalarField& y,
  56     const scalar eps,
  57     scalar& hEst
  58 ) const
  59 {
  60     const label MAXSTP = 10000;
  61
  62     scalar x = xStart;
  63     scalar h = hEst;
  64
  65     for (label nStep=0; nStep<MAXSTP; nStep++)
  66     {
  67         ode.derivatives(x, y, dydx_);
  68
  69         for (label i=0; i<n_; i++)
  70         {
  71             yScale_[i] = mag(y[i]) + mag(dydx_[i]*h) + SMALL;
  72         }
  73
  74         if ((x + h - xEnd)*(x + h - xStart) > 0.0)
  75         {
  76             h = xEnd - x;
  77         }
  78
  79         scalar hNext, hDid;
  80         solve(ode, x, y, dydx_, eps, yScale_, h, hDid, hNext);
  81
  82         if ((x - xEnd)*(xEnd - xStart) >= 0.0)
  83         {
  84             hEst = hNext;
  85             return;
  86         }
  87
  88         h = hNext;
  89     }
  90
  91     FatalErrorIn
  92     (
  93         "ODESolver::solve"
  94         "(const ODE& ode, const scalar xStart, const scalar xEnd,"
  95         "scalarField& yStart, const scalar eps, scalar& hEst) const"
  96     )   << "Too many integration steps"
  97         << exit(FatalError);
  98 }
  99
 100 // ************************************************************************* //