setInitialDeltaT.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 Global
25  setInitialDeltaT
26 
27 Description
28  Set the initial timestep corresponding to the timestep adjustment
29  algorithm in setDeltaT but only if it would reduce the timestep.
30 
31 \*---------------------------------------------------------------------------*/
32 
33 if (adjustTimeStep)
34 {
35  if ((runTime.timeIndex() == 0) && (CoNum > small))
36  {
37  runTime.setDeltaT
38  (
39  min
40  (
41  maxCo*runTime.deltaTValue()/CoNum,
42  min(runTime.deltaTValue(), maxDeltaT)
43  )
44  );
45  }
46 }
47 
48 // ************************************************************************* //
engineTime & runTime
scalar CoNum
scalar maxCo
dimensioned< Type > min(const dimensioned< Type > &, const dimensioned< Type > &)
bool adjustTimeStep