pisoControlI.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-2019 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 nCorrPiso_;
31 }
32 
33 
34 inline bool Foam::pisoControl::anyPisoIter() const
35 {
36  return corrPiso_ != 0;
37 }
38 
39 
41 {
42  return corrPiso_ == 1;
43 }
44 
45 
47 {
48  return corrPiso_ >= nCorrPiso_;
49 }
50 
51 
53 {
55 }
56 
57 
58 // ************************************************************************* //
bool finalNonOrthogonalIter() const
Flag to indicate the last non-orthogonal iteration.
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
label nCorrPiso() const
Maximum number of piso correctors.
Definition: pisoControlI.H:28
bool anyPisoIter() const
Flag to indicate any piso iteration.
Definition: pisoControlI.H:34
bool finalInnerIter() const
Flag to indicate the last inner iteration (last piso and last.
Definition: pisoControlI.H:52
bool finalPisoIter() const
Flag to indicate the last piso iteration.
Definition: pisoControlI.H:46
label corrPiso_
Current piso corrector.
Definition: pisoControl.H:64
bool firstPisoIter() const
Flag to indicate the first piso iteration.
Definition: pisoControlI.H:40
label nCorrPiso_
Maximum number of piso correctors.
Definition: pisoControl.H:61