All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
solutionControl.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-2024 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 "solutionControl.H"
27 
28 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
29 
30 namespace Foam
31 {
33 }
34 
35 
36 // * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
37 
39 {
40  return true;
41 }
42 
43 
45 {
47  return false;
48 }
49 
50 
51 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
52 
54 (
55  const objectRegistry& registry,
56  const word& algorithmName
57 )
58 :
60  (
61  IOobject
62  (
63  typeName,
64  registry.time().name(),
65  registry,
66  IOobject::NO_READ,
67  IOobject::NO_WRITE
68  )
69  ),
70  registry_(registry),
71  algorithmName_(algorithmName),
72  algorithmSpaceStr_(algorithmName.size(), ' '),
73  finalIter_(false)
74 {}
75 
76 
77 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
78 
80 {}
81 
82 
83 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
84 
86 {
87  if (registry.foundType<solutionControl>())
88  {
89  return registry.lookupType<solutionControl>().finalIter_;
90  }
91  else
92  {
93  return false;
94  }
95 }
96 
97 
98 // ************************************************************************* //
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:99
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
Registry of regIOobjects.
bool foundType(const word &group=word::null) const
Is the Type in registry.
const Type & lookupType(const word &group=word::null) const
Lookup and return the object of the given Type.
regIOobject is an abstract class derived from IOobject to handle automatic object registration with t...
Definition: regIOobject.H:55
Solution control class.
solutionControl(const objectRegistry &registry, const word &algorithmName)
Construct from the time, the name of the algorithm and a registry.
virtual ~solutionControl()
Destructor.
virtual bool writeData(Ostream &) const
Dummy write for regIOobject.
virtual bool read()=0
Read controls.
static bool finalIteration(const objectRegistry &registry)
Lookup solutionControl from the objectRegistry and return finalIter.
A class for handling words, derived from string.
Definition: word.H:62
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
Definition: error.H:381
Namespace for OpenFOAM.
word name(const bool)
Return a word representation of a bool.
Definition: boolIO.C:39
defineTypeNameAndDebug(combustionModel, 0)