data/src/polyTopoChange/fvMeshSubset/fvMeshSubsetInterpolate.C

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2011-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 "fvMeshSubset.H"
#include "surfaceFields.H"
#include "internalFvsPatchField.H"
#include "internalPointPatchField.H"
#include "internalFvPatchFields.H"
#include "forwardFieldMapper.H"
#include "flipOp.H"

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

template<class Type>
Foam::tmp<Foam::VolField<Type>>
Foam::fvMeshSubset::interpolate
(
    const VolField<Type>& vf,
    const fvMesh& sMesh,
    const labelList& patchMap,
    const labelList& cellMap,
    const labelList& faceMap
)
{
    // 1. Create the complete field with dummy patch fields
    PtrField<fvPatchField<Type>> patchFields(patchMap.size());

    forAll(patchFields, patchi)
    {
        // Set the first one by hand as it corresponds to the
        // exposed internal faces. Additional interpolation can be put here
        // as necessary.
        if (patchMap[patchi] == -1)
        {
            patchFields.set
            (
                patchi,
                new internalFvPatchField<Type>
                (
                    sMesh.boundary()[patchi],
                    DimensionedField<Type, fvMesh>::null()
                )
            );
        }
        else
        {
            patchFields.set
            (
                patchi,
                fvPatchField<Type>::New
                (
                    calculatedFvPatchField<Type>::typeName,
                    sMesh.boundary()[patchi],
                    DimensionedField<Type, fvMesh>::null()
                )
            );
        }
    }

    tmp<VolField<Type>> tresF
    (
        new VolField<Type>
        (
            IOobject
            (
                "subset"+vf.name(),
                sMesh.time().name(),
                sMesh,
                IOobject::NO_READ,
                IOobject::NO_WRITE,
                false
            ),
            sMesh,
            vf.dimensions(),
            Field<Type>(vf.primitiveField(), cellMap),
            patchFields
        )
    );
    VolField<Type>& resF = tresF.ref();


    // 2. Change the fvPatchFields to the correct type using a mapper
    //  constructor (with reference to the now correct internal field)

    typename VolField<Type>::BoundaryField& bf = resF.boundaryFieldRef();

    forAll(bf, patchi)
    {
        if (patchMap[patchi] != -1)
        {
            // Construct addressing
            const fvPatch& subPatch = sMesh.boundary()[patchi];
            const fvPatch& basePatch = vf.mesh().boundary()[patchMap[patchi]];
            const label baseStart = basePatch.start();
            const label baseSize = basePatch.size();

            labelList directAddressing(subPatch.size());

            forAll(directAddressing, i)
            {
                const label baseFacei = faceMap[subPatch.start() + i];

                if (baseFacei >= baseStart && baseFacei < baseStart+baseSize)
                {
                    directAddressing[i] = baseFacei-baseStart;
                }
                else
                {
                    // Mapped from internal face. Do what? Leave up to
                    // fvPatchField
                    directAddressing[i] = -1;
                }
            }

            bf.set
            (
                patchi,
                fvPatchField<Type>::New
                (
                    vf.boundaryField()[patchMap[patchi]],
                    subPatch,
                    resF(),
                    forwardFieldMapper(directAddressing)
                )
            );
        }
    }

    return tresF;
}


template<class Type>
Foam::tmp<Foam::VolField<Type>>
Foam::fvMeshSubset::interpolate
(
    const VolField<Type>& vf
) const
{
    return interpolate
    (
        vf,
        subMesh(),
        patchMap(),
        cellMap(),
        faceMap()
    );
}


