mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
610c290969
- this is a provision for defining execute actions that can be called largely independently of the normal time-loop constraints. This can be useful to provide hooks for sub-cycling, or to define an action that can be triggered manually or on some other event.
177 lines
4.2 KiB
C
177 lines
4.2 KiB
C
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
|
|
\\/ M anipulation | Copyright (C) 2017 OpenCFD Ltd.
|
|
-------------------------------------------------------------------------------
|
|
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 "functionObject.H"
|
|
#include "dictionary.H"
|
|
#include "dlLibraryTable.H"
|
|
#include "Time.H"
|
|
|
|
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
defineDebugSwitchWithName(functionObject, "functionObject", 0);
|
|
defineRunTimeSelectionTable(functionObject, dictionary);
|
|
}
|
|
|
|
bool Foam::functionObject::postProcess(false);
|
|
|
|
|
|
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
|
|
|
|
Foam::word Foam::functionObject::scopedName(const word& name) const
|
|
{
|
|
return name_ + ":" + name;
|
|
}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
|
|
|
|
Foam::functionObject::functionObject(const word& name)
|
|
:
|
|
name_(name),
|
|
log(postProcess)
|
|
{}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * Selectors * * * * * * * * * * * * * * * * //
|
|
|
|
Foam::autoPtr<Foam::functionObject> Foam::functionObject::New
|
|
(
|
|
const word& name,
|
|
const Time& runTime,
|
|
const dictionary& dict
|
|
)
|
|
{
|
|
const word functionType(dict.lookup("type"));
|
|
|
|
if (debug)
|
|
{
|
|
Info<< "Selecting function " << functionType << endl;
|
|
}
|
|
|
|
if (dict.found("functionObjectLibs"))
|
|
{
|
|
const_cast<Time&>(runTime).libs().open
|
|
(
|
|
dict,
|
|
"functionObjectLibs",
|
|
dictionaryConstructorTablePtr_
|
|
);
|
|
}
|
|
else
|
|
{
|
|
const_cast<Time&>(runTime).libs().open
|
|
(
|
|
dict,
|
|
"libs",
|
|
dictionaryConstructorTablePtr_
|
|
);
|
|
}
|
|
|
|
if (!dictionaryConstructorTablePtr_)
|
|
{
|
|
FatalErrorInFunction
|
|
<< "Unknown function type "
|
|
<< functionType << nl << nl
|
|
<< "Table of functionObjects is empty" << endl
|
|
<< exit(FatalError);
|
|
}
|
|
|
|
auto cstrIter = dictionaryConstructorTablePtr_->cfind(functionType);
|
|
|
|
if (!cstrIter.found())
|
|
{
|
|
FatalErrorInFunction
|
|
<< "Unknown function type "
|
|
<< functionType << nl << nl
|
|
<< "Valid function types :" << nl
|
|
<< dictionaryConstructorTablePtr_->sortedToc() << endl
|
|
<< exit(FatalError);
|
|
}
|
|
|
|
return autoPtr<functionObject>(cstrIter()(name, runTime, dict));
|
|
}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
|
|
|
|
Foam::functionObject::~functionObject()
|
|
{}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
|
|
|
|
const Foam::word& Foam::functionObject::name() const
|
|
{
|
|
return name_;
|
|
}
|
|
|
|
|
|
bool Foam::functionObject::read(const dictionary& dict)
|
|
{
|
|
if (!postProcess)
|
|
{
|
|
log = dict.lookupOrDefault<Switch>("log", true);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
bool Foam::functionObject::execute(const label)
|
|
{
|
|
return true;
|
|
}
|
|
|
|
|
|
bool Foam::functionObject::end()
|
|
{
|
|
return true;
|
|
}
|
|
|
|
|
|
bool Foam::functionObject::adjustTimeStep()
|
|
{
|
|
return false;
|
|
}
|
|
|
|
|
|
bool Foam::functionObject::filesModified() const
|
|
{
|
|
return false;
|
|
}
|
|
|
|
|
|
void Foam::functionObject::updateMesh(const mapPolyMesh&)
|
|
{}
|
|
|
|
|
|
void Foam::functionObject::movePoints(const polyMesh&)
|
|
{}
|
|
|
|
|
|
// ************************************************************************* //
|