data/src/OpenFOAM/meshes/polyMesh/polyMeshIO.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 "polyMesh.H"
#include "Time.H"
#include "cellIOList.H"
#include "zonesGenerator.H"
#include "OSspecific.H"
#include "polyTopoChangeMap.H"

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

void Foam::polyMesh::setPointsWrite(const Foam::IOobject::writeOption wo)
{
    points_.writeOpt() = wo;

    if (tetBasePtIsPtr_.valid())
    {
        tetBasePtIsPtr_->writeOpt() = wo;
    }
}


void Foam::polyMesh::setTopologyWrite(const Foam::IOobject::writeOption wo)
{
    setPointsWrite(wo);

    faces_.writeOpt() = wo;
    owner_.writeOpt() = wo;
    neighbour_.writeOpt() = wo;
    boundary_.writeOpt() = wo;

    if (pointZones_.noTopoUpdate())
    {
        pointZones_.writeOpt() = wo;
    }

    if (faceZones_.noTopoUpdate())
    {
        faceZones_.writeOpt() = wo;
    }

    if (cellZones_.noTopoUpdate())
    {
        cellZones_.writeOpt() = wo;
    }
}


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

bool Foam::polyMesh::readUpdateIsForward() const
{
    return instant(instance()).value() < time().value();
}


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

void Foam::polyMesh::setPointsInstance(const fileName& inst)
{
    DebugInFunction << "Resetting points instance to " << inst << endl;

    instance() = inst;

    points_.instance() = inst;
    points_.eventNo() = getEvent();

    if (tetBasePtIsPtr_.valid())
    {
        tetBasePtIsPtr_->instance() = inst;
        tetBasePtIsPtr_().eventNo() = getEvent();
    }

    setPointsWrite(IOobject::AUTO_WRITE);
}


void Foam::polyMesh::setInstance(const fileName& inst)
{
    DebugInFunction << "Resetting topology instance to " << inst << endl;

    setPointsInstance(inst);

    faces_.instance() = inst;
    owner_.instance() = inst;
    neighbour_.instance() = inst;
    boundary_.instance() = inst;

    if (pointZones_.noTopoUpdate())
    {
        pointZones_.instance() = inst;
    }

    if (faceZones_.noTopoUpdate())
    {
        faceZones_.instance() = inst;
    }

    if (cellZones_.noTopoUpdate())
    {
        cellZones_.instance() = inst;
    }

    setTopologyWrite(IOobject::AUTO_WRITE);
}


Foam::polyMesh::readUpdateState Foam::polyMesh::readUpdate()
{
    // Determine if this update moves forward in time. If so, searching back in
    // time for data files will only go back as far as the previous instance.
    const fileName instance0 = instance();
    const bool forward = readUpdateIsForward();

    // Update the mesh instance
    instance() = time().name();

    DebugInFunction << "Updating the polyMesh:" << endl;

    polyMesh::readUpdateState state = polyMesh::UNCHANGED;

    // Find the points and faces instance
    const fileName pointsInst
    (
        time().findInstance
        (
            meshDir(),
            "points",
            IOobject::READ_IF_PRESENT,
            forward ? word(instance0) : word::null
        )
    );
    const fileName facesInst
    (
        time().findInstance
        (
            meshDir(),
            "faces",
            IOobject::READ_IF_PRESENT,
            forward ? word(instance0) : word::null
        )
    );

    DebugInfo
        << "    Faces instance: old = " << facesInstance()
        << ", new = " << facesInst << nl
        << "    Points instance: old = " << pointsInstance()
        << ", new = " << pointsInst << endl;

    if (facesInst != (forward ? instance0 : facesInstance()))
    {
        // Topological change
        DebugInfo << "    Topological change" << endl;

        clearOut();

        // Clear all DeletableMeshObjects
        meshObjects::clearAll<polyMesh, DeletableMeshObject>(*this);

        points_ = pointIOField
        (
            IOobject
            (
                "points",
                pointsInst,
                meshSubDir,
                *this,
                IOobject::MUST_READ,
                IOobject::NO_WRITE,
                false
            )
        );

        points_.instance() = pointsInst;

        faces_ = faceCompactIOList
        (
            IOobject
            (
                "faces",
                facesInst,
                meshSubDir,
                *this,
                IOobject::MUST_READ,
                IOobject::NO_WRITE,
                false
            )
        );

        faces_.instance() = facesInst;

        owner_ = labelIOList
        (
            IOobject
            (
                "owner",
                facesInst,
                meshSubDir,
                *this,
                IOobject::READ_IF_PRESENT,
                IOobject::NO_WRITE,
                false
            )
        );

        owner_.instance() = facesInst;

        neighbour_ = labelIOList
        (
            IOobject
            (
                "neighbour",
                facesInst,
                meshSubDir,
                *this,
                IOobject::READ_IF_PRESENT,
                IOobject::NO_WRITE,
                false
            )
        );

        neighbour_.instance() = facesInst;

        // Reset the boundary patches
        polyBoundaryMesh newBoundary
        (
            IOobject
            (
                "boundary",
                facesInst,
                meshSubDir,
                *this,
                IOobject::MUST_READ,
                IOobject::NO_WRITE,
                false
            ),
            *this
        );

        // Determine whether patch types and names have changed
        bool boundaryChanged = false;
        if (newBoundary.size() != boundary_.size())
        {
            boundaryChanged = true;
        }
        else
        {
            forAll(boundary_, patchi)
            {
                if
                (
                    boundary_[patchi].type() != newBoundary[patchi].type()
                 || boundary_[patchi].name() != newBoundary[patchi].name()
                )
                {
                    boundaryChanged = true;
                    break;
                }
            }
        }
        reduce(boundaryChanged, orOp());

        if (boundaryChanged)
        {
            boundary_.clear();
            boundary_.setSize(newBoundary.size());

            forAll(newBoundary, patchi)
            {
                boundary_.set
                (
                    patchi,
                    newBoundary[patchi].clone(boundary_)
                );
            }
        }
        else
        {
            forAll(boundary_, patchi)
            {
                boundary_[patchi].reset
                (
                    newBoundary[patchi].size(),
                    newBoundary[patchi].start()
                );
            }
        }

        boundary_.instance() = facesInst;


        // Boundary is set so can use initMesh now (uses boundary_ to
        // determine internal and active faces)

        if (!owner_.headerClassName().empty())
        {
            initMesh();
        }
        else
        {
            cellCompactIOList cells
            (
                IOobject
                (
                    "cells",
                    facesInst,
                    meshSubDir,
                    *this,
                    IOobject::MUST_READ,
                    IOobject::NO_WRITE,
                    false
                )
            );

            // Recalculate the owner/neighbour addressing and reset the
            // primitiveMesh
            initMesh(cells);
        }


        // Even if number of patches stayed same still recalculate boundary
        // data.

        // Calculate topology for the patches (processor-processor comms etc.)
        boundary_.topoChange();

        // Calculate the geometry for the patches (transformation tensors etc.)
        boundary_.calcGeometry();

        // Derived info
        bounds_ = boundBox(points_);
        geometricD_ = Zero;
        solutionD_ = Zero;

        // Re-read tet base points
        tetBasePtIsPtr_ = readTetBasePtIs();

        // Update any generated zones
        polyTopoChangeMap map(*this);
        pointZones_.topoChange(map);
        faceZones_.topoChange(map);
        cellZones_.topoChange(map);

        if (boundaryChanged)
        {
            state = polyMesh::TOPO_PATCH_CHANGE;
        }
        else
        {
            state = polyMesh::TOPO_CHANGE;
        }
    }
    else if (pointsInst != (forward ? instance0 : pointsInstance()))
    {
        // Points moved
        DebugInfo << "    Point motion" << endl;

        clearGeom();

        label nOldPoints = points_.size();

        points_.clear();

        pointIOField newPoints
        (
            IOobject
            (
                "points",
                pointsInst,
                meshSubDir,
                *this,
                IOobject::MUST_READ,
                IOobject::NO_WRITE,
                false
            )
        );

        if (nOldPoints != 0 && nOldPoints != newPoints.size())
        {
            FatalErrorInFunction
                << "Point motion detected but number of points "
                << newPoints.size() << " in "
                << newPoints.objectPath() << " does not correspond to "
                << " current " << nOldPoints
                << exit(FatalError);
        }

        points_.transfer(newPoints);

        points_.instance() = pointsInst;

        // Re-read tet base points
        autoPtr<labelIOList> newTetBasePtIsPtr = readTetBasePtIs();
        if (newTetBasePtIsPtr.valid())
        {
            tetBasePtIsPtr_ = newTetBasePtIsPtr;
        }

        // Calculate the geometry for the patches (transformation tensors etc.)
        boundary_.calcGeometry();

        // Derived info
        bounds_ = boundBox(points_);

        // Rotation can cause direction vector to change
        geometricD_ = Zero;
        solutionD_ = Zero;

        // Update any generated zones
        pointZones_.movePoints(points_);
        faceZones_.movePoints(points_);
        cellZones_.movePoints(points_);

        state = polyMesh::POINTS_MOVED;
    }

    // pointZones
    {
        const fileName pointZonesInst
        (
            time().findInstance
            (
                meshDir(),
                "pointZones",
                IOobject::READ_IF_PRESENT,
                forward ? instance0 : facesInstance()
            )
        );

        if (pointZonesInst != (forward ? instance0 : pointZones_.instance()))
        {
            pointZoneList newPointZones
            (
                IOobject
                (
                    "pointZones",
                    pointZonesInst,
                    meshSubDir,
                    *this,
                    IOobject::READ_IF_PRESENT,
                    IOobject::NO_WRITE,
                    false
                ),
                *this
            );

            pointZones_.swap(newPointZones);
            pointZones_.instance() = pointZonesInst;
        }
    }

    // faceZones
    {
        const fileName faceZonesInst
        (
            time().findInstance
            (
                meshDir(),
                "faceZones",
                IOobject::READ_IF_PRESENT,
                forward ? instance0 : facesInstance()
            )
        );

        if (faceZonesInst != (forward ? instance0 : faceZones_.instance()))
        {
            faceZoneList newFaceZones
            (
                IOobject
                (
                    "faceZones",
                    faceZonesInst,
                    meshSubDir,
                    *this,
                    IOobject::READ_IF_PRESENT,
                    IOobject::NO_WRITE,
                    false
                ),
                *this
            );

            faceZones_.swap(newFaceZones);
            faceZones_.instance() = faceZonesInst;
        }
    }

    // cellZones
    {
        const fileName cellZonesInst
        (
            time().findInstance
            (
                meshDir(),
                "cellZones",
                IOobject::READ_IF_PRESENT,
                forward ? instance0 : facesInstance()
            )
        );

        if (cellZonesInst != (forward ? instance0 : cellZones_.instance()))
        {
            cellZoneList newCellZones
            (
                IOobject
                (
                    "cellZones",
                    cellZonesInst,
                    meshSubDir,
                    *this,
                    IOobject::READ_IF_PRESENT,
                    IOobject::NO_WRITE,
                    false
                ),
                *this
            );

            cellZones_.swap(newCellZones);
            cellZones_.instance() = cellZonesInst;
        }
    }

    if (state == polyMesh::UNCHANGED)
    {
        DebugInfo << "    No change" << endl;
    }

    return state;
}


bool Foam::polyMesh::writeObject
(
    IOstream::streamFormat fmt,
    IOstream::versionNumber ver,
    IOstream::compressionType cmp,
    const bool write
) const
{
    if (faces_.writeOpt() == AUTO_WRITE)
    {
        auto rmAddressing = [&](const word& name)
        {
            const IOobject faceProcAddressingIO
            (
                name,
                facesInstance(),
                meshSubDir,
                *this
            );

            fileHandler().rm(faceProcAddressingIO.filePath(false));
        };

        if (!Pstream::parRun())
        {
            rmAddressing("cellProc");
        }
        else
        {
            rmAddressing("pointProcAddressing");
            rmAddressing("faceProcAddressing");
            rmAddressing("cellProcAddressing");
        }
    }

    // Write the points out at a higher precision
    if (points_.writeOpt() == IOobject::AUTO_WRITE)
    {
        unsigned int precision0 =
            IOstream::defaultPrecision(IOstream::fullPrecision());

        points_.write();

        IOstream::defaultPrecision(precision0);
    }

    const_cast<polyMesh&>(*this).points_.writeOpt() = IOobject::NO_WRITE;

    const bool written = objectRegistry::writeObject(fmt, ver, cmp, write);

    const_cast<polyMesh&>(*this).setTopologyWrite(IOobject::NO_WRITE);

    return written;
}


bool Foam::polyMesh::writeMesh() const
{
    bool ok = true;

    // Write the points out at a higher precision
    if (points_.writeOpt() == IOobject::AUTO_WRITE)
    {
        unsigned int precision0 =
            IOstream::defaultPrecision(IOstream::fullPrecision());

        ok = ok && points_.write();

        IOstream::defaultPrecision(precision0);
    }

    if (faces_.writeOpt() == IOobject::AUTO_WRITE)
    {
        ok = ok && faces_.write();
    }

    if (owner_.writeOpt() == IOobject::AUTO_WRITE)
    {
        ok = ok && owner_.write();
    }

    if (neighbour_.writeOpt() == IOobject::AUTO_WRITE)
    {
        ok = ok && neighbour_.write();
    }

    if (boundary_.writeOpt() == IOobject::AUTO_WRITE)
    {
        ok = ok && boundary_.write();
    }

    if (pointZones_.writeOpt() == IOobject::AUTO_WRITE)
    {
        ok = ok && pointZones_.write();
    }

    if (faceZones_.writeOpt() == IOobject::AUTO_WRITE)
    {
        ok = ok && faceZones_.write();
    }

    if (cellZones_.writeOpt() == IOobject::AUTO_WRITE)
    {
        ok = ok && cellZones_.write();
    }

    const_cast<polyMesh&>(*this).setTopologyWrite(IOobject::NO_WRITE);

    return ok;
}


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