writeFreeSurface.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 Zeljko Tukovic, FSB Zagreb.
-------------------------------------------------------------------------------
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::writeFreeSurface
 
Description
    A function object to write the control points on the free surface
 
SourceFiles
    writeFreeSurface.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef writeFreeSurface_H
#define writeFreeSurface_H
 
#include "functionObject.H"
#include "dictionary.H"
#include "fvMesh.H"
#include "OFstream.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                        Class writeFreeSurface Declaration
\*---------------------------------------------------------------------------*/
 
class writeFreeSurface
:
    public functionObject
{
    // Private Data
 
        //- Name
        const word name_;
 
        //- Reference to main object registry
        const Time& time_;
 
        //- Region name
        word regionName_;
 
 
    // Private Member Functions
 
        //- Write data
        bool writeData();
 
        //- No copy construct
        writeFreeSurface(const writeFreeSurface&) = delete;
 
        //- No copy assignment
        void operator=(const writeFreeSurface&) = delete;
 
public:
 
    //- Runtime type information
    TypeName("writeFreeSurface");
 
 
    // Constructors
 
        //- Construct from components
        writeFreeSurface
        (
            const word& name,
            const Time& runTime,
            const dictionary& dict
        );
 
 
    // Member Functions
 
        //- start is called at the start of the time-loop
        virtual bool start();
 
        //- execute is called at each ++ or += of the time-loop
        virtual bool execute();
 
        //- Read and set the function object if its data has changed
        virtual bool read(const dictionary& dict);
 
        //- No-op
        virtual bool write()
        {
            return true;
        }
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //