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-2023 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 // * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
37 
39 {
40  if
41  (
45  )
46  {
47  return false;
48  }
49 
51  (
52  "moveMeshOuterCorrectors",
53  false
54  );
55 
56  simpleRho_ =
58  (
59  {"simpleRho", "SIMPLErho"},
60  mesh().schemes().steady()
61  );
62 
64  dict().lookupOrDefault<bool>("transportPredictionFirst", true);
65 
68  (
69  {"transportCorrectionFinal", "turbOnFinalIterOnly"},
70  true
71  );
72 
73  return true;
74 }
75 
76 
77 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
78 
80 (
81  fvMesh& mesh,
82  const word& algorithmName
83 )
84 :
85  pisoControl(mesh, algorithmName),
87  (
88  static_cast<singleRegionSolutionControl&>(*this)
89  ),
91  (
92  static_cast<singleRegionSolutionControl&>(*this),
93  "outerCorrector"
94  ),
95  pimpleLoopPtr_(nullptr),
96  simpleRho_(false),
97  transportPredictionFirst_(true),
98  transportCorrectionFinal_(true)
99 {
100  read();
101 }
102 
103 
104 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
105 
107 {}
108 
109 
110 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
111 
113 {
114  return pisoControl::correct(finalIter());
115 }
116 
117 
119 {
120 
121  return pisoControl::correctNonOrthogonal(finalIter());
122 }
123 
124 
125 // ************************************************************************* //
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, if not found return the given default.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:99
const fvSchemes & schemes() const
Return the fvSchemes.
Definition: fvMesh.C:1751
bool steady() const
Return true if the default ddtScheme is steadyState.
Definition: fvSchemes.H:147
Pimple no-loop control class. Implements various option flags, but leaves loop controls to the deriva...
bool simpleRho_
Switch to indicate whether to update the density in SIMPLE mode.
virtual ~pimpleNoLoopControl()
Destructor.
bool transportCorrectionFinal_
Switch to control whether transport models are corrected.
bool transportPredictionFirst_
Switch to control whether transport models are predicted.
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.
bool moveMeshOuterCorrectors_
Switch to move the mesh at the start of every PIMPLE outer corrector.
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:79
bool correctNonOrthogonal(const bool finalIter=true)
Non-orthogonal corrector loop.
Definition: pisoControl.C:98
virtual bool read()
Read controls.
Definition: pisoControl.C:38
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.
virtual const dictionary & dict() const
Return the solution dictionary.
const fvMesh & mesh() const
Return the mesh.
A class for handling words, derived from string.
Definition: word.H:62
Namespace for OpenFOAM.
defineTypeNameAndDebug(combustionModel, 0)