FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

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-2010 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
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your 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, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::ODE
00026 
00027 Description
00028     Abstract base class for the ODE solvers.
00029 
00030 \*---------------------------------------------------------------------------*/
00031 
00032 #ifndef ODE_H
00033 #define ODE_H
00034 
00035 #include <OpenFOAM/scalarField.H>
00036 #include <OpenFOAM/scalarMatrices.H>
00037 
00038 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00039 
00040 namespace Foam
00041 {
00042 
00043 /*---------------------------------------------------------------------------*\
00044                            Class ODE Declaration
00045 \*---------------------------------------------------------------------------*/
00046 
00047 class ODE
00048 {
00049 
00050 public:
00051 
00052     // Constructors
00053 
00054         //- Construct null
00055         ODE()
00056         {}
00057 
00058 
00059     // Destructor
00060 
00061         virtual ~ODE()
00062         {}
00063 
00064 
00065     // Member Functions
00066 
00067         virtual label nEqns() const = 0;
00068 
00069         virtual void derivatives
00070         (
00071             const scalar x,
00072             const scalarField& y,
00073             scalarField& dydx
00074         ) const = 0;
00075 
00076 
00077         virtual void jacobian
00078         (
00079             const scalar x,
00080             const scalarField& y,
00081             scalarField& dfdx,
00082             scalarSquareMatrix& dfdy
00083         ) const = 0;
00084 };
00085 
00086 
00087 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00088 
00089 } // End namespace Foam
00090 
00091 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00092 
00093 #endif
00094 
00095 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines