data/src/OpenFOAM/db/functionObjects/objectRegistryFunctionObject/objectRegistryFunctionObjectTemplates.C

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2016-2024 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 "objectRegistryFunctionObject.H"
#include "objectRegistry.H"

// * * * * * * * * * * * * * Protected Member Functions  * * * * * * * * * * //

template<class ObjectType>
bool Foam::functionObjects::objectRegistryFunctionObject::foundObject
(
    const word& fieldName
) const
{
    return obr_.foundObject<ObjectType>(fieldName);
}


template<class Type>
void Foam::functionObjects::objectRegistryFunctionObject::cannotFindObject
(
    const word& fieldName
)
{
    Warning
        << "    functionObjects::" << type() << " " << name()
        << " cannot find required object " << fieldName << " of type "
        << Type::typeName << endl;
}


template<class ObjectType>
const ObjectType&
Foam::functionObjects::objectRegistryFunctionObject::lookupObject
(
    const word& fieldName
) const
{
    return obr_.lookupObject<ObjectType>(fieldName);
}


template<class ObjectType>
ObjectType&
Foam::functionObjects::objectRegistryFunctionObject::lookupObjectRef
(
    const word& fieldName
)
{
    return obr_.lookupObjectRef<ObjectType>(fieldName);
}


template<class ObjectType>
ObjectType& Foam::functionObjects::objectRegistryFunctionObject::store
(
    const tmp<ObjectType>& tfield
)
{
    if (obr_.foundObject<ObjectType>(tfield->name()))
    {
        ObjectType& field = obr_.lookupObjectRef<ObjectType>(tfield->name());

        // If there is a result field already registered assign to the new
        // result field otherwise transfer ownership of the new result field to
        // the object registry
        if (&field != &tfield())
        {
            field = tfield;
            return field;
        }
        else
        {
            ObjectType* fieldPtr = tfield.ptr();
            obr_.objectRegistry::store(fieldPtr);
            return *fieldPtr;
        }
    }
    else
    {
        ObjectType* fieldPtr = tfield.ptr();
        obr_.objectRegistry::store(fieldPtr);
        return *fieldPtr;
    }
}


template<class ObjectType>
ObjectType& Foam::functionObjects::objectRegistryFunctionObject::store
(
    const word& fieldName,
    const tmp<ObjectType>& tfield,
    bool cacheable
)
{
    if (cacheable && fieldName == tfield().name())
    {
        WarningInFunction
            << "Cannot store cache-able field with the name used in the cache."
            << nl
            << "    Either choose a different name or cache the field"
            << "    and use the 'writeObjects' functionObject."
            << endl;

        return tfield.ref();
    }

    if
    (
        fieldName.size()
     && obr_.foundObject<ObjectType>(fieldName)
    )
    {
        ObjectType& field = obr_.lookupObjectRef<ObjectType>(fieldName);

        // If there is a result field already registered assign to the new
        // result field otherwise transfer ownership of the new result field to
        // the object registry
        if (&field != &tfield())
        {
            field = tfield;
        }
        else
        {
            obr_.objectRegistry::store(tfield.ptr());
        }

        return field;
    }
    else
    {
        if (fieldName.size() && fieldName != tfield().name())
        {
            tfield.ref().rename(fieldName);
        }

        ObjectType* fieldPtr = tfield.ptr();
        obr_.objectRegistry::store(fieldPtr);
        return *fieldPtr;
    }
}


// ************************************************************************* //