functionObjectPropertiesTemplates.C

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | www.openfoam.com
     \\/     M anipulation  |
-------------------------------------------------------------------------------
    Copyright (C) 2021 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 "IOdictionary.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
template<class Type>
Type Foam::functionObjects::properties::getObjectProperty
(
    const word& objectName,
    const word& entryName,
    const Type& defaultValue
) const
{
    Type result = defaultValue;
    getObjectProperty(objectName, entryName, result);
    return result;
}
 
 
template<class Type>
bool Foam::functionObjects::properties::getObjectProperty
(
    const word& objectName,
    const word& entryName,
    Type& value
) const
{
    if (this->found(objectName))
    {
        const dictionary& baseDict = this->subDict(objectName);
        return baseDict.readIfPresent(entryName, value);
    }
 
    return false;
}
 
 
template<class Type>
void Foam::functionObjects::properties::setObjectProperty
(
    const word& objectName,
    const word& entryName,
    const Type& value
)
{
    if (!this->found(objectName))
    {
        this->add(objectName, dictionary());
    }
 
    dictionary& baseDict = this->subDict(objectName);
    baseDict.add(entryName, value, true);
}
 
 
template<class Type>
void Foam::functionObjects::properties::setObjectResult
(
    const word& objectName,
    const word& entryName,
    const Type& value
)
{
    if (!this->found(resultsName_))
    {
        this->add(resultsName_, dictionary());
    }
 
    dictionary& resultsDict = this->subDict(resultsName_);
 
    if (!resultsDict.found(objectName))
    {
        resultsDict.add(objectName, dictionary());
    }
 
    dictionary& objectDict = resultsDict.subDict(objectName);
 
    const word& dictTypeName = pTraits<Type>::typeName;
 
    if (!objectDict.found(dictTypeName))
    {
        objectDict.add(dictTypeName, dictionary());
    }
 
    dictionary& resultTypeDict = objectDict.subDict(dictTypeName);
 
    resultTypeDict.add(entryName, value, true);
}
 
 
template<class Type>
Type Foam::functionObjects::properties::getObjectResult
(
    const word& objectName,
    const word& entryName,
    const Type& defaultValue
) const
{
    Type result = defaultValue;
    (void)getObjectResult(objectName, entryName, result);
    return result;
}
 
 
template<class Type>
bool Foam::functionObjects::properties::getObjectResult
(
    const word& objectName,
    const word& entryName,
    Type& value
) const
{
    if (this->found(resultsName_))
    {
        const dictionary& resultsDict = this->subDict(resultsName_);
 
        if (resultsDict.found(objectName))
        {
            const dictionary& objectDict = resultsDict.subDict(objectName);
 
            const word& dictTypeName = pTraits<Type>::typeName;
 
            if (objectDict.found(dictTypeName))
            {
                const dictionary& resultTypeDict =
                    objectDict.subDict(dictTypeName);
 
                return resultTypeDict.readIfPresent<Type>(entryName, value);
            }
        }
    }
 
    return false;
}
 
 
// ************************************************************************* //