outputFilterOutputControl.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------* \
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | Copyright (C) 2011-2014 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::outputFilterOutputControl
 
Description
    An output control for function objects.
    The default is time-step execution at every interval.
 
SourceFiles
    outputFilterOutputControl.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef outputFilterOutputControl_H
#define outputFilterOutputControl_H
 
#include "dictionary.H"
#include "Time.H"
#include "NamedEnum.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                  Class outputFilterOutputControl Declaration
\*---------------------------------------------------------------------------*/
 
class outputFilterOutputControl
{
public:
 
    //- The output control options
    enum outputControls
    {
        ocTimeStep,       
        ocOutputTime,     
        ocAdjustableTime, 
        ocRunTime,        
        ocClockTime,      
        ocCpuTime,        
        ocOnEnd,          
        ocNone            
    };
 
 
private:
 
    // Private data
 
        //- Time object
        const Time& time_;
 
        //- Prefix
        const word prefix_;
 
        //- String representation of outputControls enums
        static const NamedEnum<outputControls, 8> outputControlNames_;
 
        //- Type of output
        outputControls outputControl_;
 
        //- The execution interval (in time steps) when using \c timeStep mode,
        //  a value <= 1 means execute at every time step
        label outputInterval_;
 
        //- Dumping counter for ocOutputTime or index dump for ocAdjustableTime
        label outputTimeLastDump_;
 
        //- Dump each deltaT (adjust Ttime)
        scalar writeInterval_;
 
 
    // Private Member Functions
 
        //- Disallow default bitwise copy construct and assignment
        outputFilterOutputControl(const outputFilterOutputControl&);
        void operator=(const outputFilterOutputControl&);
 
 
public:
 
    // Constructors
 
        //- Construct from Time object and dictionary
        outputFilterOutputControl
        (
            const Time&,
            const dictionary&,
            const word& prefix
        );
 
 
    //- Destructor
    ~outputFilterOutputControl();
 
 
    // Member Functions
 
        //- Read from dictionary
        void read(const dictionary&);
 
        //- Return const access to the Time object
        const Time& time() const
        {
            return time_;
        }
 
        //- Flag to indicate whether to output
        bool output();
 
        //- Return outputControl
        outputControls outputControl() const
        {
            return outputControl_;
        }
 
        //- Return writeInterval
        scalar writeInterval() const
        {
            return writeInterval_;
        }
 
        //- Return outputTimeLastDump
        label outputTimeLastDump() const
        {
            return outputTimeLastDump_;
        }
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //