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-2020 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 {
32  defineTypeNameAndDebug(simpleControl, 0);
33 }
34 
35 
36 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
37 
39 :
40  fluidSolutionControl(mesh, algorithmName),
42  (
43  static_cast<singleRegionSolutionControl&>(*this)
44  )
45 {
46  read();
48 }
49 
50 
51 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
52 
54 {}
55 
56 
57 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
58 
60 {
62 }
63 
64 
66 {
67  read();
68 
69  time.run();
70 
71  if (!endIfConverged(time))
72  {
74  }
75 
76  return time.running();
77 }
78 
79 
81 {
82  read();
83 
84  time.run();
85 
86  if (!endIfConverged(time))
87  {
89  }
90 
91  if (time.running())
92  {
93  time ++;
94  return true;
95  }
96  else
97  {
98  return false;
99  }
100 }
101 
102 
103 // ************************************************************************* //
virtual ~simpleControl()
Destructor.
Definition: simpleControl.C:53
Single-region-specific derivation of the solution control class.
bool readResidualControls()
Read residual controls.
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:68
virtual bool run() const
Return true if run should continue,.
Definition: Time.C:795
simpleControl(fvMesh &mesh, const word &algorithmName="SIMPLE")
Construct from a mesh and the name of the algorithm.
Definition: simpleControl.C:38
dynamicFvMesh & mesh
A class for handling words, derived from string.
Definition: word.H:59
virtual bool running() const
Return true if run should continue without any side effects.
Definition: Time.C:789
bool loop(Time &time)
Time loop loop.
Definition: simpleControl.C:80
const Time & time() const
Return the time.
void storePrevIterFields()
Store previous iteration for fields.
defineTypeNameAndDebug(combustionModel, 0)
virtual bool read()
Read controls.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
Single-region-specific derivation of the convergence control class.
bool run(Time &time)
Time run loop.
Definition: simpleControl.C:65
Fluid solution control class. Holds flags specific to the solution of fluids.
bool endIfConverged(Time &time)
End the run if convergence has been reached.
void printResidualControls() const
Print the residual controls.
Namespace for OpenFOAM.
virtual bool read()
Read controls.
Definition: simpleControl.C:59