data/src/finiteVolume/fvMeshToFvMesh/fvMeshToFvMeshTemplates.C

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2022-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 "fvMeshToFvMesh.H"
#include "setSizeFieldMapper.H"
#include "identityFieldMapper.H"
#include "patchToPatchLeftOverFieldMapper.H"
#include "patchToPatchNormalisedFieldMapper.H"

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

template<class Type>
void Foam::fvMeshToFvMesh::evaluateConstraintTypes(VolField<Type>& fld)
{
    typename VolField<Type>::BoundaryField& fldBf = fld.boundaryFieldRef();

    if
    (
        Pstream::defaultCommsType == Pstream::commsTypes::blocking
     || Pstream::defaultCommsType == Pstream::commsTypes::nonBlocking
    )
    {
        label nReq = Pstream::nRequests();

        forAll(fldBf, patchi)
        {
            fvPatchField<Type>& tgtField = fldBf[patchi];

            if
            (
                tgtField.type() == tgtField.patch().poly().type()
             && tgtField.patch().poly().constraint()
            )
            {
                tgtField.initEvaluate(Pstream::defaultCommsType);
            }
        }

        // Block for any outstanding requests
        if
        (
            Pstream::parRun()
         && Pstream::defaultCommsType == Pstream::commsTypes::nonBlocking
        )
        {
            Pstream::waitRequests(nReq);
        }

        forAll(fldBf, patchi)
        {
            fvPatchField<Type>& tgtField = fldBf[patchi];

            if
            (
                tgtField.type() == tgtField.patch().poly().type()
             && tgtField.patch().poly().constraint()
            )
            {
                tgtField.evaluate(Pstream::defaultCommsType);
            }
        }
    }
    else if (Pstream::defaultCommsType == Pstream::commsTypes::scheduled)
    {
        const lduSchedule& patchSchedule =
            fld.mesh().globalData().patchSchedule();

        forAll(patchSchedule, patchEvali)
        {
            label patchi = patchSchedule[patchEvali].patch;
            fvPatchField<Type>& tgtField = fldBf[patchi];

            if
            (
                tgtField.type() == tgtField.patch().poly().type()
             && tgtField.patch().poly().constraint()
            )
            {
                if (patchSchedule[patchEvali].init)
                {
                    tgtField.initEvaluate(Pstream::commsTypes::scheduled);
                }
                else
                {
                    tgtField.evaluate(Pstream::commsTypes::scheduled);
                }
            }
        }
    }
}


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

template<class Type>
Foam::tmp<Foam::VolField<Type>> Foam::fvMeshToFvMesh::srcToTgt
(
    const VolField<Type>& srcFld
) const
{
    // Construct target patch fields as copies of source patch fields, but do
    // not map values yet
    PtrField<fvPatchField<Type>> tgtPatchFields(tgtMesh_.boundary().size());
    forAll(patchIndices(), i)
    {
        const label srcPatchi = patchIndices()[i].first();
        const label tgtPatchi = patchIndices()[i].second();

        if (!tgtPatchFields.set(tgtPatchi))
        {
            tgtPatchFields.set
            (
                tgtPatchi,
                fvPatchField<Type>::New
                (
                    srcFld.boundaryField()[srcPatchi],
                    tgtMesh_.boundary()[tgtPatchi],
                    DimensionedField<Type, fvMesh>::null(),
                    setSizeFieldMapper(tgtMesh_.boundary()[tgtPatchi].size())
                )
            );
        }
    }

    // Create calculated patch fields for any unset target patches. Use
    // fvPatchField<Type>::New to construct these, rather than using the
    // calculated constructor directly, so that constraints are maintained.
    labelList tgtPatchFieldIsUnMapped(tgtPatchFields.size(), false);
    forAll(tgtPatchFields, tgtPatchi)
    {
        if (!tgtPatchFields.set(tgtPatchi))
        {
            tgtPatchFields.set
            (
                tgtPatchi,
                fvPatchField<Type>::New
                (
                    calculatedFvPatchField<Type>::typeName,
                    tgtMesh_.boundary()[tgtPatchi],
                    DimensionedField<Type, fvMesh>::null()
                )
            );

            tgtPatchFieldIsUnMapped[tgtPatchi] =
                tgtMesh_.boundary()[tgtPatchi].poly().constraint();
        }
    }

    // Construct the result field
    tmp<VolField<Type>> ttgtFld =
        VolField<Type>::New
        (
            typedName("interpolate(" + srcFld.name() + ")"),
            srcToTgt<Type>(srcFld.internalField())(),
            tgtPatchFields
        );
    typename VolField<Type>::BoundaryField& tgtBfld =
        ttgtFld.ref().boundaryFieldRef();

    // Mapped patches
    forAll(patchIndices(), i)
    {
        const label srcPatchi = patchIndices()[i].first();
        const label tgtPatchi = patchIndices()[i].second();

        tgtBfld[tgtPatchi].map
        (
            srcFld.boundaryField()[srcPatchi],
            patchToPatchNormalisedFieldMapper
            (
                patchInterpolation(i),
                tgtPatchExtrapolation(i)
            )
        );
    }

    // Un-mapped patches. Set values to that of the internal cell field.
    forAll(tgtBfld, patchi)
    {
        if (tgtPatchFieldIsUnMapped[patchi])
        {
            fvPatchField<Type>& tgtPfld = tgtBfld[patchi];
            tgtPfld == tgtPfld.patchInternalField();
        }
    }

    // Evaluate constraints
    evaluateConstraintTypes(ttgtFld.ref());

    return ttgtFld;
}


