ENH: Added new cloudInfo function object

src/postProcessing/functionObjects/Allwmake

@@ -3,11 +3,12 @@ cd ${0%/*} || exit 1    # run from this directory
 makeType=${1:-libso}
 set -x
 
+wmake $makeType cloud
 wmake $makeType field
 wmake $makeType forces
 wmake $makeType IO
-wmake $makeType utilities
 wmake $makeType jobControl
 wmake $makeType systemCall
+wmake $makeType utilities
 
 # ----------------------------------------------------------------- end-of-file

src/postProcessing/functionObjects/cloud/Make/files

@@ -0,0 +1,4 @@
+cloudInfo/cloudInfo.C
+cloudInfo/cloudInfoFunctionObject.C
+
+LIB = $(FOAM_LIBBIN)/libcloudFunctionObjects

src/postProcessing/functionObjects/cloud/Make/options

@@ -0,0 +1,9 @@
+EXE_INC = \
+    -I$(LIB_SRC)/finiteVolume/lnInclude \
+    -I$(LIB_SRC)/lagrangian/basic/lnInclude \
+    -I$(LIB_SRC)/lagrangian/intermediate/lnInclude
+
+LIB_LIBS = \
+    -lfiniteVolume \
+    -llagrangian \
+    -llagrangianIntermediate

src/postProcessing/functionObjects/cloud/cloudInfo/IOcloudInfo.H

@@ -0,0 +1,49 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2012 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/>.
+
+Typedef
+    Foam::IOcloudInfo
+
+Description
+    Instance of the generic IOOutputFilter for cloudInfo.
+
+\*---------------------------------------------------------------------------*/
+
+#ifndef IOcloudInfo_H
+#define IOcloudInfo_H
+
+#include "cloudInfo.H"
+#include "IOOutputFilter.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+namespace Foam
+{
+    typedef IOOutputFilter<cloudInfo> IOcloudInfo;
+}
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#endif
+
+// ************************************************************************* //

src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.C

@@ -0,0 +1,183 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2012 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 "cloudInfo.H"
+#include "dictionary.H"
+#include "kinematicCloud.H"
+
+// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
+
+defineTypeNameAndDebug(Foam::cloudInfo, 0);
+
+
+// * * * * * * * * * * * * Protected Member Functions  * * * * * * * * * * * //
+
+void Foam::cloudInfo::makeFiles()
+{
+    if (debug)
+    {
+        Info<< "Creating cloudInfo output files." << endl;
+    }
+
+    outputFilePtr_.clear();
+    outputFilePtr_.setSize(cloudSet_.size());
+
+    if (Pstream::master())
+    {
+        label i = 0;
+        forAllConstIter(wordHashSet, cloudSet_, iter)
+        {
+            const word& cloudName = iter.key();
+            fileName cloudInfoDir(obr_.time().path());
+            word timeName = Foam::name(obr_.time().startTime().value());
+
+            if (Pstream::parRun())
+            {
+                // Put in undecomposed case (Note: gives problems for
+                // distributed data running)
+                cloudInfoDir = cloudInfoDir/".."/name_/timeName;
+            }
+            else
+            {
+                cloudInfoDir = cloudInfoDir/name_/timeName;
+            }
+
+            // Create directory if does not exist
+            mkDir(cloudInfoDir);
+
+            // Open new files at start up
+            outputFilePtr_.set
+            (
+                i,
+                new OFstream(cloudInfoDir/(cloudName + ".dat"))
+            );
+
+            // Add headers
+            outputFilePtr_[i]
+                << "# Time" << tab << "nParcels" << tab << "mass" << endl;
+
+            i++;
+        }
+    }
+}
+
+
+// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
+
+Foam::cloudInfo::cloudInfo
+(
+    const word& name,
+    const objectRegistry& obr,
+    const dictionary& dict,
+    const bool loadFromFiles
+)
+:
+    name_(name),
+    obr_(obr),
+    active_(true),
+    cloudSet_(),
+    outputFilePtr_()
+{
+    read(dict);
+}
+
+
+// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
+
+Foam::cloudInfo::~cloudInfo()
+{}
+
+
+// * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
+
+void Foam::cloudInfo::read(const dictionary& dict)
+{
+    if (active_)
+    {
+        cloudSet_.insert(wordList(dict.lookup("clouds")));
+
+        Info<< type() << ": ";
+        if (cloudSet_.size())
+        {
+            Info<< "applying to clouds:" << nl;
+            forAllConstIter(wordHashSet, cloudSet_, iter)
+            {
+                Info<< "    " << iter.key() << nl;
+            }
+            Info<< endl;
+
+            makeFiles();
+        }
+        else
+        {
+            Info<< "no clouds to be processed" << nl << endl;
+        }
+    }
+}
+
+
+void Foam::cloudInfo::execute()
+{
+    // Do nothing
+}
+
+
+void Foam::cloudInfo::end()
+{
+    // Do nothing
+}
+
+
+void Foam::cloudInfo::write()
+{
+    if (active_)
+    {
+        label i = 0;
+        forAllConstIter(wordHashSet, cloudSet_, iter)
+        {
+            const word& cloudName = iter.key();
+
+            const kinematicCloud& cloud =
+                obr_.lookupObject<kinematicCloud>(cloudName);
+
+            label nParcels = returnReduce(cloud.nParcels(), sumOp<label>());
+            scalar massInSystem =
+                returnReduce(cloud.massInSystem(), sumOp<scalar>());
+
+            if (Pstream::master())
+            {
+                outputFilePtr_[i]
+                    << obr_.time().value() << token::TAB
+                    << nParcels << token::TAB
+                    << massInSystem << endl;
+            }
+
+            i++;
+        }
+    }
+}
+
+
+// ************************************************************************* //

src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H

@@ -0,0 +1,157 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2012 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/>.
+
+Class
+    Foam::cloudInfo
+
+Description
+    Outputs cloud information to file
+
+    Currently outputs:
+        - total current number of parcels
+        - total current mass of parcels
+
+SourceFiles
+    cloudInfo.C
+    IOcloudInfo.H
+
+\*---------------------------------------------------------------------------*/
+
+#ifndef cloudInfo_H
+#define cloudInfo_H
+
+#include "OFstream.H"
+#include "PtrList.H"
+#include "pointFieldFwd.H"
+#include "volFields.H"
+#include "surfaceFields.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+namespace Foam
+{
+
+// Forward declaration of classes
+class objectRegistry;
+class dictionary;
+class mapPolyMesh;
+
+/*---------------------------------------------------------------------------*\
+                         Class cloudInfo Declaration
+\*---------------------------------------------------------------------------*/
+
+class cloudInfo
+{
+protected:
+
+    // Protected data
+
+        //- Name of this set of cloudInfo object
+        word name_;
+
+        const objectRegistry& obr_;
+
+        //- on/off switch
+        bool active_;
+
+        //- Clouds to process
+        wordHashSet cloudSet_;
+
+        //- Output file pointers
+        PtrList<OFstream> outputFilePtr_;
+
+
+    // Protected Member Functions
+
+        //- If the output file has not been created create it
+        void makeFiles();
+
+        //- Disallow default bitwise copy construct
+        cloudInfo(const cloudInfo&);
+
+        //- Disallow default bitwise assignment
+        void operator=(const cloudInfo&);
+
+
+public:
+
+    //- Runtime type information
+    TypeName("cloudInfo");
+
+
+    // Constructors
+
+        //- Construct for given objectRegistry and dictionary.
+        //  Allow the possibility to load fields from files
+        cloudInfo
+        (
+            const word& name,
+            const objectRegistry&,
+            const dictionary&,
+            const bool loadFromFiles = false
+        );
+
+
+    //- Destructor
+    virtual ~cloudInfo();
+
+
+    // Member Functions
+
+        //- Return name of the cloudInfo object
+        virtual const word& name() const
+        {
+            return name_;
+        }
+
+        //- Read the field min/max data
+        virtual void read(const dictionary&);
+
+        //- Execute, currently does nothing
+        virtual void execute();
+
+        //- Execute at the final time-loop, currently does nothing
+        virtual void end();
+
+        //- Write
+        virtual void write();
+
+        //- Update for changes of mesh
+        virtual void updateMesh(const mapPolyMesh&)
+        {}
+
+        //- Update for changes of mesh
+        virtual void movePoints(const pointField&)
+        {}
+};
+
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+} // End namespace Foam
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#endif
+
+// ************************************************************************* //

src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfoFunctionObject.C

@@ -0,0 +1,42 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2012 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 "cloudInfoFunctionObject.H"
+
+// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
+
+namespace Foam
+{
+    defineNamedTemplateTypeNameAndDebug(cloudInfoFunctionObject, 0);
+
+    addToRunTimeSelectionTable
+    (
+        functionObject,
+        cloudInfoFunctionObject,
+        dictionary
+    );
+}
+
+// ************************************************************************* //

src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfoFunctionObject.H

@@ -0,0 +1,54 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2012 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/>.
+
+Typedef
+    Foam::cloudInfoFunctionObject
+
+Description
+    FunctionObject wrapper around cloudInfo to allow them to be created via
+    the functions entry within controlDict.
+
+SourceFiles
+    cloudInfoFunctionObject.C
+
+\*---------------------------------------------------------------------------*/
+
+#ifndef cloudInfoFunctionObject_H
+#define cloudInfoFunctionObject_H
+
+#include "cloudInfo.H"
+#include "OutputFilterFunctionObject.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+namespace Foam
+{
+    typedef OutputFilterFunctionObject<cloudInfo>
+        cloudInfoFunctionObject;
+}
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#endif
+
+// ************************************************************************* //

src/postProcessing/functionObjects/cloud/cloudInfo/postProcessingDict

@@ -0,0 +1,31 @@
+/*--------------------------------*- C++ -*----------------------------------*\
+| =========                 |                                                 |
+| \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox           |
+|  \\    /   O peration     | Version:  dev                                   |
+|   \\  /    A nd           | Web:      www.OpenFOAM.org                      |
+|    \\/     M anipulation  |                                                 |
+\*---------------------------------------------------------------------------*/
+FoamFile
+{
+    version     2.0;
+    format      ascii;
+    class       dictionary;
+    object      postProcessingDict;
+}
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+functions
+{
+    cloudInfo1
+    {
+        type            cloudInfo;
+        functionObjectLibs ("libcloudFunctionObjects.so");
+        enabled         true;
+        outputControl   timeStep;
+        outputInterval  1;
+
+        clouds          (myCloud1);
+    }
+}
+
+// ************************************************************************* //