ENH: Initial commit of new particleDistribution FO - generates 'general' distribution for lagrangian particle clouds

src/functionObjects/field/Make/files

@@ -74,9 +74,12 @@ externalCoupled/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedF
 
 extractEulerianParticles/extractEulerianParticles/extractEulerianParticles.C
 extractEulerianParticles/eulerianParticle/eulerianParticle.C
+extractEulerianParticles/injectedParticle/injectedParticle.C
 extractEulerianParticles/injectedParticle/injectedParticleIO.C
 extractEulerianParticles/injectedParticle/injectedParticleCloud.C
 
+particleDistribution/particleDistribution.C
+
 
 ddt2/ddt2.C
 zeroGradient/zeroGradient.C

src/functionObjects/field/particleDistribution/particleDistribution.C

@@ -0,0 +1,206 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2016 OpenCFD Ltd.
+     \\/     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 "particleDistribution.H"
+#include "addToRunTimeSelectionTable.H"
+#include "general.H"
+#include "fvMesh.H"
+#include "cloud.H"
+
+// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
+
+namespace Foam
+{
+namespace functionObjects
+{
+    defineTypeNameAndDebug(particleDistribution, 0);
+
+    addToRunTimeSelectionTable
+    (
+        functionObject,
+        particleDistribution,
+        dictionary
+    );
+}
+}
+
+// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
+
+Foam::functionObjects::particleDistribution::particleDistribution
+(
+    const word& name,
+    const Time& runTime,
+    const dictionary& dict
+)
+:
+    fvMeshFunctionObject(name, runTime, dict),
+    writeFile(runTime, name, typeName, dict),
+    cloudName_("unknown-cloudName"),
+    fieldNames_(),
+    tagFieldName_("unknown-tagFieldName"),
+    distributionBinWidth_(0),
+    rndGen_(1234, -1)
+{
+    read(dict);
+}
+
+
+// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
+
+Foam::functionObjects::particleDistribution::~particleDistribution()
+{}
+
+
+// * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
+
+bool Foam::functionObjects::particleDistribution::read(const dictionary& dict)
+{
+    if (fvMeshFunctionObject::read(dict) && writeFile::read(dict))
+    {
+        dict.lookup("cloud") >> cloudName_;
+        dict.lookup("fields") >> fieldNames_;
+        dict.lookup("tagField") >> tagFieldName_;
+        dict.lookup("distributionBinWidth") >> distributionBinWidth_;
+
+        Info<< type() << " " << name() << " output:"
+            << "    Processing cloud : " << cloudName_ << nl
+            << endl;
+
+        return true;
+    }
+
+    return false;
+}
+
+
+bool Foam::functionObjects::particleDistribution::execute()
+{
+    return true;
+}
+
+
+bool Foam::functionObjects::particleDistribution::write()
+{
+    Log << type() << " " << name() << " output:" << endl;
+
+    if (!mesh_.foundObject<cloud>(cloudName_))
+    {
+        WarningInFunction
+            << "Unable to find cloud " << cloudName_
+            << " in the mesh database" << endl;
+
+        return false;
+    }
+
+    const cloud& c = mesh_.lookupObject<cloud>(cloudName_);
+
+    objectRegistry cloudObr
+    (
+        IOobject
+        (
+            name() & "CloudRegistry",
+            mesh_.time().timeName(),
+            cloud::prefix,
+            mesh_.time(),
+            IOobject::NO_READ,
+            IOobject::NO_WRITE
+        )
+    );
+
+    c.writeObjects(cloudObr);
+
+    List<DynamicList<label>> tagAddr;
+    if
+    (
+        tagFieldName_ != "none"
+     && cloudObr.foundObject<IOField<scalar>>(tagFieldName_)
+    )
+    {
+        // Tag field present - generate distribution per tag
+        const IOField<label>& tag =
+            cloudObr.lookupObject<IOField<label>>(tagFieldName_);
+        const HashSet<label> tagMap(tag);
+        const label tagMax = tagMap.size();
+
+        List<DynamicList<label>> tagAddr(tagMax);
+        forAll(tag, i)
+        {
+            label newTag = tagMap[tag[i]];
+            tagAddr[newTag].append(i);
+        }
+    }
+
+    bool ok = false;
+    forAll(fieldNames_, i)
+    {
+        const word fName = fieldNames_[i];
+        ok = ok || processField<scalar>(cloudObr, fName, tagAddr);
+        ok = ok || processField<vector>(cloudObr, fName, tagAddr);
+        ok = ok || processField<tensor>(cloudObr, fName, tagAddr);
+        ok = ok || processField<sphericalTensor>(cloudObr, fName, tagAddr);
+        ok = ok || processField<symmTensor>(cloudObr, fName, tagAddr);
+        ok = ok || processField<tensor>(cloudObr, fName, tagAddr);
+
+        if (log && !ok)
+        {
+            WarningInFunction
+                << "Unable to find field " << fName << " in the "
+                << cloudName_ << " cloud database" << endl;
+        }
+    }
+
+
+    return true;
+}
+
+
+void Foam::functionObjects::particleDistribution::generateDistribution
+(
+    const word& fieldName,
+    const scalarField& field,
+    const label tag
+)
+{
+    Ostream& os = file();
+
+    if (tag != -1)
+    {
+        os  << tag << token::TAB;
+    }
+
+    distributionModels::general distribution
+    (
+        field,
+        distributionBinWidth_,
+        rndGen_
+    );
+
+    distribution.writeData(os);
+
+    os  << endl;
+}
+
+
+// ************************************************************************* //

