residuals.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | Copyright (C) 2015 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::residuals
 
Group
    grpUtilitiesFunctionObjects
 
Description
    This function object writes out the initial residual for specified fields.
 
    Example of function object specification:
    \verbatim
    residuals
    {
        type            residuals;
        outputControl   timeStep;
        outputInterval  1;
        fields
        (
            U
            p
        );
    }
    \endverbatim
 
    Output data is written to the dir postProcessing/residuals/<timeDir>/
    For vector/tensor fields, e.g. U, where an equation is solved for each
    component, the largest residual of each component is written out.
 
SeeAlso
    Foam::functionObject
    Foam::OutputFilterFunctionObject
 
SourceFiles
    residuals.C
    IOresiduals.H
 
\*---------------------------------------------------------------------------*/
 
#ifndef residuals_H
#define residuals_H
 
#include "functionObjectFile.H"
#include "primitiveFieldsFwd.H"
#include "volFieldsFwd.H"
#include "HashSet.H"
#include "OFstream.H"
#include "Switch.H"
#include "NamedEnum.H"
#include "solverPerformance.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
// Forward declaration of classes
class objectRegistry;
class dictionary;
class polyMesh;
class mapPolyMesh;
 
/*---------------------------------------------------------------------------*\
                          Class residuals Declaration
\*---------------------------------------------------------------------------*/
 
class residuals
:
    public functionObjectFile
{
protected:
 
    // Protected data
 
        //- Name of this set of residuals
        //  Also used as the name of the output directory
        word name_;
 
        const objectRegistry& obr_;
 
        //- on/off switch
        bool active_;
 
        //- Fields to write residuals
        wordList fieldSet_;
 
 
    // Private Member Functions
 
        //- Disallow default bitwise copy construct
        residuals(const residuals&);
 
        //- Disallow default bitwise assignment
        void operator=(const residuals&);
 
        //- Output field header information
        template<class Type>
        void writeFileHeader(const word& fieldName);
 
        //- Output file header information
        virtual void writeFileHeader(Ostream& os) const;
 
 
public:
 
    //- Runtime type information
    TypeName("residuals");
 
 
    // Constructors
 
        //- Construct for given objectRegistry and dictionary.
        //  Allow the possibility to load fields from files
        residuals
        (
            const word& name,
            const objectRegistry&,
            const dictionary&,
            const bool loadFromFiles = false
        );
 
 
    //- Destructor
    virtual ~residuals();
 
 
    // Member Functions
 
        //- Return name of the set of field min/max
        virtual const word& name() const
        {
            return name_;
        }
 
        //- Read the field residuals data
        virtual void read(const dictionary&);
 
        //- Execute, currently does nothing
        virtual void execute();
 
        //- Execute 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();
 
        //- Calculate the field residuals
        template<class Type>
        void writeResidual(const word& fieldName);
 
        //- Write the residuals
        virtual void write();
 
        //- Update for changes of mesh
        virtual void updateMesh(const mapPolyMesh&)
        {}
 
        //- Update for changes of mesh
        virtual void movePoints(const polyMesh&)
        {}
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#ifdef NoRepository
#   include "residualsTemplates.C"
#endif
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //