data/src/finiteVolume/cfdTools/general/fvModels/fvModels.C

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

// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //

namespace Foam
{
    defineTypeNameAndDebug(fvModels, 0);
}


// * * * * * * * * * * * * Private Member Functions  * * * * * * * * * * * * //

Foam::IOobject Foam::fvModels::createIOobject(const fvMesh& mesh)
{
    typeIOobject<IOdictionary> io
    (
        typeName,
        mesh.time().constant(),
        mesh,
        IOobject::MUST_READ,
        IOobject::AUTO_WRITE
    );

    if (io.headerOk())
    {
        Info<< indentOrNl << "Constructing " << typeName << " from "
            << io.relativeObjectPath().c_str() << endl;

        io.readOpt() = IOobject::MUST_READ_IF_MODIFIED;
        return io;
    }
    else
    {
        const fileName preferredPath =
            mesh.time().constant()/io.db().dbDir()/io.local()/io.name();

        // For backward-compatibility
        // check if the fvOptions file is in constant
        io.rename("fvOptions");

        if (io.headerOk())
        {
            Warning
                << indentOrNl << "Constructing " << typeName << " from "
                << io.relativeObjectPath() << " rather than "
                << preferredPath << endl;

            io.readOpt() = IOobject::MUST_READ_IF_MODIFIED;
            return io;
        }
        else
        {
            // For backward-compatibility
            // check if the fvOptions file is in system
            io.instance() = mesh.time().system();

            if (io.headerOk())
            {
                Warning
                    << indentOrNl << "Constructing " << typeName << " from "
                    << io.relativeObjectPath() << " rather than "
                    << preferredPath << endl;

                io.readOpt() = IOobject::MUST_READ_IF_MODIFIED;
                return io;
            }
            else
            {
                io.rename(typeName);
                io.readOpt() = IOobject::NO_READ;
                return io;
            }
        }
    }
}


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

void Foam::fvModels::checkApplied() const
{
    const label timeIndex =
        mesh().time().subCycling()
      ? mesh().time().prevTimeState().timeIndex()
      : mesh().time().timeIndex();

    if (timeIndex > checkTimeIndex_)
    {
        const PtrListDictionary<fvModel>& modelList(*this);

        forAll(modelList, i)
        {
            const fvModel& model = modelList[i];

            wordHashSet notAddSupFields(model.addSupFields());
            notAddSupFields -= addSupFields_[i];

            forAllConstIter(wordHashSet, notAddSupFields, iter)
            {
                WarningInFunction
                    << "Model " << model.name()
                    << " defined for field " << iter.key()
                    << " but never used" << endl;
            }
        }

        checkTimeIndex_ = timeIndex;
    }
}


// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //

Foam::fvModels::fvModels
(
    const fvMesh& mesh
)
:
    DemandDrivenMeshObject
    <
        fvMesh,
        TopoChangeableMeshObject,
        fvModels,
        IOdictionary
    >
    (
        createIOobject(mesh),
        mesh
    ),
    PtrListDictionary<fvModel>(0),
    checkTimeIndex_(mesh.time().timeIndex() + 1),
    addSupFields_()
{
    const bool readFromFvModels = IOobject::name() == typeName;

    const dictionary& dict = *this;

    // Count number of active fvModels
    label count = 0;
    forAllConstIter(dictionary, dict, iter)
    {
        if (iter().isDict())
        {
            count++;
        }
    }

    PtrListDictionary<fvModel>::setSize(count);

    addSupFields_.setSize(count);

    printDictionary print(*this);

    label i = 0;
    forAllConstIter(dictionary, dict, iter)
    {
        if (iter().isDict())
        {
            const word& name = iter().keyword();
            const dictionary& modelDict = iter().dict();

            const word modelType(modelDict.lookup("type"));

            if
            (
                readFromFvModels
             || !fvConstraint::dictionaryConstructorTablePtr_->found
                (
                    modelType
                )
            )
            {
                PtrListDictionary<fvModel>::set
                (
                    i,
                    name,
                    fvModel::New(name, mesh, modelDict).ptr()
                );

                addSupFields_.set(i, new wordHashSet());

                i++;
            }
        }
    }

    PtrListDictionary<fvModel>::setSize(i);
    addSupFields_.setSize(i);

    if (!readFromFvModels)
    {
        // If the fvOptions file was read re-name to fvModels
        rename(typeName);
    }
}


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

bool Foam::fvModels::addsSupToField(const word& fieldName) const
{
    const PtrListDictionary<fvModel>& modelList(*this);

    forAll(modelList, i)
    {
        if (modelList[i].addsSupToField(fieldName))
        {
            return true;
        }
    }

    return false;
}


Foam::scalar Foam::fvModels::maxDeltaT() const
{
    const PtrListDictionary<fvModel>& modelList(*this);

    scalar maxDeltaT = vGreat;

    forAll(modelList, i)
    {
        maxDeltaT = min(maxDeltaT, modelList[i].maxDeltaT());
    }

    return maxDeltaT;
}


void Foam::fvModels::preUpdateMesh()
{
    PtrListDictionary<fvModel>& modelList(*this);

    forAll(modelList, i)
    {
        modelList[i].preUpdateMesh();
    }
}


bool Foam::fvModels::movePoints()
{
    bool allOk = true;

    PtrListDictionary<fvModel>& modelList(*this);

    forAll(modelList, i)
    {
        allOk = allOk && modelList[i].movePoints();
    }

    return allOk;
}


void Foam::fvModels::topoChange(const polyTopoChangeMap& map)
{
    PtrListDictionary<fvModel>& modelList(*this);

    forAll(modelList, i)
    {
        modelList[i].topoChange(map);
    }
}


void Foam::fvModels::mapMesh(const polyMeshMap& map)
{
    PtrListDictionary<fvModel>& modelList(*this);

    forAll(modelList, i)
    {
        modelList[i].mapMesh(map);
    }
}


void Foam::fvModels::distribute(const polyDistributionMap& map)
{
    PtrListDictionary<fvModel>& modelList(*this);

    forAll(modelList, i)
    {
        modelList[i].distribute(map);
    }
}


bool Foam::fvModels::read()
{
    if (regIOobject::read())
    {
        checkTimeIndex_ = mesh().time().timeIndex() + 1;

        bool allOk = true;

        PtrListDictionary<fvModel>& modelList(*this);

        forAll(modelList, i)
        {
            fvModel& model = modelList[i];
            bool ok = model.read(subDict(model.name()));
            allOk = (allOk && ok);
        }
        return allOk;
    }
    else
    {
        return false;
    }
}


bool Foam::fvModels::writeObject
(
    IOstream::streamFormat fmt,
    IOstream::versionNumber ver,
    IOstream::compressionType cmp,
    const bool write
) const
{
    bool allOk = true;

    const PtrListDictionary<fvModel>& modelList(*this);

    forAll(modelList, i)
    {
        const bool ok = modelList[i].write(write);
        allOk = (allOk && ok);
    }

    return allOk;
}


void Foam::fvModels::correct()
{
    PtrListDictionary<fvModel>& modelList(*this);

    forAll(modelList, i)
    {
        modelList[i].correct();
    }
}


// * * * * * * * * * * * * * * * IOstream Operators  * * * * * * * * * * * * //

Foam::Ostream& Foam::operator<<
(
    Ostream& os,
    const fvModels& models
)
{
    models.dictionary::write(os, false);
    return os;
}


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