ensightOutputCloudTemplates.C

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | www.openfoam.com
     \\/     M anipulation  |
-------------------------------------------------------------------------------
    Copyright (C) 2016-2025 OpenCFD Ltd.
-------------------------------------------------------------------------------
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 "ensightOutputCloud.H"
#include "ensightPTraits.H"
#include "globalIndex.H"

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

template<class Type>
Foam::label Foam::ensightOutput::Detail::writeCloudFieldContent
(
    ensightFile& os,
    const UList<Type>& field,
    label count
)
{
    for (Type val : field)          // <-- working on a copy!
    {
        if (mag(val) < 1e-90)       // approximately root(ROOTVSMALL)
        {
            val = Zero;
        }

        for (direction d=0; d < pTraits<Type>::nComponents; ++d)
        {
            const direction cmpt = ensightPTraits<Type>::componentOrder[d];

            os.write(component(val, cmpt));

            if (++count % 6 == 0)
            {
                os.newline();
            }
        }
    }

    return count;
}


// * * * * * * * * * * * * * * * Global Functions  * * * * * * * * * * * * * //

template<class Type>
bool Foam::ensightOutput::writeCloudField
(
    ensightFile& os,
    const UList<Type>& field,
    const globalIndex& procAddr
)
{
    bool allEmpty(!procAddr.totalSize());
    Pstream::broadcast(allEmpty);

    if (allEmpty)
    {
        return false;  // All empty
    }


    if (UPstream::master())
    {
        // 6 values per line
        label count = 0;

        // Write master data
        count = ensightOutput::Detail::writeCloudFieldContent
        (
            os,
            field,
            count
        );

        // Receive and write
        DynamicList<Type> recvData(procAddr.maxNonLocalSize());

        for (const label proci : procAddr.subProcs())
        {
            const label procSize = procAddr.localSize(proci);

            if (procSize)
            {
                recvData.resize_nocopy(procSize);

                UIPstream::read
                (
                    UPstream::commsTypes::scheduled,
                    proci,
                    recvData
                );

                count = ensightOutput::Detail::writeCloudFieldContent
                (
                    os,
                    recvData,
                    count
                );
            }
        }

        // Add final newline if required
        if (count % 6)
        {
            os.newline();
        }
    }
    else if (UPstream::is_subrank())
    {
        if (field.size())
        {
            UOPstream::write
            (
                UPstream::commsTypes::scheduled,
                UPstream::masterNo(),
                field
            );
        }
    }

    return true;
}


template<class Type>
bool Foam::ensightOutput::writeCloudField
(
    ensightFile& os,
    const UList<Type>& field
)
{
    return ensightOutput::writeCloudField
    (
        os,
        field,
        // Gather sizes (offsets irrelevant)
        globalIndex(globalIndex::gatherOnly{}, field.size())
    );
}


template<class Type>
bool Foam::ensightOutput::readWriteCloudField
(
    ensightFile& os,
    const IOobject& fieldObject,
    const bool existsAny
)
{
    if (existsAny)
    {
        // When exists == true, it exists somewhere globally,
        // but can still be missing on the local processor.
        // Handle this by READ_IF_PRESENT instead.

        IOobject io(fieldObject);
        io.readOpt(IOobject::READ_IF_PRESENT);
        io.registerObject(IOobject::NO_REGISTER);

        IOField<Type> field(io);

        ensightOutput::writeCloudField(os, field);
    }

    return true;
}


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