Euler.C
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) 2013-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 \*---------------------------------------------------------------------------*/
25 
26 #include "Euler.H"
28 
29 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
30 
31 namespace Foam
32 {
33  defineTypeNameAndDebug(Euler, 0);
34  addToRunTimeSelectionTable(ODESolver, Euler, dictionary);
35 }
36 
37 
38 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
39 
41 :
42  ODESolver(ode, dict),
43  adaptiveSolver(ode, dict),
44  err_(n_)
45 {}
46 
47 
48 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
49 
51 {
52  if (ODESolver::resize())
53  {
55 
56  resizeField(err_);
57 
58  return true;
59  }
60  else
61  {
62  return false;
63  }
64 }
65 
66 
67 Foam::scalar Foam::Euler::solve
68 (
69  const scalar x0,
70  const scalarField& y0,
71  const scalarField& dydx0,
72  const scalar dx,
73  scalarField& y
74 ) const
75 {
76  // Calculate error estimate from the change in state:
77  forAll(err_, i)
78  {
79  err_[i] = dx*dydx0[i];
80  }
81 
82  // Update the state
83  forAll(y, i)
84  {
85  y[i] = y0[i] + err_[i];
86  }
87 
88  return normalizeError(y0, y, err_);
89 }
90 
91 
93 (
94  scalar& x,
95  scalarField& y,
96  scalar& dxTry
97 ) const
98 {
99  adaptiveSolver::solve(odes_, x, y, dxTry);
100 }
101 
102 
103 // ************************************************************************* //
virtual scalar solve(const scalar x0, const scalarField &y0, const scalarField &dydx0, const scalar dx, scalarField &y) const =0
Solve a single step dx and return the error.
dictionary dict
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:428
Abstract base class for the systems of ordinary differential equations.
Definition: ODESystem.H:46
Euler(const ODESystem &ode, const dictionary &dict)
Construct from ODESystem.
Definition: Euler.C:40
virtual bool resize()=0
Resize the ODE solver.
Definition: ODESolver.C:89
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
An ODE solver for chemistry.
Definition: ode.H:50
virtual scalar solve(const scalar x0, const scalarField &y0, const scalarField &dydx0, const scalar dx, scalarField &y) const
Solve a single step dx and return the error.
Definition: Euler.C:68
Macros for easy insertion into run-time selection tables.
bool resize(const label n)
Resize the ODE solver.
const ODESystem & odes_
Reference to ODESystem.
Definition: ODESolver.H:58
addToRunTimeSelectionTable(ensightPart, ensightPartCells, istream)
defineTypeNameAndDebug(combustionModel, 0)
scalar normalizeError(const scalarField &y0, const scalarField &y, const scalarField &err) const
Return the nomalized scalar error.
Definition: ODESolver.C:40
Abstract base-class for ODE system solvers.
Definition: ODESolver.H:50
virtual bool resize()
Resize the ODE solver.
Definition: Euler.C:50
static void resizeField(UList< Type > &f, const label n)
Definition: ODESolverI.H:48
label n_
Size of the ODESystem (adjustable)
Definition: ODESolver.H:64
Namespace for OpenFOAM.