src/ODE/ODE/ODE.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::ODE
  27
  28 Description
  29     Abstract base class for the ODE solvers.
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef ODE_H
  34 #define ODE_H
  35
  36 #include "scalarField.H"
  37 #include "scalarMatrices.H"
  38
  39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  40
  41 namespace Foam
  42 {
  43
  44 /*---------------------------------------------------------------------------*\
  45                            Class ODE Declaration
  46 \*---------------------------------------------------------------------------*/
  47
  48 class ODE
  49 {
  50
  51 public:
  52
  53     // Constructors
  54
  55         //- Construct null
  56         ODE()
  57         {}
  58
  59
  60     // Destructor
  61
  62         virtual ~ODE()
  63         {}
  64
  65
  66     // Member Functions
  67
  68         virtual label nEqns() const = 0;
  69
  70         virtual void derivatives
  71         (
  72             const scalar x,
  73             const scalarField& y,
  74             scalarField& dydx
  75         ) const = 0;
  76
  77
  78         virtual void jacobian
  79         (
  80             const scalar x,
  81             const scalarField& y,
  82             scalarField& dfdx,
  83             scalarSquareMatrix& dfdy
  84         ) const = 0;
  85 };
  86
  87
  88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  89
  90 } // End namespace Foam
  91
  92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  93
  94 #endif
  95
  96 // ************************************************************************* //