All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
simpleControl.H
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 Class
25  Foam::simpleControl
26 
27 Description
28  Simple control class. Provides time-loop control methods which exit the
29  simulation once convergence criteria have been reached. Example usage:
30 
31  \verbatim
32  simpleControl simple(mesh);
33 
34  while (simple.loop(runTime))
35  {
36  Info<< "Time = " << runTime.userTimeName() << nl << endl;
37 
38  // solve ...
39  }
40  \endverbatim
41 
42 SourceFiles
43  simpleControl.C
44 
45 \*---------------------------------------------------------------------------*/
46 
47 #ifndef simpleControl_H
48 #define simpleControl_H
49 
50 #include "fluidSolutionControl.H"
52 
53 #define SIMPLE_CONTROL
54 
55 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
56 
57 namespace Foam
58 {
59 
60 /*---------------------------------------------------------------------------*\
61  Class simpleControl Declaration
62 \*---------------------------------------------------------------------------*/
63 
64 class simpleControl
65 :
66  public fluidSolutionControl,
68 {
69 protected:
70 
71  // Protected Member Functions
72 
73  //- Read controls
74  virtual bool read();
75 
76 
77 public:
78 
79  // Static Data Members
80 
81  //- Run-time type information
82  TypeName("simpleControl");
83 
84 
85  // Constructors
86 
87  //- Construct from a mesh and the name of the algorithm
88  simpleControl(fvMesh& mesh, const word& algorithmName="SIMPLE");
89 
90 
91  //- Destructor
92  virtual ~simpleControl();
93 
94 
95  // Member Functions
96 
97  // Evolution
98 
99  //- Time run loop
100  bool run(Time& time);
101 
102  //- Time loop loop
103  bool loop(Time& time);
104 };
105 
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 } // End namespace Foam
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 #endif
114 
115 // ************************************************************************* //
const Time & time() const
Return time.
Definition: IOobject.C:318
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:76
Fluid solution control class. Holds flags specific to the solution of fluids.
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
TypeName("simpleControl")
Run-time type information.
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.
const fvMesh & mesh() const
Return the mesh.
const word & algorithmName() const
Return the name of the algorithm.
A class for handling words, derived from string.
Definition: word.H:62
Namespace for OpenFOAM.