ODESolverI.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) 2016 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 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
27 
28 
30 {
31  return n_;
32 }
33 
34 
36 {
37  return absTol_;
38 }
39 
40 
42 {
43  return relTol_;
44 }
45 
46 
47 template<class Type>
49 {
50  f.shallowCopy(UList<Type>(f.begin(), n));
51 }
52 
53 
54 template<class Type>
56 {
57  resizeField(f, n_);
58 }
59 
60 
62 {
63  m.shallowResize(n_);
64 }
65 
66 
67 // ************************************************************************* //
label nEqns() const
Return the number of equations to solve.
Definition: ODESolverI.H:29
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
scalarField & relTol()
Return access to the relative tolerance field.
Definition: ODESolverI.H:41
void shallowResize(const label m)
Resize the matrix without reallocating storage (unsafe)
void resizeMatrix(scalarSquareMatrix &m) const
Definition: ODESolverI.H:61
iterator begin()
Return an iterator to begin traversing the UList.
Definition: UListI.H:216
labelList f(nPoints)
void shallowCopy(const UList< T > &)
Copy the pointer held by the given UList.
Definition: UListI.H:156
scalarField relTol_
Relative convergence tolerance per step.
Definition: ODESolver.H:70
scalarField absTol_
Absolute convergence tolerance per step.
Definition: ODESolver.H:67
scalarField & absTol()
Return access to the absolute tolerance field.
Definition: ODESolverI.H:35
label n
static void resizeField(UList< Type > &f, const label n)
Definition: ODESolverI.H:48
label n_
Size of the ODESystem (adjustable)
Definition: ODESolver.H:64