template<class Type>
Foam::tmp<Foam::SurfaceField<Type>>
Foam::fvMeshSubset::interpolate
(
    const SurfaceField<Type>& sf,
    const fvMesh& sMesh,
    const labelList& patchMap,
    const labelList& cellMap,
    const labelList& faceMap
)
{
    const bool negateIfFlipped = isFlux(sf);

    // 1. Create the complete field with dummy patch fields
    PtrField<fvsPatchField<Type>> patchFields(patchMap.size());

    forAll(patchFields, patchi)
    {
        // Set the first one by hand as it corresponds to the
        // exposed internal faces. Additional interpolation can be put here
        // as necessary.
        if (patchMap[patchi] == -1)
        {
            patchFields.set
            (
                patchi,
                new internalFvsPatchField<Type>
                (
                    sMesh.boundary()[patchi],
                    DimensionedField<Type, surfaceMesh>::null()
                )
            );
        }
        else
        {
            patchFields.set
            (
                patchi,
                fvsPatchField<Type>::New
                (
                    calculatedFvsPatchField<Type>::typeName,
                    sMesh.boundary()[patchi],
                    DimensionedField<Type, surfaceMesh>::null()
                )
            );
        }
    }

    // Create the complete field from the pieces
    tmp<SurfaceField<Type>> tresF
    (
        new SurfaceField<Type>
        (
            IOobject
            (
                "subset"+sf.name(),
                sMesh.time().name(),
                sMesh,
                IOobject::NO_READ,
                IOobject::NO_WRITE,
                false
            ),
            sMesh,
            sf.dimensions(),
            Field<Type>
            (
                sf.primitiveField(),
                SubList<label>
                (
                    faceMap,
                    sMesh.nInternalFaces()
                )
            ),
            patchFields
        )
    );
    SurfaceField<Type>& resF = tresF.ref();

    // 2. Change the fvsPatchFields to the correct type using a mapper
    //  constructor (with reference to the now correct internal field)

    typename SurfaceField<Type>::BoundaryField& bf = resF.boundaryFieldRef();

    forAll(bf, patchi)
    {
        const fvPatch& subPatch = sMesh.boundary()[patchi];

        labelList directAddressing(subPatch.size(), -1);

        if (patchMap[patchi] != -1)
        {
            // Construct addressing
            const fvPatch& basePatch = sf.mesh().boundary()[patchMap[patchi]];
            const label baseStart = basePatch.start();
            const label baseSize = basePatch.size();

            forAll(directAddressing, i)
            {
                const label baseFacei = faceMap[subPatch.start() + i];

                if (baseFacei >= baseStart && baseFacei < baseStart+baseSize)
                {
                    directAddressing[i] = baseFacei-baseStart;
                }
            }

            bf.set
            (
                patchi,
                fvsPatchField<Type>::New
                (
                    sf.boundaryField()[patchMap[patchi]],
                    subPatch,
                    resF(),
                    forwardFieldMapper(directAddressing)
                )
            );
        }

        // Map internal face values onto the patch elected to hold
        // the exposed faces
        const polyMesh& mesh = sf.mesh()();
        fvsPatchField<Type>& pfld = bf[patchi];
        const labelUList& fc = bf[patchi].patch().faceCells();
        const labelList& own = mesh.faceOwner();

        forAll(pfld, i)
        {
            const label baseFacei = faceMap[subPatch.start() + i];

            if (directAddressing[i] == -1)
            {
                if (mesh.isInternalFace(baseFacei))
                {
                    const Type val = sf.internalField()[baseFacei];

                    if (cellMap[fc[i]] == own[baseFacei] || !negateIfFlipped)
                    {
                        pfld[i] = val;
                    }
                    else
                    {
                        pfld[i] = flipOp()(val);
                    }
                }
                else
                {
                    const label basePatchi =
                        mesh.boundary().patchIndices()
                        [baseFacei - mesh.nInternalFaces()];
                    const label basePatchFacei =
                        mesh.boundary()[basePatchi]
                       .whichFace(baseFacei);

                    pfld[i] = sf.boundaryField()[basePatchi][basePatchFacei];
                }
            }
        }
    }

    return tresF;
}


template<class Type>
Foam::tmp<Foam::SurfaceField<Type>>
Foam::fvMeshSubset::interpolate
(
    const SurfaceField<Type>& sf
) const
{
    return interpolate
    (
        sf,
        subMesh(),
        patchMap(),
        cellMap(),
        faceMap()
    );
}


