mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
9be9be2447
This new class provides function objects with a database (dictionary) to store current state information to enable smooth restart behaviour. Additionally, current results can be stored so that they can be accessed between different objects.
174 lines
4.2 KiB
C
174 lines
4.2 KiB
C
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2015 OpenFOAM Foundation
|
|
\\/ M anipulation | Copyright (C) 2015 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 "functionObjectState.H"
|
|
#include "Time.H"
|
|
|
|
const Foam::word Foam::functionObjectState::resultsName_ = "results";
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
|
|
|
|
Foam::functionObjectState::functionObjectState
|
|
(
|
|
const objectRegistry& obr,
|
|
const word& name
|
|
)
|
|
:
|
|
obr_(obr),
|
|
name_(name),
|
|
active_(true),
|
|
stateDict_
|
|
(
|
|
const_cast<IOdictionary&>(obr.time().functionObjects().stateDict())
|
|
)
|
|
{}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
|
|
|
|
Foam::functionObjectState::~functionObjectState()
|
|
{}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
|
|
|
|
const Foam::word& Foam::functionObjectState::name() const
|
|
{
|
|
return name_;
|
|
}
|
|
|
|
|
|
bool Foam::functionObjectState::active() const
|
|
{
|
|
return active_;
|
|
}
|
|
|
|
|
|
const Foam::IOdictionary& Foam::functionObjectState::stateDict() const
|
|
{
|
|
return stateDict_;
|
|
}
|
|
|
|
|
|
Foam::dictionary& Foam::functionObjectState::propertyDict()
|
|
{
|
|
if (!stateDict_.found(name_))
|
|
{
|
|
stateDict_.add(name_, dictionary());
|
|
}
|
|
|
|
return stateDict_.subDict(name_);
|
|
}
|
|
|
|
|
|
bool Foam::functionObjectState::foundProperty(const word& entryName) const
|
|
{
|
|
if (stateDict_.found(name_))
|
|
{
|
|
const dictionary& baseDict = stateDict_.subDict(name_);
|
|
return baseDict.found(entryName);
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
Foam::word Foam::functionObjectState::resultType(const word& entryName) const
|
|
{
|
|
return objectResultType(name_, entryName);
|
|
}
|
|
|
|
|
|
Foam::word Foam::functionObjectState::objectResultType
|
|
(
|
|
const word& objectName,
|
|
const word& entryName
|
|
) const
|
|
{
|
|
word result = word::null;
|
|
|
|
if (stateDict_.found(resultsName_))
|
|
{
|
|
const dictionary& resultsDict = stateDict_.subDict(resultsName_);
|
|
|
|
if (resultsDict.found(objectName))
|
|
{
|
|
const dictionary& objectDict = resultsDict.subDict(objectName);
|
|
|
|
forAllConstIter(dictionary, objectDict, iter)
|
|
{
|
|
const dictionary& dict = iter().dict();
|
|
|
|
if (dict.found(entryName))
|
|
{
|
|
return dict.dictName();
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
|
|
Foam::List<Foam::word> Foam::functionObjectState::objectResultEntries() const
|
|
{
|
|
return objectResultEntries(name_);
|
|
}
|
|
|
|
|
|
Foam::List<Foam::word> Foam::functionObjectState::objectResultEntries
|
|
(
|
|
const word& objectName
|
|
) const
|
|
{
|
|
DynamicList<word> result(2);
|
|
|
|
if (stateDict_.found(resultsName_))
|
|
{
|
|
const dictionary& resultsDict = stateDict_.subDict(resultsName_);
|
|
|
|
if (resultsDict.found(objectName))
|
|
{
|
|
const dictionary& objectDict = resultsDict.subDict(objectName);
|
|
|
|
forAllConstIter(dictionary, objectDict, iter)
|
|
{
|
|
const dictionary& dict = iter().dict();
|
|
result.append(dict.toc());
|
|
}
|
|
}
|
|
}
|
|
|
|
wordList entries;
|
|
entries.transfer(result);
|
|
|
|
return entries;
|
|
}
|
|
|
|
|
|
// ************************************************************************* //
|