All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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-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 #include "pimpleNoLoopControl.H"
27 
28 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
29 
30 namespace Foam
31 {
32  defineTypeNameAndDebug(pimpleNoLoopControl, 0);
33 }
34 
35 
36 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
37 
39 (
40  fvMesh& mesh,
41  const word& algorithmName,
42  const pimpleLoop& loop
43 )
44 :
45  pisoControl(mesh, algorithmName),
47  (
48  static_cast<singleRegionSolutionControl&>(*this)
49  ),
51  (
52  static_cast<singleRegionSolutionControl&>(*this),
53  "outerCorrector"
54  ),
55  loop_(loop),
56  simpleRho_(false),
57  turbOnFinalIterOnly_(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  // The SIMPLErho keyword is maintained here for backwards compatibility
84  simpleRho_ = mesh().steady();
85  simpleRho_ = dict().lookupOrDefault<bool>("SIMPLErho", simpleRho_);
86  simpleRho_ = dict().lookupOrDefault<bool>("simpleRho", simpleRho_);
87 
88  turbOnFinalIterOnly_ =
89  dict().lookupOrDefault<bool>("turbOnFinalIterOnly", true);
90 
91  return true;
92 }
93 
94 
96 {
97  return
98  (!anyPisoIter() && loop_.finalPimpleIter())
100 }
101 
102 
103 // ************************************************************************* //
virtual ~pimpleNoLoopControl()
Destructor.
dictionary dict
virtual bool read()
Read controls.
Pimple loop class. Implements the logic which controls the pimple loop generically for a given correc...
Definition: pimpleLoop.H:51
bool read(const char *, int32_t &)
Definition: int32IO.C:85
dynamicFvMesh & mesh
A class for handling words, derived from string.
Definition: word.H:59
virtual bool read()
Read controls.
Definition: pisoControl.C:56
pimpleNoLoopControl(fvMesh &mesh, const word &algorithmName, const pimpleLoop &loop)
Construct from a mesh, the name of the algorithm, and a reference.
Piso control class. Provides time-loop and piso-loop control methods. No convergence checking is done...
Definition: pisoControl.H:52
virtual bool isFinal() const
Flag to indicate whether in final state.
Definition: pisoControl.C:71
defineTypeNameAndDebug(combustionModel, 0)
virtual bool isFinal() const
Flag to indicate whether in final state.
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:78
Single-region-specific derivation of the convergence control class.
bool steady() const
Return true if the default ddtScheme is steadyState.
Definition: fvSchemes.H:134
Single-region-specific derivation of the corrector convergence control class.
Namespace for OpenFOAM.