setDeltaT.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) 2022 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  Foam::setDeltaT
26 
27 Description
28  Foam::setDeltaT sets the initial time-step according to the solver maxDeltaT
29  Foam::adjustDeltaT adjust the time-step according to the solver maxDeltaT
30 
31 SourceFiles
32  setDeltaT.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef setDeltaT_H
37 #define setDeltaT_H
38 
39 #include "solver.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 //- Set the initial time-step according to the solver maxDeltaT
49 void setDeltaT(Time& runTime, const solver& solver);
50 
51 //- Adjust the time-step according to the solver maxDeltaT
52 void adjustDeltaT(Time& runTime, const solver& solver);
53 
54 
55 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
56 
57 } // End namespace Foam
58 
59 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
60 
61 #endif
62 
63 // ************************************************************************* //
Foam::Time
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:76
Foam::solver
Abstract base class for run-time selectable region solvers.
Definition: solver.H:56
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.H:214
Foam::adjustDeltaT
void adjustDeltaT(Time &runTime, const PtrList< solver > &solvers)
Adjust the time-step according to the solver maxDeltaT.
Foam::setDeltaT
void setDeltaT(Time &runTime, const PtrList< solver > &solvers)
Set the initial time-step according to the solver maxDeltaT.