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