combinePatchFaces.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-2025 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/>.
 
Application
    combinePatchFaces
 
Description
    Checks for multiple patch faces on same cell and combines them.
    Multiple patch faces can result from e.g. removal of refined
    neighbouring cells, leaving 4 exposed faces with same owner.
 
    Rules for merging:
    - only boundary faces (since multiple internal faces between two cells
      not allowed anyway)
    - faces have to have same owner
    - faces have to be connected via edge which are not features (so angle
      between them < feature angle)
    - outside of faces has to be single loop
    - outside of face should not be (or just slightly) concave (so angle
      between consecutive edges < concaveangle
 
    E.g. to allow all faces on same patch to be merged:
 
        combinePatchFaces 180 -concaveAngle 90
 
\*---------------------------------------------------------------------------*/
 
#include "PstreamReduceOps.H"
#include "argList.H"
#include "Time.H"
#include "polyTopoChange.H"
#include "combineFaces.H"
#include "removePoints.H"
#include "meshCheck.H"
#include "polyTopoChangeMap.H"
 
using namespace Foam;
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
// Merge faces on the same patch (usually from exposing refinement)
// Can undo merges if these cause problems.
label mergePatchFaces
(
    const scalar minCos,
    const scalar concaveSin,
    const autoPtr<IOdictionary>& qualDictPtr,
    const Time& runTime,
    polyMesh& mesh
)
{
    // Patch face merging engine
    combineFaces faceCombiner(mesh);
 
    // Get all sets of faces that can be merged
    labelListList allFaceSets(faceCombiner.getMergeSets(minCos, concaveSin));
 
    label nFaceSets = returnReduce(allFaceSets.size(), sumOp<label>());
 
    Info<< "Merging " << nFaceSets << " sets of faces." << endl;
 
    if (nFaceSets > 0)
    {
        // Store the faces of the face sets
        List<faceList> allFaceSetsFaces(allFaceSets.size());
        forAll(allFaceSets, setI)
        {
            allFaceSetsFaces[setI] = UIndirectList<face>
            (
                mesh.faces(),
                allFaceSets[setI]
            );
        }
 
        autoPtr<polyTopoChangeMap> map;
        {
            // Topology changes container
            polyTopoChange meshMod(mesh);
 
            // Merge all faces of a set into the first face of the set.
            faceCombiner.setRefinement(allFaceSets, meshMod);
 
            // Change the mesh
            map = meshMod.changeMesh(mesh, true);
 
            // Update fields
            mesh.topoChange(map);
        }
 
 
        // Check for errors and undo
        // ~~~~~~~~~~~~~~~~~~~~~~~~~
 
        // Faces in error.
        labelHashSet errorFaces;
 
        if (qualDictPtr.valid())
        {
            meshCheck::checkMesh(false, mesh, qualDictPtr(), errorFaces);
        }
        else
        {
            meshCheck::checkFacePyramids(mesh, false, -small, &errorFaces);
        }
 
        // Sets where the master is in error
        labelHashSet errorSets;
 
        forAll(allFaceSets, setI)
        {
            label newMasterI = map().reverseFaceMap()[allFaceSets[setI][0]];
 
            if (errorFaces.found(newMasterI))
            {
                errorSets.insert(setI);
            }
        }
        label nErrorSets = returnReduce(errorSets.size(), sumOp<label>());
 
        Info<< "Detected " << nErrorSets
            << " error faces on boundaries that have been merged."
            << " These will be restored to their original faces."
            << endl;
 
        if (nErrorSets > 0)
        {
            // Renumber stored faces to new vertex numbering.
            forAllConstIter(labelHashSet, errorSets, iter)
            {
                label setI = iter.key();
 
                faceList& setFaceVerts = allFaceSetsFaces[setI];
 
                forAll(setFaceVerts, i)
                {
                    inplaceRenumber(map().reversePointMap(), setFaceVerts[i]);
 
                    // Debug: check that all points are still there.
                    forAll(setFaceVerts[i], j)
                    {
                        label newVertI = setFaceVerts[i][j];
 
                        if (newVertI < 0)
                        {
                            FatalErrorInFunction
                                << "In set:" << setI << " old face labels:"
                                << allFaceSets[setI] << " new face vertices:"
                                << setFaceVerts[i] << " are unmapped vertices!"
                                << abort(FatalError);
                        }
                    }
                }
            }
 
 
            // Topology changes container
            polyTopoChange meshMod(mesh);
 
 
            // Restore faces
            forAllConstIter(labelHashSet, errorSets, iter)
            {
                label setI = iter.key();
 
                const labelList& setFaces = allFaceSets[setI];
                const faceList& setFaceVerts = allFaceSetsFaces[setI];
 
                label newMasterI = map().reverseFaceMap()[setFaces[0]];
 
                // Restore. Get face properties.
 
                label own = mesh.faceOwner()[newMasterI];
                label patchID = mesh.boundaryMesh().whichPatch(newMasterI);
 
                Pout<< "Restoring new master face " << newMasterI
                    << " to vertices " << setFaceVerts[0] << endl;
 
                // Modify the master face.
                meshMod.modifyFace
                (
                    setFaceVerts[0],                // original face
                    newMasterI,                     // label of face
                    own,                            // owner
                    -1,                             // neighbour
                    false,                          // face flip
                    patchID                         // patch for face
                );
 
                // Add the previously removed faces
                for (label i = 1; i < setFaces.size(); i++)
                {
                    Pout<< "Restoring removed face " << setFaces[i]
                        << " with vertices " << setFaceVerts[i] << endl;
 
                    meshMod.addFace
                    (
                        setFaceVerts[i],        // vertices
                        own,                    // owner,
                        -1,                     // neighbour,
                        newMasterI,             // masterFaceID,
                        false,                  // flipFaceFlux,
                        patchID                 // patchID,
                    );
                }
            }
 
            // Change the mesh
            map = meshMod.changeMesh(mesh, true);
 
            // Update fields
            mesh.topoChange(map);
        }
    }
    else
    {
        Info<< "No faces merged ..." << endl;
    }
 
    return nFaceSets;
}
 
 
// Remove points not used by any face or points used by only two faces where
// the edges are in line
label mergeEdges(const scalar minCos, polyMesh& mesh)
{
    Info<< "Merging all points on surface that" << nl
        << "- are used by only two boundary faces and" << nl
        << "- make an angle with a cosine of more than " << minCos
        << "." << nl << endl;
 
    // Point removal analysis engine
    removePoints pointRemover(mesh);
 
    // Count usage of points
    boolList pointCanBeDeleted;
    label nRemove = pointRemover.countPointUsage(minCos, pointCanBeDeleted);
 
    if (nRemove > 0)
    {
        Info<< "Removing " << nRemove
            << " straight edge points ..." << endl;
 
        // Topology changes container
        polyTopoChange meshMod(mesh);
 
        pointRemover.setRefinement(pointCanBeDeleted, meshMod);
 
        // Change the mesh
        autoPtr<polyTopoChangeMap> map = meshMod.changeMesh(mesh);
 
        // Update fields
        mesh.topoChange(map);
    }
    else
    {
        Info<< "No straight edges simplified and no points removed ..." << endl;
    }
 
    return nRemove;
}
 
 
 
int main(int argc, char *argv[])
{
    #include "addNoOverwriteOption.H"
 
    argList::validArgs.append("featureAngle [0..180]");
    argList::addOption
    (
        "concaveAngle",
        "degrees",
        "specify concave angle [0..180] (default: 30 degrees)"
    );
    argList::addBoolOption
    (
        "meshQuality",
        "read user-defined mesh quality criterions from system/meshQualityDict"
    );
 
    #include "setRootCase.H"
    #include "createTimeNoFunctionObjects.H"
    #include "createPolyMesh.H"
    const word oldInstance = mesh.pointsInstance();
 
    const scalar featureAngle = degToRad(args.argRead<scalar>(1));
    const scalar minCos = Foam::cos(featureAngle);
 
    // Sin of angle between two consecutive edges on a face.
    // If sin(angle) larger than this the face will be considered concave.
    const scalar concaveAngle =
        degToRad(args.optionLookupOrDefault("concaveAngle", 30.0));
    const scalar concaveSin = Foam::sin(concaveAngle);
 
    #include "setNoOverwrite.H"
    const bool meshQuality = args.optionFound("meshQuality");
 
    Info<< "Merging all faces of a cell" << nl
        << "    - which are on the same patch" << nl
        << "    - which make an angle < " << radToDeg(featureAngle)
        << " degrees" << nl
        << "      (cos:" << minCos << ')' << nl
        << "    - even when resulting face becomes concave by more than "
        << radToDeg(concaveAngle) << " degrees" << nl
        << "      (sin:" << concaveSin << ')' << nl
        << endl;
 
    autoPtr<IOdictionary> qualDict;
    if (meshQuality)
    {
        Info<< "Enabling user-defined geometry checks." << nl << endl;
 
        qualDict.reset
        (
            new IOdictionary
            (
                IOobject
                (
                    "meshQualityDict",
                    mesh.time().system(),
                    mesh,
                    IOobject::MUST_READ,
                    IOobject::NO_WRITE
                )
           )
        );
    }
 
 
    if (!overwrite)
    {
        runTime++;
    }
 
 
 
    // Merge faces on same patch
    label nChanged = mergePatchFaces
    (
        minCos,
        concaveSin,
        qualDict,
        runTime,
        mesh
    );
 
    // Merge points on straight edges and remove unused points
    if (qualDict.valid())
    {
        Info<< "Merging all 'loose' points on surface edges, "
            << "regardless of the angle they make." << endl;
 
        // Surface bnound to be used to extrude. Merge all loose points.
        nChanged += mergeEdges(-1, mesh);
    }
    else
    {
        nChanged += mergeEdges(minCos, mesh);
    }
 
    if (nChanged > 0)
    {
        if (overwrite)
        {
            mesh.setInstance(oldInstance);
        }
 
        Info<< "Writing morphed mesh to time " << runTime.name() << endl;
 
        mesh.write();
    }
    else
    {
        Info<< "Mesh unchanged." << endl;
    }
 
    Info<< "\nEnd\n" << endl;
 
    return 0;
}
 
 
// ************************************************************************* //