parLagrangianDistributorTemplates.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) 2015 OpenFOAM Foundation
    Copyright (C) 2018-2022 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 "parLagrangianDistributor.H"
#include "Time.H"
#include "IOobjectList.H"
#include "mapDistributePolyMesh.H"
#include "cloud.H"
#include "CompactIOField.H"
#include "DynamicList.H"
#include "passivePositionParticleCloud.H"

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

template<class Container>
Foam::wordList Foam::parLagrangianDistributor::filterObjects
(
    const IOobjectList& objects,
    const wordRes& selectedFields
)
{
    wordList fieldNames =
    (
        selectedFields.empty()
      ? objects.names<Container>()
      : objects.names<Container>(selectedFields)
    );

    // Parallel synchronise - combine names from all processors
    Pstream::combineReduce(fieldNames, ListOps::uniqueEqOp<word>());
    Foam::sort(fieldNames);  // Consistent order

    return fieldNames;
}


template<class Type>
Foam::label Foam::parLagrangianDistributor::distributeFields
(
    const mapDistributeBase& map,
    const word& cloudName,
    const IOobjectList& objects,
    const wordRes& selectedFields
) const
{
    typedef IOField<Type> fieldType;

    const wordList fieldNames
    (
        filterObjects<fieldType>
        (
            objects,
            selectedFields
        )
    );


    bool reconstruct = false;

    label nFields = 0;
    for (const word& objectName : fieldNames)
    {
        if (!nFields)
        {
            // Performing an all-to-one (reconstruct)?
            reconstruct =
                returnReduceAnd(!map.constructSize() || Pstream::master());
        }

        if (verbose_)
        {
            if (!nFields)
            {
                Info<< "    Distributing lagrangian "
                    << fieldType::typeName << "s\n" << nl;
            }
            Info<< "        " <<  objectName << nl;
        }
        ++nFields;

        // Read if present
        IOField<Type> field
        (
            IOobject
            (
                objectName,
                srcMesh_.time().timeName(),
                cloud::prefix/cloudName,
                srcMesh_,
                IOobject::READ_IF_PRESENT,
                IOobject::NO_WRITE,
                IOobject::NO_REGISTER
            ),
            label(0)
        );

        map.distribute(field);


        const IOobject fieldIO
        (
            objectName,
            tgtMesh_.time().timeName(),
            cloud::prefix/cloudName,
            tgtMesh_,
            IOobject::NO_READ,
            IOobject::NO_WRITE,
            IOobject::NO_REGISTER
        );

        if (field.size())
        {
            IOField<Type>(fieldIO, std::move(field)).write();
        }
        else if (!reconstruct)
        {
            // When running with -overwrite it should also delete the old
            // files. Below works but is not optimal.

            const fileName fldName(fieldIO.objectPath());
            Foam::rm(fldName);
        }
    }

    if (nFields && verbose_) Info<< endl;
    return nFields;
}


