gradScheme.C

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2011-2022 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 "fv.H"
#include "objectRegistry.H"
#include "solution.H"
 
// * * * * * * * * * * * * * * * * * Selectors * * * * * * * * * * * * * * * //
 
template<class Type>
Foam::tmp<Foam::fv::gradScheme<Type>> Foam::fv::gradScheme<Type>::New
(
    const fvMesh& mesh,
    Istream& schemeData
)
{
    if (fv::debug)
    {
        InfoInFunction << "Constructing gradScheme<Type>" << endl;
    }
 
    if (schemeData.eof())
    {
        FatalIOErrorInFunction
        (
            schemeData
        )   << "Grad scheme not specified" << endl << endl
            << "Valid grad schemes are :" << endl
            << IstreamConstructorTablePtr_->sortedToc()
            << exit(FatalIOError);
    }
 
    const word schemeName(schemeData);
 
    typename IstreamConstructorTable::iterator cstrIter =
        IstreamConstructorTablePtr_->find(schemeName);
 
    if (cstrIter == IstreamConstructorTablePtr_->end())
    {
        FatalIOErrorInFunction
        (
            schemeData
        )   << "Unknown grad scheme " << schemeName << nl << nl
            << "Valid grad schemes are :" << endl
            << IstreamConstructorTablePtr_->sortedToc()
            << exit(FatalIOError);
    }
 
    return cstrIter()(mesh, schemeData);
}
 
 
// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
 
template<class Type>
Foam::fv::gradScheme<Type>::~gradScheme()
{}
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
template<class Type>
Foam::tmp
<
    Foam::VolField<typename Foam::outerProduct<Foam::vector, Type>::type>
>
Foam::fv::gradScheme<Type>::grad
(
    const VolField<Type>& vsf,
    const word& name
) const
{
    typedef typename outerProduct<vector, Type>::type GradType;
 
    if (!this->mesh().changing() && this->mesh().solution().cache(name))
    {
        if
        (
            !mesh().objectRegistry::template
            foundObject<VolField<GradType>>(name)
        )
        {
            solution::cachePrintMessage("Calculating and caching", name, vsf);
            tmp<VolField<GradType>> tgGrad = calcGrad(vsf, name);
            regIOobject::store(tgGrad.ptr());
        }
 
        solution::cachePrintMessage("Retrieving", name, vsf);
        VolField<GradType>& gGrad =
            mesh().objectRegistry::template lookupObjectRef<VolField<GradType>>
            (
                name
            );
 
        if (gGrad.upToDate(vsf))
        {
            return gGrad;
        }
        else
        {
            solution::cachePrintMessage("Deleting", name, vsf);
            gGrad.release();
            delete &gGrad;
 
            solution::cachePrintMessage("Recalculating", name, vsf);
            tmp<VolField<GradType>> tgGrad = calcGrad(vsf, name);
 
            solution::cachePrintMessage("Storing", name, vsf);
            regIOobject::store(tgGrad.ptr());
            VolField<GradType>& gGrad =
                mesh().objectRegistry::template
                lookupObjectRef<VolField<GradType>>
                (
                    name
                );
 
            return gGrad;
        }
    }
    else
    {
        if
        (
            mesh().objectRegistry::template
            foundObject<VolField<GradType>>(name)
        )
        {
            VolField<GradType>& gGrad =
                mesh().objectRegistry::template
                lookupObjectRef<VolField<GradType>>
                (
                    name
                );
 
            if (gGrad.ownedByRegistry())
            {
                solution::cachePrintMessage("Deleting", name, vsf);
                gGrad.release();
                delete &gGrad;
            }
        }
 
        solution::cachePrintMessage("Calculating", name, vsf);
        return calcGrad(vsf, name);
    }
}
 
 
template<class Type>
Foam::tmp
<
    Foam::VolField<typename Foam::outerProduct<Foam::vector, Type>::type>
>
Foam::fv::gradScheme<Type>::grad
(
    const VolField<Type>& vsf
) const
{
    return grad(vsf, "grad(" + vsf.name() + ')');
}
 
 
template<class Type>
Foam::tmp
<
    Foam::VolField<typename Foam::outerProduct<Foam::vector, Type>::type>
>
Foam::fv::gradScheme<Type>::grad
(
    const tmp<VolField<Type>>& tvsf
) const
{
    typedef typename outerProduct<vector, Type>::type GradType;
 
    tmp<VolField<GradType>> tgrad = grad(tvsf());
    tvsf.clear();
    return tgrad;
}
 
 
// ************************************************************************* //