ODESystem.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
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::ODESystem
26 
27 Description
28  Abstract base class for the systems of ordinary differential equations.
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef ODESystem_H
33 #define ODESystem_H
34 
35 #include "scalarField.H"
36 #include "scalarMatrices.H"
37 
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
39 
40 namespace Foam
41 {
42 
43 /*---------------------------------------------------------------------------*\
44  Class ODESystem Declaration
45 \*---------------------------------------------------------------------------*/
46 
47 class ODESystem
48 {
49 
50 public:
51 
52  // Constructors
53 
54  //- Construct null
55  ODESystem()
56  {}
57 
58 
59  //- Destructor
60  virtual ~ODESystem()
61  {}
62 
63 
64  // Member Functions
65 
66  //- Return the number of equations in the system
67  virtual label nEqns() const = 0;
68 
69  //- Calculate the derivatives in dydx
70  virtual void derivatives
71  (
72  const scalar x,
73  const scalarField& y,
74  scalarField& dydx
75  ) const = 0;
76 
77  //- Calculate the Jacobian of the system
78  // Need by the stiff-system solvers
79  virtual void jacobian
80  (
81  const scalar x,
82  const scalarField& y,
83  scalarField& dfdx,
84  scalarSquareMatrix& dfdy
85  ) const = 0;
86 };
87 
88 
89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
90 
91 } // End namespace Foam
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 #endif
96 
97 // ************************************************************************* //
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
Abstract base class for the systems of ordinary differential equations.
Definition: ODESystem.H:46
virtual void jacobian(const scalar x, const scalarField &y, scalarField &dfdx, scalarSquareMatrix &dfdy) const =0
Calculate the Jacobian of the system.
scalar y
ODESystem()
Construct null.
Definition: ODESystem.H:54
virtual ~ODESystem()
Destructor.
Definition: ODESystem.H:59
virtual label nEqns() const =0
Return the number of equations in the system.
virtual void derivatives(const scalar x, const scalarField &y, scalarField &dydx) const =0
Calculate the derivatives in dydx.
Namespace for OpenFOAM.