template<class Type>
Foam::label Foam::parLagrangianDistributor::distributeFieldFields
(
    const mapDistributeBase& map,
    const word& cloudName,
    const IOobjectList& objects,
    const wordRes& selectedFields
) const
{
    typedef CompactIOField<Field<Type>, Type> fieldType;

    DynamicList<word> fieldNames;

    fieldNames.append
    (
        filterObjects<fieldType>
        (
            objects,
            selectedFields
        )
    );

    // Append IOField Field names
    fieldNames.append
    (
        filterObjects<IOField<Field<Type>>>
        (
            objects,
            selectedFields
        )
    );

    bool reconstruct = false;

    label nFields = 0;
    for (const word& objectName : fieldNames)
    {
        if (!nFields)
        {
            // Performing an all-to-one (reconstruct)?
            reconstruct =
                returnReduceAnd(!map.constructSize() || Pstream::master());
        }

        if (verbose_)
        {
            if (!nFields)
            {
                Info<< "    Distributing lagrangian "
                    << fieldType::typeName << "s\n" << nl;
            }
            Info<< "        " <<  objectName << nl;
        }
        ++nFields;

        // Read if present
        CompactIOField<Field<Type>, Type> field
        (
            IOobject
            (
                objectName,
                srcMesh_.time().timeName(),
                cloud::prefix/cloudName,
                srcMesh_,
                IOobject::READ_IF_PRESENT,
                IOobject::NO_WRITE,
                IOobject::NO_REGISTER
            ),
            label(0)
        );

        // Distribute
        map.distribute(field);

        // Write
        const IOobject fieldIO
        (
            objectName,
            tgtMesh_.time().timeName(),
            cloud::prefix/cloudName,
            tgtMesh_,
            IOobject::NO_READ,
            IOobject::NO_WRITE,
            IOobject::NO_REGISTER
        );

        if (field.size())
        {
            CompactIOField<Field<Type>, Type>
            (
                fieldIO,
                std::move(field)
            ).write();
        }
        else if (!reconstruct)
        {
            // When running with -overwrite it should also delete the old
            // files. Below works but is not optimal.

            const fileName fldName(fieldIO.objectPath());
            Foam::rm(fldName);
        }
    }

    if (nFields && verbose_) Info<< endl;
    return nFields;
}


template<class Container>
Foam::label Foam::parLagrangianDistributor::readFields
(
    const passivePositionParticleCloud& cloud,
    const IOobjectList& objects,
    const wordRes& selectedFields
)
{
    const word fieldClassName(Container::typeName);

    const wordList fieldNames
    (
        filterObjects<Container>
        (
            objects,
            selectedFields
        )
    );

    label nFields = 0;
    for (const word& objectName : fieldNames)
    {
        if (verbose_)
        {
            if (!nFields)
            {
                Info<< "    Reading lagrangian "
                    << Container::typeName << "s\n" << nl;
            }
            Info<< "        " <<  objectName << nl;
        }
        ++nFields;

        // Read if present
        Container* fieldPtr = new Container
        (
            IOobject
            (
                objectName,
                cloud.time().timeName(),
                cloud,
                IOobject::LAZY_READ,
                IOobject::NO_WRITE,
                IOobject::REGISTER
            ),
            label(0)
        );

        fieldPtr->store();
    }

    if (nFields && verbose_) Info<< endl;
    return nFields;
}


template<class Container>
Foam::label Foam::parLagrangianDistributor::distributeStoredFields
(
    const mapDistributeBase& map,
    passivePositionParticleCloud& cloud
) const
{
    HashTable<Container*> fields
    (
        cloud.lookupClass<Container>()
    );

    bool reconstruct = false;

    label nFields = 0;
    forAllIters(fields, iter)
    {
        Container& field = *(iter.val());

        if (!nFields)
        {
            // Performing an all-to-one (reconstruct)?
            reconstruct =
                returnReduceAnd(!map.constructSize() || Pstream::master());
        }

        if (verbose_)
        {
            if (!nFields)
            {
                Info<< "    Distributing lagrangian "
                    << Container::typeName << "s\n" << nl;
            }
            Info<< "        " <<  field.name() << nl;
        }
        ++nFields;

        map.distribute(field);

        const IOobject fieldIO
        (
            field.name(),
            tgtMesh_.time().timeName(),
            cloud::prefix/cloud.name(),
            tgtMesh_,
            IOobject::NO_READ,
            IOobject::NO_WRITE,
            IOobject::NO_REGISTER
        );

        if (field.size())
        {
            Container(fieldIO, std::move(field)).write();
        }
        else if (!reconstruct)
        {
            // When running with -overwrite it should also delete the old
            // files. Below works but is not optimal.

            const fileName fldName(fieldIO.objectPath());
            Foam::rm(fldName);
        }
    }

    if (nFields && verbose_) Info<< endl;
    return nFields;
}


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