src/functionObjects/field/particleDistribution/particleDistribution.H

@@ -0,0 +1,184 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2016 OpenCFD Ltd.
+     \\/     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/>.
+
+Class
+    Foam::functionObjects::particleDistribution
+
+Group
+    grpFieldFunctionObjects
+
+Description
+    Generates a particle distrbution for lagrangian data.
+
+Usage
+    \verbatim
+    particleDistribution1
+    {
+        type        particleDistribution;
+        libs        ("libfieldFunctionObjects.so");
+        ...
+        cloud       "myCloud";
+        field       "d"
+        distributionBinWidth 0.1;
+    }
+    \endverbatim
+
+    Where the entries comprise:
+    \table
+        Property    | Description              |  Required  | Default value
+        type        | Type name: particleDistribution | yes |
+        cloud       | Name of cloud to process | Yes        |
+        field       | Name of cloud field to process | Yes  |
+        distributionBinWidth | Width of distribution bins | yes |
+    \endtable
+
+See also
+    Foam::functionObjects::fvMeshFunctionObject
+    Foam::functionObjects::writeFile
+    Foam::functionObjects::timeControl
+
+SourceFiles
+    particleDistribution.C
+
+\*---------------------------------------------------------------------------*/
+
+#ifndef functionObjects_particleDistribution_H
+#define functionObjects_particleDistribution_H
+
+#include "fvMeshFunctionObject.H"
+#include "writeFile.H"
+#include "scalarField.H"
+#include "cachedRandom.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+namespace Foam
+{
+namespace functionObjects
+{
+
+/*---------------------------------------------------------------------------*\
+                    Class particleDistribution Declaration
+\*---------------------------------------------------------------------------*/
+
+class particleDistribution
+:
+    public fvMeshFunctionObject,
+    public writeFile
+{
+protected:
+
+    // Protected data
+
+        //- Cloud name
+        word cloudName_;
+
+        //- Field name
+        wordList fieldNames_;
+
+        //- Tag field name - used to filter the particles into groups
+        word tagFieldName_;
+
+        //- Distribution bin width
+        scalar distributionBinWidth_;
+
+        //- Random number generator - used by distribution models
+        cachedRandom rndGen_;
+
+
+    // Private Member Functions
+
+        //- Generate the distribution
+        void generateDistribution
+        (
+            const word& fieldName,
+            const scalarField& field,
+            const label tag = -1
+        );
+
+        // Helper function to retrieve the particle data
+        template<class Type>
+        bool processField
+        (
+            const objectRegistry& obr,
+            const word& fieldName,
+            const List<DynamicList<label>>& addr
+        );
+
+        //- Disallow default bitwise copy construct
+        particleDistribution(const particleDistribution&) = delete;
+
+        //- Disallow default bitwise assignment
+        void operator=(const particleDistribution&) = delete;
+
+
+public:
+
+    //- Runtime type information
+    TypeName("particleDistribution");
+
+
+    // Constructors
+
+        //- Construct from Time and dictionary
+        particleDistribution
+        (
+            const word& name,
+            const Time& runTime,
+            const dictionary& dict
+        );
+
+
+    //- Destructor
+    virtual ~particleDistribution();
+
+
+    // Member Functions
+
+        //- Read the particleDistribution data
+        virtual bool read(const dictionary&);
+
+        //- Execute, currently does nothing
+        virtual bool execute();
+
+        //- Write the particleDistribution
+        virtual bool write();
+};
+
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+} // End namespace functionObjects
+} // End namespace Foam
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#ifdef NoRepository
+    #include "particleDistributionTemplates.C"
+#endif
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#endif
+
+// ************************************************************************* //

src/functionObjects/field/particleDistribution/particleDistributionTemplates.C

@@ -0,0 +1,67 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2016 OpenCFD Ltd.
+     \\/     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 "IOField.H"
+
+template<class Type>
+bool Foam::functionObjects::particleDistribution::processField
+(
+    const objectRegistry& obr,
+    const word& fieldName,
+    const List<DynamicList<label>>& addr
+)
+{
+    if (obr.foundObject<IOField<Type>>(fieldName))
+    {
+        const IOField<Type>& field =
+            obr.lookupObject<IOField<Type>>(fieldName);
+
+        if (addr.size())
+        {
+            forAll(addr, i)
+            {
+                const Field<Type> subField(field, addr[i]);
+                for (direction d = 0; d < pTraits<Type>::nComponents; ++d)
+                {
+                    generateDistribution(fieldName, subField.component(d), i);
+                }
+            }
+        }
+        else
+        {
+            for (direction d = 0; d < pTraits<Type>::nComponents; ++d)
+            {
+                generateDistribution(fieldName, field.component(d));
+            }
+        }
+
+        return true;
+    }
+
+    return false;
+}
+
+
+// ************************************************************************* //