pimpleNoLoopControl.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) 2018-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 \*---------------------------------------------------------------------------*/
25 
26 #include "pimpleNoLoopControl.H"
27 
28 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
29 
30 namespace Foam
31 {
33 }
34 
35 
36 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
37 
39 (
40  fvMesh& mesh,
41  const word& algorithmName
42 )
43 :
44  pisoControl(mesh, algorithmName),
46  (
47  static_cast<singleRegionSolutionControl&>(*this)
48  ),
50  (
51  static_cast<singleRegionSolutionControl&>(*this),
52  "outerCorrector"
53  ),
54  pimpleLoopPtr_(nullptr),
55  simpleRho_(false),
56  transportPredictionFirst_(true),
57  transportCorrectionFinal_(true)
58 {
59  read();
60 }
61 
62 
63 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
64 
66 {}
67 
68 
69 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
70 
72 {
73  if
74  (
76  || !readResidualControls()
77  || !readCorrResidualControls()
78  )
79  {
80  return false;
81  }
82 
83  moveMeshOuterCorrectors_ = dict().lookupOrDefault
84  (
85  "moveMeshOuterCorrectors",
86  false
87  );
88 
89  simpleRho_ =
91  (
92  {"simpleRho", "SIMPLErho"},
93  mesh().schemes().steady()
94  );
95 
96  transportPredictionFirst_ =
97  dict().lookupOrDefault<bool>("transportPredictionFirst", true);
98 
99  transportCorrectionFinal_ =
101  (
102  {"transportCorrectionFinal", "turbOnFinalIterOnly"},
103  true
104  );
105 
106  return true;
107 }
108 
109 
110 
112 {
113  return pisoControl::correct(finalIter());
114 }
115 
116 
118 {
119 
120  return pisoControl::correctNonOrthogonal(finalIter());
121 }
122 
123 
124 // ************************************************************************* //
T lookupOrDefaultBackwardsCompatible(const wordList &, const T &, bool recursive=false, bool patternMatch=true) const
Find and return a T, trying a list of keywords in sequence.
T lookupOrDefault(const word &, const T &, bool recursive=false, bool patternMatch=true) const
Find and return a T,.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:101
Pimple no-loop control class. Implements various option flags, but leaves loop controls to the deriva...
virtual ~pimpleNoLoopControl()
Destructor.
bool correct()
Piso loop within outer loop.
pimpleNoLoopControl(fvMesh &mesh, const word &algorithmName="PIMPLE")
Construct from a mesh, the name of the algorithm, and a reference.
bool correctNonOrthogonal()
Non-orthogonal corrector loop.
virtual bool read()
Read controls.
Piso control class. Provides time-loop and piso-loop control methods. No convergence checking is done...
Definition: pisoControl.H:55
bool correct(const bool finalIter=false)
Piso loop within outer loop.
Definition: pisoControl.C:77
bool correctNonOrthogonal(const bool finalIter=true)
Non-orthogonal corrector loop.
Definition: pisoControl.C:98
virtual bool read()
Read controls.
Definition: pisoControl.C:56
Single-region-specific derivation of the convergence control class.
Single-region-specific derivation of the corrector convergence control class.
Single-region-specific derivation of the solution control class.
A class for handling words, derived from string.
Definition: word.H:62
Namespace for OpenFOAM.
defineTypeNameAndDebug(combustionModel, 0)
dictionary dict