FreeFOAM The Cross-Platform CFD Toolkit
ODE.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 1991-2010 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
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::ODE
26 
27 Description
28  Abstract base class for the ODE solvers.
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef ODE_H
33 #define ODE_H
34 
35 #include <OpenFOAM/scalarField.H>
37 
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
39 
40 namespace Foam
41 {
42 
43 /*---------------------------------------------------------------------------*\
44  Class ODE Declaration
45 \*---------------------------------------------------------------------------*/
46 
47 class ODE
48 {
49 
50 public:
51 
52  // Constructors
53 
54  //- Construct null
55  ODE()
56  {}
57 
58 
59  // Destructor
60 
61  virtual ~ODE()
62  {}
63 
64 
65  // Member Functions
66 
67  virtual label nEqns() const = 0;
68 
69  virtual void derivatives
70  (
71  const scalar x,
72  const scalarField& y,
73  scalarField& dydx
74  ) const = 0;
75 
76 
77  virtual void jacobian
78  (
79  const scalar x,
80  const scalarField& y,
81  scalarField& dfdx,
82  scalarSquareMatrix& dfdy
83  ) const = 0;
84 };
85 
86 
87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
88 
89 } // End namespace Foam
90 
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 
93 #endif
94 
95 // ************************ vim: set sw=4 sts=4 et: ************************ //