setDeltaT.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) 2022-2023 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 "setDeltaT.H"
27 
28 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
29 
30 void Foam::setDeltaT(Time& runTime, const PtrList<solver>& solvers)
31 {
32  if
33  (
34  runTime.timeIndex() == 0
35  && runTime.controlDict().lookupOrDefault("adjustTimeStep", false)
36  )
37  {
38  bool transient = false;
39  scalar deltaT = vGreat;
40 
41  forAll(solvers, i)
42  {
43  if (solvers[i].transient())
44  {
45  transient = true;
46  deltaT = min(deltaT, solvers[i].maxDeltaT());
47  }
48  }
49 
50  if (transient)
51  {
52  deltaT = min(deltaT, runTime.functionObjects().maxDeltaT());
53  }
54 
55  if (transient && deltaT < rootVGreat)
56  {
57  runTime.setDeltaT(min(runTime.deltaTValue(), deltaT));
58  }
59  }
60 }
61 
62 
63 void Foam::adjustDeltaT(Time& runTime, const PtrList<solver>& solvers)
64 {
65  // Update the time-step limited by the solvers maxDeltaT
66  if (runTime.controlDict().lookupOrDefault("adjustTimeStep", false))
67  {
68  bool transient = false;
69  scalar deltaT = vGreat;
70 
71  forAll(solvers, i)
72  {
73  if (solvers[i].transient())
74  {
75  transient = true;
76  deltaT = min(deltaT, solvers[i].maxDeltaT());
77  }
78  }
79 
80  if (transient)
81  {
82  deltaT = min(deltaT, runTime.functionObjects().maxDeltaT());
83  }
84 
85  if (transient && deltaT < rootVGreat)
86  {
87  runTime.setDeltaT
88  (
89  min
90  (
91  solver::deltaTFactor*runTime.deltaTValue(),
92  deltaT
93  )
94  );
95  Info<< "deltaT = " << runTime.deltaTValue() << endl;
96  }
97  }
98 }
99 
100 
101 // ************************************************************************* //
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:434
scalar maxDeltaT
void adjustDeltaT(Time &runTime, const PtrList< solver > &solvers)
Adjust the time-step according to the solver maxDeltaT.
void setDeltaT(Time &runTime, const PtrList< solver > &solvers)
Set the initial time-step according to the solver maxDeltaT.
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:257
messageStream Info
layerAndWeight min(const layerAndWeight &a, const layerAndWeight &b)