ENh: Adding flux FO

src/functionObjects/field/flux/flux.C

@@ -0,0 +1,92 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2016 OpenCFD Ltd.
+     \\/     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/>.
+
+\*---------------------------------------------------------------------------*/
+
+#include "flux.H"
+#include "volFields.H"
+#include "surfaceFields.H"
+#include "addToRunTimeSelectionTable.H"
+#include "geometricOneField.H"
+
+// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
+
+namespace Foam
+{
+namespace functionObjects
+{
+    defineTypeNameAndDebug(flux, 0);
+    addToRunTimeSelectionTable(functionObject, flux, dictionary);
+}
+}
+
+
+// * * * * * * * * * * * * * Private Member Functions  * * * * * * * * * * * //
+
+bool Foam::functionObjects::flux::calc()
+{
+    bool processed = false;
+
+    if (rhoName_ == "none")
+    {
+        processed =
+            processed
+         || calcSurFlux<surfaceVectorField>(geometricOneField());
+
+        processed =
+            processed
+         || calcVolFlux<volVectorField>(geometricOneField());
+    }
+    else
+    {
+        const volScalarField& rho =
+            mesh_.lookupObject<volScalarField>(rhoName_);
+        processed = processed || calcSurFlux<surfaceVectorField>(rho);
+        processed = processed || calcVolFlux<volVectorField>(rho);
+    }
+
+    return processed;
+}
+
+
+// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
+
+Foam::functionObjects::flux::flux
+(
+    const word& name,
+    const Time& runTime,
+    const dictionary& dict
+)
+:
+    fieldExpression(name, runTime, dict),
+    rhoName_(dict.lookupOrDefault<word>("rho", "none"))
+{}
+
+
+// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
+
+Foam::functionObjects::flux::~flux()
+{}
+
+
+// ************************************************************************* //

src/functionObjects/field/flux/flux.H

@@ -0,0 +1,117 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2016 OpenCFD Ltd.
+     \\/     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::functionObjects::flux
+
+Group
+    grpFieldFunctionObjects
+
+Description
+    Calculates the flux of a field.  The operation is limited to
+    surfaceVectorFields and volVectorFields, and the output is a surfaceScalarField.
+
+See also
+    Foam::functionObjects::fieldExpression
+    Foam::functionObjects::fvMeshFunctionObject
+
+SourceFiles
+    flux.C
+
+\*---------------------------------------------------------------------------*/
+
+#ifndef functionObjects_flux_H
+#define functionObjects_flux_H
+
+#include "fieldExpression.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+namespace Foam
+{
+namespace functionObjects
+{
+
+/*---------------------------------------------------------------------------*\
+                         Class flux Declaration
+\*---------------------------------------------------------------------------*/
+
+class flux
+:
+    public fieldExpression
+{
+    // Private Member Functions
+
+        //- Calculate the flux of a volVectorField and register the result
+        template<class FieldType, class RhoFieldType>
+        bool calcVolFlux(const RhoFieldType& rho);
+
+        //- Calculate the flux of a surfaceVectorField and register the result
+        template<class FieldType, class RhoFieldType>
+        bool calcSurFlux(const RhoFieldType& rho);
+
+        //- Calculate the flux field and return true if successful
+        virtual bool calc();
+
+        //- rho flied name
+        word rhoName_;
+
+
+public:
+
+    //- Runtime type information
+    TypeName("flux");
+
+
+    // Constructors
+
+        //- Construct from Time and dictionary
+        flux
+        (
+            const word& name,
+            const Time& runTime,
+            const dictionary& dict
+        );
+
+
+    //- Destructor
+    virtual ~flux();
+};
+
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+} // End namespace functionObjects
+} // End namespace Foam
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#ifdef NoRepository
+    #include "fluxTemplates.C"
+#endif
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#endif
+
+// ************************************************************************* //

src/functionObjects/field/flux/fluxTemplates.C

@@ -0,0 +1,70 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2016 OpenCFD Ltd.
+     \\/     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/>.
+
+\*---------------------------------------------------------------------------*/
+
+#include "fvcFlux.H"
+#include "surfaceInterpolate.H"
+
+// * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
+
+template<class FieldType,  class RhoFieldType>
+bool Foam::functionObjects::flux::calcVolFlux(const RhoFieldType& rho)
+{
+
+    if (foundObject<FieldType>(fieldName_, false))
+    {
+        return store
+        (
+            resultName_,
+            fvc::flux(rho*lookupObject<FieldType>(fieldName_))
+        );
+    }
+    else
+    {
+        return false;
+    }
+}
+
+
+template<class FieldType,  class RhoFieldType>
+bool Foam::functionObjects::flux::calcSurFlux(const RhoFieldType& rho)
+{
+
+    if (foundObject<FieldType>(fieldName_, false))
+    {
+        return store
+        (
+            resultName_,
+            (
+                fvc::interpolate(rho)
+               *lookupObject<FieldType>(fieldName_)
+            ) & mesh_.Sf()
+        );
+    }
+    else
+    {
+        return false;
+    }
+}
+// ************************************************************************* //