618d9d33b2
Foam::graph superseded by the more general Foam::setWriter reducing code maintenance overhead, simplifying usage and further development.
150 lines
4.1 KiB
C++
150 lines
4.1 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration | Website: https://openfoam.org
|
|
\\ / A nd | Copyright (C) 2020-2023 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::setWriteIntervalFunctionObject
|
|
|
|
Description
|
|
Updates the writeInterval as a Function1 of time.
|
|
|
|
If the case is running with userTime specified in controlDict then the write
|
|
interval values returned by the Function1 are assumed to be in user-time
|
|
rather than real-time.
|
|
|
|
Examples of function object specification:
|
|
\verbatim
|
|
setWriteInterval
|
|
{
|
|
type setWriteInterval;
|
|
|
|
libs ("libutilityFunctionObjects.so");
|
|
|
|
writeInterval table
|
|
(
|
|
(0 0.005)
|
|
(0.1 0.005)
|
|
(0.1001 0.01)
|
|
(0.2 0.01)
|
|
(0.2001 0.02)
|
|
);
|
|
}
|
|
\endverbatim
|
|
will cause results to be written every 0.005s between 0 and 0.1s, every
|
|
0.01s between 0.1 and 0.2s and every 0.02s thereafter.
|
|
|
|
SourceFiles
|
|
setWriteIntervalFunctionObject.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef functionObjects_setWriteIntervalFunctionObject_H
|
|
#define functionObjects_setWriteIntervalFunctionObject_H
|
|
|
|
#include "functionObject.H"
|
|
#include "Function1.H"
|
|
#include "Time.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
namespace functionObjects
|
|
{
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class setWriteIntervalFunctionObject Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class setWriteIntervalFunctionObject
|
|
:
|
|
public functionObject
|
|
{
|
|
// Private Data
|
|
|
|
//- Time step function/table
|
|
autoPtr<Function1<scalar>> writeIntervalPtr_;
|
|
|
|
|
|
public:
|
|
|
|
//- Runtime type information
|
|
TypeName("setWriteInterval");
|
|
|
|
|
|
// Constructors
|
|
|
|
//- Construct from components
|
|
setWriteIntervalFunctionObject
|
|
(
|
|
const word& name,
|
|
const Time& runTime,
|
|
const dictionary& dict
|
|
);
|
|
|
|
//- Disallow default bitwise copy construction
|
|
setWriteIntervalFunctionObject
|
|
(
|
|
const setWriteIntervalFunctionObject&
|
|
) = delete;
|
|
|
|
|
|
// Destructor
|
|
virtual ~setWriteIntervalFunctionObject();
|
|
|
|
|
|
// Member Functions
|
|
|
|
//- Read and reset the writeInterval Function1
|
|
virtual bool read(const dictionary&);
|
|
|
|
//- Return the list of fields required
|
|
virtual wordList fields() const
|
|
{
|
|
return wordList::null();
|
|
}
|
|
|
|
//- Reset the writeInterval from the Function1 of time
|
|
virtual bool execute();
|
|
|
|
//- Do nothing
|
|
virtual bool write();
|
|
|
|
|
|
// Member Operators
|
|
|
|
//- Disallow default bitwise assignment
|
|
void operator=(const setWriteIntervalFunctionObject&) = delete;
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace functionObjects
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|