File size: 4,033 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2020-2025 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::functionObjects::stopAt
Description
Abstract base class for stop conditions.
Currently the following actions are supported:
- noWriteNow
- writeNow
- nextWrite
SourceFiles
stopAt.C
\*---------------------------------------------------------------------------*/
#ifndef stopAt_functionObject_H
#define stopAt_functionObject_H
#include "functionObject.H"
#include "NamedEnum.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class stopAt Declaration
\*---------------------------------------------------------------------------*/
class stopAt
:
public functionObject
{
public:
//- Enumeration defining the type of action
enum class actionType
{
noWriteNow, //!< stop immediately without writing data
writeNow, //!< write data and stop immediately
nextWrite //!< stop the next time data are written
};
protected:
// Protected data
//- Action type names
static const NamedEnum<actionType, 3> actionTypeNames_;
//- The type of action
actionType action_;
//- Set true when the stop action has executed
bool stopped_;
// Protected Member Functions
//- Return true when the stop condition is achieved
virtual bool condition() const = 0;
public:
//- Runtime type information
TypeName("stopAt");
// Constructors
//- Construct from Time and dictionary
stopAt
(
const word& name,
const Time& runTime,
const dictionary&
);
//- Disallow default bitwise copy construction
stopAt(const stopAt&) = delete;
//- Destructor
virtual ~stopAt();
// Member Functions
//- Read the dictionary settings
virtual bool read(const dictionary&);
//- Return the list of fields required
virtual wordList fields() const
{
return wordList::null();
}
//- Execute, check existence of stopAt file and take action
virtual bool execute();
//- Execute, check existence of stopAt file and take action
virtual bool write();
//- Execute at the final time-loop, used for cleanup
virtual bool end();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const stopAt&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace functionObjects
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|