areaWrite.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) 2019-2023 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::areaWrite
 
Description
    Write finite area mesh/fields to standard output formats.
 
Usage
    Minimal example by using \c system/controlDict.functions:
    \verbatim
    areaWriteFO
    {
        // Mandatory entries
        type            areaWrite;
        libs            (utilityFunctionObjects);
        fields          (<wordRes>);  // (p U);
        surfaceFormat   <word>;       // vtk;
 
        // Output surface format
        formatOptions
        {
            vtk
            {
                precision  10;
            }
        }
 
        // Optional entries
        verbose         <word>;
 
        // Conditional entries
 
            // Option-1
            areas           (<wordRes>);
 
            // Option-2
            area            <word>;
 
        // Inherited entries
        ...
    }
    \endverbatim
 
    where the entries mean:
    \table
      Property | Description                        | Type | Reqd | Deflt
      type     | Type name: areaWrite               | word | yes  | -
      libs     | Library name: utilityFunctionObjects | word | yes | -
      fields   | Name of operand fields             | wordRes | yes | -
      surfaceFormat | Output surface format         | word | yes | -
      areas   | Names of finite-area regions        | wordRes | no  | -
      area    | Name of finite-area region          | word | no  | -
      formatOptions | Dictionary of format options  | dict | no  | -
    \endtable
 
    The inherited entries are elaborated in:
      - \link functionObject.H \endlink
      - \link surfaceWriter.H \endlink
 
SourceFiles
    areaWrite.cxx
    areaWriteImpl.cxx
 
\*---------------------------------------------------------------------------*/
 
#ifndef Foam_areaWrite_H
#define Foam_areaWrite_H
 
#include "fvMeshFunctionObject.H"
#include "polyMesh.H"
#include "areaFieldsFwd.H"
#include "surfaceWriter.H"
#include "HashPtrTable.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
// Forward Declarations
class faMesh;
class polySurface;
class IOobjectList;
 
/*---------------------------------------------------------------------------*\
                          Class areaWrite Declaration
\*---------------------------------------------------------------------------*/
 
class areaWrite
:
    public functionObjects::fvMeshFunctionObject
{
    // Static Data Members
 
        //- Tolerance for merging points (fraction of mesh bounding box)
        static scalar mergeTol_;
 
 
    // Private Data
 
        //- Load fields from files (not from objectRegistry)
        const bool loadFromFiles_;
 
        //- Output verbosity
        bool verbose_;
 
        //- Output path
        fileName outputPath_;
 
 
    // Read from dictionary
 
        //- Names of areas to select
        wordRes selectAreas_;
 
        //- Names of fields to write
        wordRes fieldSelection_;
 
        //- Pointers to the requested mesh regions (sorted)
        UPtrList<const faMesh> meshes_;
 
        //- Hold intermediate surfaces.
        //  The faMesh has an indirect face list but we require real ones.
        std::unique_ptr<objectRegistry> surfaces_;
 
 
    // Output control
 
        //- Surface writers (one per surface)
        HashPtrTable<surfaceWriter> writers_;
 
 
    // Private Member Functions
 
        //- Mark intermediate surfaces and writers as needing an update.
        void expire();
 
        //- Write fieldName on surface and on outputDir path.
        //  Can have a field nullptr for partially missing fields,
        //  but the caller should generally filter out completely
        //  missing fields.
        template<class Type>
        void writeSurface
        (
            surfaceWriter& writer,
            const Field<Type>* fieldPtr,
            const word& fieldName
        );
 
        //- Write all applicable fields
        template<class GeoField>
        void performAction
        (
            surfaceWriter& writer,
            const faMesh& areaMesh,
            const IOobjectList& objects
        );
 
public:
 
    //- Runtime type information
    TypeName("areaWrite");
 
 
    // Generated Methods
 
        //- No copy construct
        areaWrite(const areaWrite&) = delete;
 
        //- No copy assignment
        void operator=(const areaWrite&) = delete;
 
 
    // Constructors
 
        //- Construct from name, Time and dictionary
        areaWrite
        (
            const word& name,
            const Time& runTime,
            const dictionary& dict
        );
 
        //- Construct for given objectRegistry and dictionary.
        //- Allow the possibility to load fields from files
        areaWrite
        (
            const word& name,
            const objectRegistry& obr,
            const dictionary& dict,
            const bool loadFromFiles = false
        );
 
 
    //- Destructor
    virtual ~areaWrite();
 
 
    // Member Functions
 
        //- Enable/disable verbose output
        //  \return old value
        bool verbose(bool on) noexcept;
 
        //- Read the function-object dictionary
        virtual bool read(const dictionary& dict);
 
        //- Execute the function-object operations (no-op)
        virtual bool execute();
 
        //- Write the function-object results
        virtual bool write();
 
        //- Update for changes of mesh - expires the surfaces
        virtual void updateMesh(const mapPolyMesh& mpm);
 
        //- Update for mesh point-motion - expires the surfaces
        virtual void movePoints(const polyMesh& mesh);
 
        //- Update for changes of mesh due to readUpdate - expires the surfaces
        virtual void readUpdate(const polyMesh::readUpdateState state);
 
        //- Get merge tolerance
        static scalar mergeTol() noexcept;
 
        //- Set merge tolerance and return old value
        static scalar mergeTol(scalar tol) noexcept;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //