All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
simpleControl.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 "simpleControl.H"
27 
28 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
29 
30 namespace Foam
31 {
33 }
34 
35 
36 // * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
37 
39 {
40  return
43 }
44 
45 
46 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
47 
48 Foam::simpleControl::simpleControl(fvMesh& mesh, const word& algorithmName)
49 :
50  fluidSolutionControl(mesh, algorithmName),
52  (
53  static_cast<singleRegionSolutionControl&>(*this)
54  )
55 {
56  read();
58 }
59 
60 
61 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
62 
64 {}
65 
66 
67 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
68 
70 {
71  if (!endIfConverged(time))
72  {
73  storePrevIterFields();
74  }
75 
76  return time.run();
77 }
78 
79 
81 {
82  if (!endIfConverged(time))
83  {
84  storePrevIterFields();
85  }
86 
87  return time.loop();
88 }
89 
90 
91 // ************************************************************************* //
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:76
virtual bool run() const
Return true if run should continue,.
Definition: Time.C:901
virtual bool loop()
Return true if run should continue and if so increment time.
Definition: Time.C:948
Fluid solution control class. Holds flags specific to the solution of fluids.
virtual bool read()
Read controls.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:99
Simple control class. Provides time-loop control methods which exit the simulation once convergence c...
Definition: simpleControl.H:67
bool run(Time &time)
Time run loop.
Definition: simpleControl.C:69
simpleControl(fvMesh &mesh, const word &algorithmName="SIMPLE")
Construct from a mesh and the name of the algorithm.
Definition: simpleControl.C:48
bool loop(Time &time)
Time loop loop.
Definition: simpleControl.C:80
virtual ~simpleControl()
Destructor.
Definition: simpleControl.C:63
virtual bool read()
Read controls.
Definition: simpleControl.C:38
Single-region-specific derivation of the convergence control class.
void printResidualControls() const
Print the residual controls.
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)