template<class Type>
Foam::tmp<Foam::PointField<Type>>
Foam::fvMeshSubset::interpolate
(
    const PointField<Type>& pf,
    const pointMesh& sMesh,
    const labelList& patchMap,
    const labelList& pointMap
)
{
    // 1. Create the complete field with dummy patch fields
    PtrField<pointPatchField<Type>> patchFields(patchMap.size());

    forAll(patchFields, patchi)
    {
        // Set the first one by hand as it corresponds to the
        // exposed internal faces.  Additional interpolation can be put here
        // as necessary.
        if (patchMap[patchi] == -1)
        {
            patchFields.set
            (
                patchi,
                new internalPointPatchField<Type>
                (
                    sMesh.boundary()[patchi],
                    DimensionedField<Type, pointMesh>::null()
                )
            );
        }
        else
        {
            patchFields.set
            (
                patchi,
                pointPatchField<Type>::New
                (
                    calculatedPointPatchField<Type>::typeName,
                    sMesh.boundary()[patchi],
                    DimensionedField<Type, pointMesh>::null()
                )
            );
        }
    }

    // Create the complete field from the pieces
    tmp<PointField<Type>> tresF
    (
        new PointField<Type>
        (
            IOobject
            (
                "subset"+pf.name(),
                sMesh.time().name(),
                sMesh.db(),
                IOobject::NO_READ,
                IOobject::NO_WRITE,
                false
            ),
            sMesh,
            pf.dimensions(),
            Field<Type>(pf.primitiveField(), pointMap),
            patchFields
        )
    );
    PointField<Type>& resF = tresF.ref();


    // 2. Change the pointPatchFields to the correct type using a mapper
    //  constructor (with reference to the now correct internal field)

    typename PointField<Type>::BoundaryField& bf = resF.boundaryFieldRef();

    forAll(bf, patchi)
    {
        // Set the first one by hand as it corresponds to the
        // exposed internal faces.  Additional interpolation can be put here
        // as necessary.
        if (patchMap[patchi] != -1)
        {
            // Construct addressing
            const pointPatch& basePatch =
                pf.mesh().boundary()[patchMap[patchi]];

            const labelList& meshPoints = basePatch.meshPoints();

            // Make addressing from mesh to patch point
            Map<label> meshPointMap(2*meshPoints.size());
            forAll(meshPoints, localI)
            {
                meshPointMap.insert(meshPoints[localI], localI);
            }

            // Find which subpatch points originate from which patch point
            const pointPatch& subPatch = sMesh.boundary()[patchi];
            const labelList& subMeshPoints = subPatch.meshPoints();

            // If mapped from outside patch leave handling up to patchField
            labelList directAddressing(subPatch.size(), -1);

            forAll(subMeshPoints, localI)
            {
                // Get mesh point on original mesh.
                label meshPointi = pointMap[subMeshPoints[localI]];

                Map<label>::const_iterator iter = meshPointMap.find(meshPointi);

                if (iter != meshPointMap.end())
                {
                    directAddressing[localI] = iter();
                }
            }

            bf.set
            (
                patchi,
                pointPatchField<Type>::New
                (
                    pf.boundaryField()[patchMap[patchi]],
                    subPatch,
                    resF(),
                    forwardFieldMapper(directAddressing)
                )
            );
        }
    }

    return tresF;
}


template<class Type>
Foam::tmp<Foam::PointField<Type>>
Foam::fvMeshSubset::interpolate
(
    const PointField<Type>& sf
) const
{
    return interpolate
    (
        sf,
        pointMesh::New(subMesh()),     // subsetted point mesh
        patchMap(),
        pointMap()
    );
}


template<class Type>
Foam::tmp<Foam::DimensionedField<Type, Foam::fvMesh>>
Foam::fvMeshSubset::interpolate
(
    const DimensionedField<Type, fvMesh>& df,
    const fvMesh& sMesh,
    const labelList& cellMap
)
{
    // Create the complete field from the pieces
    tmp<DimensionedField<Type, fvMesh>> tresF
    (
        new DimensionedField<Type, fvMesh>
        (
            IOobject
            (
                "subset"+df.name(),
                sMesh.time().name(),
                sMesh,
                IOobject::NO_READ,
                IOobject::NO_WRITE
            ),
            sMesh,
            df.dimensions(),
            Field<Type>(df, cellMap)
        )
    );

    return tresF;
}


template<class Type>
Foam::tmp<Foam::DimensionedField<Type, Foam::fvMesh>>
Foam::fvMeshSubset::interpolate
(
    const DimensionedField<Type, fvMesh>& df
) const
{
    return interpolate(df, subMesh(), cellMap());
}


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