template<class Type>
Foam::tmp<Foam::VolField<Type>> Foam::fvMeshToFvMesh::srcToTgt
(
    const VolField<Type>& srcFld,
    const VolField<Type>& leftOverTgtFld,
    const UList<wordRe>& tgtCuttingPatchNames
) const
{
    // Construct the result field
    tmp<VolField<Type>> ttgtFld =
        VolField<Type>::New
        (
            typedName("interpolate(" + srcFld.name() + ")"),
            srcToTgt<Type>(srcFld(), leftOverTgtFld())(),
            leftOverTgtFld.boundaryField()
        );
    typename VolField<Type>::BoundaryField& tgtBfld =
        ttgtFld.ref().boundaryFieldRef();

    // Mapped patches
    forAll(patchIndices(), i)
    {
        const label srcPatchi = patchIndices()[i].first();
        const label tgtPatchi = patchIndices()[i].second();

        tgtBfld[tgtPatchi].map
        (
            leftOverTgtFld.boundaryField()[tgtPatchi],
            identityFieldMapper()
        );
        tgtBfld[tgtPatchi].map
        (
            srcFld.boundaryField()[srcPatchi],
            patchToPatchLeftOverFieldMapper(patchInterpolation(i))
        );
    }

    // Cutting patches. Set values to that of the internal cell field.
    const labelHashSet tgtCuttingPatchIDs =
        leftOverTgtFld.mesh().poly().boundary().patchSet(tgtCuttingPatchNames);
    forAllConstIter(labelHashSet, tgtCuttingPatchIDs, iter)
    {
        tgtBfld[iter.key()] == tgtBfld[iter.key()].patchInternalField();
    }

    // Evaluate constraints
    evaluateConstraintTypes(ttgtFld.ref());

    return ttgtFld;
}


template<class Type>
Foam::tmp<Foam::VolInternalField<Type>> Foam::fvMeshToFvMesh::srcToTgt
(
    const VolInternalField<Type>& srcFld
) const
{
    tmp<VolInternalField<Type>> ttgtFld =
        VolInternalField<Type>::New
        (
            typedName("interpolate(" + srcFld.name() + ")"),
            tgtMesh_,
            srcFld.dimensions(),
            cellsInterpolation().srcToTgt(srcFld)
        );

    tgtCellsExtrapolation().extrapolate(ttgtFld.ref());

    return ttgtFld;
}


template<class Type>
Foam::tmp<Foam::VolInternalField<Type>> Foam::fvMeshToFvMesh::srcToTgt
(
    const VolInternalField<Type>& srcFld,
    const VolInternalField<Type>& leftOverTgtFld
) const
{
    return
        VolInternalField<Type>::New
        (
            typedName("interpolate(" + srcFld.name() + ")"),
            tgtMesh_,
            leftOverTgtFld.dimensions(),
            cellsInterpolation().srcToTgt(srcFld, leftOverTgtFld)
        );
}


template<class Type>
Foam::tmp<Foam::fvMeshToFvMesh::SurfaceFieldBoundary<Type>>
Foam::fvMeshToFvMesh::srcToTgt
(
    const SurfaceFieldBoundary<Type>& srcBfld
) const
{
    // Map all patch fields
    PtrField<fvsPatchField<Type>> tgtPatchFields(tgtMesh_.boundary().size());
    forAll(patchIndices(), i)
    {
        const label srcPatchi = patchIndices()[i].first();
        const label tgtPatchi = patchIndices()[i].second();

        if (!tgtPatchFields.set(tgtPatchi))
        {
            tgtPatchFields.set
            (
                tgtPatchi,
                fvsPatchField<Type>::New
                (
                    srcBfld[srcPatchi],
                    tgtMesh_.boundary()[tgtPatchi],
                    DimensionedField<Type, surfaceMesh>::null(),
                    patchToPatchNormalisedFieldMapper
                    (
                        patchInterpolation(i),
                        tgtPatchExtrapolation(i)
                    )
                )
            );
        }
    }

    // Create any patch fields not explicitly mapped; e.g., constraints
    forAll(tgtPatchFields, tgtPatchi)
    {
        if (!tgtPatchFields.set(tgtPatchi))
        {
            tgtPatchFields.set
            (
                tgtPatchi,
                fvsPatchField<Type>::New
                (
                    calculatedFvPatchField<Type>::typeName,
                    tgtMesh_.boundary()[tgtPatchi],
                    DimensionedField<Type, surfaceMesh>::null()
                )
            );
        }
    }

    return
        tmp<SurfaceFieldBoundary<Type>>
        (
            new SurfaceFieldBoundary<Type>
            (
                tgtMesh_.boundary(),
                DimensionedField<Type, surfaceMesh>::null(),
                tgtPatchFields
            )
        );
}


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