OpenFOAM logo
Open Source CFD Toolkit

ODE.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2005 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software; you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM; if not, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     ODE
00027 
00028 Description
00029     Abstract base class for the ODE solvers.
00030 
00031 \*---------------------------------------------------------------------------*/
00032 
00033 #ifndef ODE_H
00034 #define ODE_H
00035 
00036 #include "scalarField.H"
00037 #include "Matrix.H"
00038 
00039 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00040 
00041 namespace Foam
00042 {
00043 
00044 /*---------------------------------------------------------------------------*\
00045                            Class ODE Declaration
00046 \*---------------------------------------------------------------------------*/
00047 
00048 class ODE
00049 {
00050 
00051 public:
00052 
00053     // Constructors
00054 
00055         //- Construct null
00056         ODE()
00057         {}
00058 
00059 
00060     // Destructor
00061 
00062         virtual ~ODE()
00063         {}
00064 
00065 
00066     // Member Functions
00067 
00068         virtual label nEqns() const = 0;
00069 
00070         virtual void derivatives
00071         (
00072             const scalar x,
00073             const scalarField& y,
00074             scalarField& dydx
00075         ) const = 0;
00076 
00077 
00078         virtual void jacobian
00079         (
00080             const scalar x,
00081             const scalarField& y,
00082             scalarField& dfdx,
00083             Matrix<scalar>& dfdy
00084         ) const = 0;
00085 };
00086 
00087 
00088 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00089 
00090 } // End namespace Foam
00091 
00092 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00093 
00094 #endif
00095 
00096 // ************************************************************************* //
For further information go to www.openfoam.org