pimpleLoopI.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) 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 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
27 
29 {
30  return nCorrPimple_;
31 }
32 
33 
35 {
36  return corrPimple_ == 1;
37 }
38 
39 
41 {
42  return corrPimple_ >= nCorrPimple_;
43 }
44 
45 
46 inline bool Foam::pimpleLoop::firstIter() const
47 {
48  return firstPimpleIter();
49 }
50 
51 
52 inline bool Foam::pimpleLoop::finalIter() const
53 {
54  return converged_ || finalPimpleIter();
55 }
56 
57 
58 // ************************************************************************* //
label nCorrPimple() const
Maximum number of pimple correctors.
Definition: pimpleLoopI.H:28
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
bool firstIter() const
Flag to indicate the first iteration.
Definition: pimpleLoopI.H:46
label corrPimple_
Current pimple corrector.
Definition: pimpleLoop.H:64
bool finalPimpleIter() const
Flag to indicate the last pimple iteration.
Definition: pimpleLoopI.H:40
bool firstPimpleIter() const
Flag to indicate the first pimple iteration.
Definition: pimpleLoopI.H:34
label nCorrPimple_
Maximum number of pimple correctors.
Definition: pimpleLoop.H:61
bool finalIter() const
Flag to indicate the last iteration.
Definition: pimpleLoopI.H:52
bool converged_
Flag to indicate convergence of the pimple loop.
Definition: pimpleLoop.H:67