enstrophy.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) 2016 OpenFOAM Foundation
    Copyright (C) 2020 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::functionObjects::enstrophy
 
Group
    grpFieldFunctionObjects
 
Description
    Computes the enstrophy of an input \c volVectorField.
 
    Enstrophy, i.e. \f$\xi\f$:
 
    \f[
        \xi = 0.5 mag(\nabla \times \vec U )^2
    \f]
 
    where \f$\vec U\f$ is the input \c volVectorField.
 
    Operands:
    \table
      Operand           | Type           | Location
      input             | volVectorField | $FOAM_CASE/<time>/<inpField>
      output file       | -              | -
      output field      | volScalarField | $FOAM_CASE/<time>/<outField>
    \endtable
 
Usage
    Minimal example by using \c system/controlDict.functions:
    \verbatim
    enstrophy1
    {
        // Mandatory entries (unmodifiable)
        type            enstrophy;
        libs            (fieldFunctionObjects);
 
        // Optional (inherited) entries
        ...
    }
    \endverbatim
 
    where the entries mean:
    \table
        Property     | Description                        | Type | Req'd | Dflt
        type         | Type name: enstrophy               | word |  yes  | -
        libs         | Library name: fieldFunctionObjects | word |  yes  | -
    \endtable
 
    The inherited entries are elaborated in:
     - \link functionObject.H \endlink
     - \link fieldExpression.H \endlink
 
    Minimal example by using the \c postProcess utility:
    \verbatim
        postProcess -func enstrophy
    \endverbatim
 
See also
    - Foam::functionObject
    - Foam::functionObjects::fvMeshFunctionObject
    - Foam::functionObjects::fieldExpression
    - ExtendedCodeGuide::functionObjects::field::enstrophy
 
SourceFiles
    enstrophy.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef functionObjects_enstrophy_H
#define functionObjects_enstrophy_H
 
#include "fieldExpression.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
namespace functionObjects
{
 
/*---------------------------------------------------------------------------*\
                          Class enstrophy Declaration
\*---------------------------------------------------------------------------*/
 
class enstrophy
:
    public fieldExpression
{
    // Private Member Functions
 
        //- Calculate the enstrophy field and return true if successful
        virtual bool calc();
 
 
public:
 
    //- Runtime type information
    TypeName("enstrophy");
 
 
    // Constructors
 
        //- Construct from Time and dictionary
        enstrophy
        (
            const word& name,
            const Time& runTime,
            const dictionary& dict
        );
 
        //- No copy construct
        enstrophy(const enstrophy&) = delete;
 
        //- No copy assignment
        void operator=(const enstrophy&) = delete;
 
 
    //- Destructor
    virtual ~enstrophy() = default;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace functionObjects
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //