91aba2db2e
- Avoids the need for the 'OutputFilterFunctionObject' wrapper
- Time-control for execution and writing is now provided by the
'timeControlFunctionObject' which instantiates the processing
'functionObject' and controls its operation.
- Alternative time-control functionObjects can now be written and
selected at run-time without the need to compile wrapped version of
EVERY existing functionObject which would have been required in the
old structure.
- The separation of 'execute' and 'write' functions is now formalized in the
'functionObject' base-class and all derived classes implement the
two functions.
- Unnecessary implementations of functions with appropriate defaults
in the 'functionObject' base-class have been removed reducing
clutter and simplifying implementation of new functionObjects.
- The 'coded' 'functionObject' has also been updated, simplified and tested.
- Further simplification is now possible by creating some general
intermediate classes derived from 'functionObject'.
142 lines
3.8 KiB
C
142 lines
3.8 KiB
C
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2011-2016 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/>.
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#include "systemCall.H"
|
|
#include "Time.H"
|
|
#include "dynamicCode.H"
|
|
#include "addToRunTimeSelectionTable.H"
|
|
|
|
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
namespace functionObjects
|
|
{
|
|
defineTypeNameAndDebug(systemCall, 0);
|
|
|
|
addToRunTimeSelectionTable
|
|
(
|
|
functionObject,
|
|
systemCall,
|
|
dictionary
|
|
);
|
|
}
|
|
}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
|
|
|
|
Foam::functionObjects::systemCall::systemCall
|
|
(
|
|
const word& name,
|
|
const Time&,
|
|
const dictionary& dict
|
|
)
|
|
:
|
|
functionObject(name),
|
|
executeCalls_(),
|
|
endCalls_(),
|
|
writeCalls_()
|
|
{
|
|
read(dict);
|
|
}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
|
|
|
|
Foam::functionObjects::systemCall::~systemCall()
|
|
{}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
|
|
|
|
bool Foam::functionObjects::systemCall::read(const dictionary& dict)
|
|
{
|
|
dict.readIfPresent("executeCalls", executeCalls_);
|
|
dict.readIfPresent("endCalls", endCalls_);
|
|
dict.readIfPresent("writeCalls", writeCalls_);
|
|
|
|
if (executeCalls_.empty() && endCalls_.empty() && writeCalls_.empty())
|
|
{
|
|
WarningInFunction
|
|
<< "no executeCalls, endCalls or writeCalls defined."
|
|
<< endl;
|
|
}
|
|
else if (!dynamicCode::allowSystemOperations)
|
|
{
|
|
FatalErrorInFunction
|
|
<< "Executing user-supplied system calls is not enabled by "
|
|
<< "default because of " << nl
|
|
<< "security issues. If you trust the case you can enable this "
|
|
<< "facility by " << nl
|
|
<< "adding to the InfoSwitches setting in the system controlDict:"
|
|
<< nl << nl
|
|
<< " allowSystemOperations 1" << nl << nl
|
|
<< "The system controlDict is either" << nl << nl
|
|
<< " ~/.OpenFOAM/$WM_PROJECT_VERSION/controlDict" << nl << nl
|
|
<< "or" << nl << nl
|
|
<< " $WM_PROJECT_DIR/etc/controlDict" << nl << nl
|
|
<< exit(FatalError);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
bool Foam::functionObjects::systemCall::execute(const bool postProcess)
|
|
{
|
|
forAll(executeCalls_, callI)
|
|
{
|
|
Foam::system(executeCalls_[callI]);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
bool Foam::functionObjects::systemCall::end()
|
|
{
|
|
forAll(endCalls_, callI)
|
|
{
|
|
Foam::system(endCalls_[callI]);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
bool Foam::functionObjects::systemCall::write(const bool postProcess)
|
|
{
|
|
forAll(writeCalls_, callI)
|
|
{
|
|
Foam::system(writeCalls_[callI]);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
// ************************************************************************* //
|