dataCloud.H

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) 2018-2024 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/>.
 
Class
    Foam::functionObjects::dataCloud
 
Group
    grpLagrangianFunctionObjects
 
Description
    This functionObject writes cloud positions in ASCII.
 
Usage
    Minimal example by using \c system/controlDict.functions:
    \verbatim
    cloudWriteFO
    {
        // Mandatory entries
        type            dataCloud;
        libs            (lagrangianFunctionObjects);
        field           <word>;
 
        // Conditional entries
 
            // Option-1
            cloud           <word>;
 
            // Option-2
            clouds          (<wordRes>);
 
        // Optional entries
        selection       <dictionary>;
        directory       <fileName>;
        width           <int>;
        precision       <unsigned>;
 
        // Inherited entries
        ...
    }
    \endverbatim
 
    where the entries mean:
    \table
      Property  | Description                      | Type | Reqd | Deflt
      type      | Type name: dataCloud             | word | yes  | -
      libs      | Library name: lagrangianFunctionObjects | word | yes  | -
      field     | Name of cloud field to write     | word | yes  | -
      cloud     | Name of cloud to process         | word | conditional | -
      clouds    | Names of clouds to process       | wordRes | conditional | -
      selection | Parcel selection control         | no   | empty-dict
      directory | The output directory name        | no   | postProcessing/NAME
      width     | Padding width for file name      | no   | 8
      precision | The write precision              | no   | same as IOstream
    \endtable
 
    \heading Output Options
    \table
        Property     | Description                      | Required | Default
        precision    | The write precision              | no  | same as IOstream
        directory    | The output directory name    | no | postProcessing/NAME
        width        | Padding width for file name      | no  | 8
        writeControl | Output control                   | recommended | timeStep
    \endtable
 
    The inherited entries are elaborated in:
      - \link regionFunctionObject.H \endlink
      - \link parcelSelectionDetail.H \endlink
 
Note
    See Foam::functionObjects::vtkCloud and Foam::Detail::parcelSelection
    for more details about the parcel selection mechanism.
 
See also
    Foam::Detail::parcelSelection
    Foam::functionObjects::vtkCloud
    Foam::functionObjects::fvMeshFunctionObject
    Foam::functionObjects::timeControl
 
SourceFiles
    dataCloud.C
    dataCloudTemplates.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef Foam_functionObjects_dataCloud_H
#define Foam_functionObjects_dataCloud_H
 
#include "fvMeshFunctionObject.H"
#include "parcelSelectionDetail.H"
#include "vectorField.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
namespace functionObjects
{
 
/*---------------------------------------------------------------------------*\
                          Class dataCloud Declaration
\*---------------------------------------------------------------------------*/
 
class dataCloud
:
    public fvMeshFunctionObject,
    public Foam::Detail::parcelSelection
{
    // Private Data
 
        //- The printf format for zero-padding names
        string printf_;
 
        //- The output precision
        unsigned precision_;
 
        //- Apply output filter (for the current cloud)
        bool applyFilter_;
 
        //- Requested names of clouds to process
        wordRes selectClouds_;
 
        //- Subset of cloud fields to process
        word fieldName_;
 
        //- Output directory
        fileName directory_;
 
 
    // Private Member Functions
 
        //- Output (point,value) combination on a single line
        template<class Type>
        static void writePointValue
        (
            Ostream& os,
            const vector& pt,
            const Type& val
        );
 
        template<class Type>
        static void writeList
        (
            Ostream& os,
            const vectorField& points,
            const List<Type>& field
        );
 
        template<class Type>
        static void writeListParallel
        (
            Ostream& os,
            const vectorField& points,
            const List<Type>& field
        );
 
        template<class Type>
        static void writeList
        (
            Ostream& os,
            const vectorField& points,
            const List<Type>& field,
            const bitSet& selected
        );
 
        template<class Type>
        static void writeListParallel
        (
            Ostream& os,
            const vectorField& points,
            const List<Type>& field,
            const bitSet& selected
        );
 
        //- Write to disk
        bool writeCloud(const fileName& outputName, const word& cloudName);
 
        //- Write from objectRegistry entry
        template<class Type>
        bool writeField
        (
            const fileName& outputName,
            const objectRegistry& obr
        ) const;
 
 
        //- No copy construct
        dataCloud(const dataCloud&) = delete;
 
        //- No copy assignment
        void operator=(const dataCloud&) = delete;
 
 
public:
 
    //- Runtime type information
    TypeName("dataCloud");
 
 
    // Constructors
 
        //- Construct from name, Time and dictionary
        dataCloud
        (
            const word& name,
            const Time& runTime,
            const dictionary& dict
        );
 
 
    //- Destructor
    virtual ~dataCloud() = default;
 
 
    // Member Functions
 
        //- Read the function-object dictionary
        virtual bool read(const dictionary& dict);
 
        //- Execute the function-object operations, currently does nothing
        virtual bool execute();
 
        //- Write the function-object results
        virtual bool write();
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace functionObjects
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#ifdef NoRepository
    #include "dataCloudTemplates.C"
#endif
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //