fieldValue.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  | Copyright (C) 2015 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::fieldValue
 
Group
    grpFieldFunctionObjects
 
Description
    Base class for field value-based function objects.
 
SourceFiles
    fieldValue.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef fieldValue_H
#define fieldValue_H
 
#include "functionObjectState.H"
#include "functionObjectFile.H"
#include "Switch.H"
#include "OFstream.H"
#include "dictionary.H"
#include "Field.H"
#include "runTimeSelectionTables.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
// Forward declaration of classes
class objectRegistry;
class fvMesh;
class polyMesh;
class mapPolyMesh;
 
/*---------------------------------------------------------------------------*\
                       Class fieldValue Declaration
\*---------------------------------------------------------------------------*/
 
class fieldValue
:
    public functionObjectState,
    public functionObjectFile
{
 
protected:
 
    // Protected data
 
        //- Database this class is registered to
        const objectRegistry& obr_;
 
        //- Construction dictionary
        dictionary dict_;
 
        //- Switch to send output to Info as well as to file
        Switch log_;
 
        //- Name of source object
        word sourceName_;
 
        //- List of field names to operate on
        wordList fields_;
 
        //- Output field values flag
        Switch valueOutput_;
 
        //- Scale factor - optional
        scalar scaleFactor_;
 
 
public:
 
    //- Run-time type information
    TypeName("fieldValue");
 
    // Declare runtime constructor selection table
 
        declareRunTimeSelectionTable
        (
            autoPtr,
            fieldValue,
            dictionary,
            (
                const word& name,
                const objectRegistry& obr,
                const dictionary& dict,
                const bool loadFromFiles
            ),
            (name, obr, dict, loadFromFiles)
        );
 
    //- Construct from components
    fieldValue
    (
        const word& name,
        const objectRegistry& obr,
        const dictionary& dict,
        const word& valueType,
        const bool loadFromFiles = false
    );
 
    //- Return a reference to the selected fieldValue
    static autoPtr<fieldValue> New
    (
        const word& name,
        const objectRegistry& obr,
        const dictionary& dict,
        const bool loadFromFiles = false,
        const bool output = true
    );
 
    //- Destructor
    virtual ~fieldValue();
 
 
    // Public Member Functions
 
        // Access
 
            //- Return the name of the geometric source
            inline const word& name() const;
 
            //- Return the reference to the object registry
            inline const objectRegistry& obr() const;
 
            //- Return the reference to the construction dictionary
            inline const dictionary& dict() const;
 
            //- Return the active flag
            inline bool active() const;
 
            //- Return the switch to send output to Info as well as to file
            inline const Switch& log() const;
 
            //- Return the source name
            inline const word& sourceName() const;
 
            //- Return the list of field names
            inline const wordList& fields() const;
 
            //- Return the output field values flag
            inline const Switch& valueOutput() const;
 
            //- Helper function to return the reference to the mesh
            inline const fvMesh& mesh() const;
 
 
        // Function object functions
 
            //- Read from dictionary
            virtual void read(const dictionary& dict);
 
            //- Write to screen/file
            virtual void write();
 
            //- Execute
            virtual void execute();
 
            //- Execute the at the final time-loop, currently does nothing
            virtual void end();
 
            //- Called when time was set at the end of the Time::operator++
            virtual void timeSet();
 
            //- Update mesh
            virtual void updateMesh(const mapPolyMesh&);
 
            //- Move points
            virtual void movePoints(const polyMesh&);
 
            //- Combine fields from all processor domains into single field
            template<class Type>
            void combineFields(Field<Type>& field);
 
            //- Combine fields from all processor domains into single field
            template<class Type>
            void combineFields(tmp<Field<Type> >&);
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#include "fieldValueI.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#ifdef NoRepository
    #include "fieldValueTemplates.C"
#endif
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //