src/ODE/ODESolvers/ODESolver/ODESolver.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::ODESolver
  27
  28 Description
  29     Selection for ODE solver
  30
  31 SourceFiles
  32     ODESolver.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef ODESolver_H
  37 #define ODESolver_H
  38
  39 #include <ODE/ODE.H>
  40 #include <OpenFOAM/typeInfo.H>
  41 #include <OpenFOAM/autoPtr.H>
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                          Class ODESolver Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class ODESolver
  53 {
  54
  55 protected:
  56
  57     // Private data
  58
  59         label n_;
  60         mutable scalarField yScale_;
  61         mutable scalarField dydx_;
  62
  63
  64     // Private Member Functions
  65
  66         //- Disallow default bitwise copy construct
  67         ODESolver(const ODESolver&);
  68
  69         //- Disallow default bitwise assignment
  70         void operator=(const ODESolver&);
  71
  72
  73 public:
  74
  75     //- Runtime type information
  76     TypeName("ODESolver");
  77
  78
  79     // Declare run-time constructor selection table
  80
  81         declareRunTimeSelectionTable
  82         (
  83             autoPtr,
  84             ODESolver,
  85             ODE,
  86             (const ODE& ode),
  87             (ode)
  88         );
  89
  90
  91     // Constructors
  92
  93         //- Construct for given ODE
  94         ODESolver(const ODE& ode);
  95
  96
  97     // Selectors
  98
  99         //- Select null constructed
 100         static autoPtr<ODESolver> New
 101         (
 102             const word& ODESolverTypeName,
 103             const ODE& ode
 104         );
 105
 106
 107     // Destructor
 108
 109         virtual ~ODESolver()
 110         {}
 111
 112
 113     // Member Functions
 114
 115         virtual void solve
 116         (
 117             const ODE& ode,
 118             scalar& x,
 119             scalarField& y,
 120             scalarField& dydx,
 121             const scalar eps,
 122             const scalarField& yScale,
 123             const scalar hTry,
 124             scalar& hDid,
 125             scalar& hNext
 126         ) const = 0;
 127
 128
 129         virtual void solve
 130         (
 131             const ODE& ode,
 132             const scalar xStart,
 133             const scalar xEnd,
 134             scalarField& y,
 135             const scalar eps,
 136             scalar& hEst
 137         ) const;
 138 };
 139
 140
 141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 142
 143 } // End namespace Foam
 144
 145 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 146
 147 #endif
 148
 149 // ************************ vim: set sw=4 sts=4 et: ************************ //