All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
pimpleControl.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) 2022 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::pimpleControl
26 
27 Description
28 
29 SourceFiles
30  pimpleControl.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef pimpleControl_H
35 #define pimpleControl_H
36 
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 namespace Foam
42 {
43 
44 /*---------------------------------------------------------------------------*\
45  Class pimpleControl Declaration
46 \*---------------------------------------------------------------------------*/
47 
48 class pimpleControl
49 :
50  public pimpleNoLoopControl,
52 {
53 public:
54 
55  // Static Data Members
56 
57  //- Run-time type information
58  TypeName("pimpleControl");
59 
60 
61  // Constructors
62 
63  //- Construct from a mesh and the name of the algorithm
64  pimpleControl(fvMesh& mesh, const word& algorithmName="PIMPLE");
65 
66 
67  //- Destructor
68  virtual ~pimpleControl();
69 
70 
71  // Member Functions
72 
74 
76 
77  //- Flag to indicate the first iteration
78  bool firstPimpleIter() const
79  {
81  }
82 
83  //- Flag to indicate the final iteration
84  bool finalPimpleIter() const
85  {
87  }
88 };
89 
90 
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 
93 } // End namespace Foam
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 #endif
98 
99 // ************************************************************************* //
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:99
bool firstPimpleIter() const
Flag to indicate the first iteration.
Definition: pimpleControl.H:77
pimpleControl(fvMesh &mesh, const word &algorithmName="PIMPLE")
Construct from a mesh and the name of the algorithm.
Definition: pimpleControl.C:38
bool finalPimpleIter() const
Flag to indicate the final iteration.
Definition: pimpleControl.H:83
virtual ~pimpleControl()
Destructor.
Definition: pimpleControl.C:47
TypeName("pimpleControl")
Run-time type information.
bool finalIter() const
Flag to indicate the last iteration.
Definition: pimpleLoopI.H:46
bool firstIter() const
Flag to indicate the first iteration.
Definition: pimpleLoopI.H:40
Pimple no-loop control class. Implements various option flags, but leaves loop controls to the deriva...
Pimple single region control class. Provides time-loop control methods which exit the simulation once...
bool run(Time &time)
Time run loop.
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.