GIT: Initial state after latest Foundation merge

src/functionObjects/solvers/scalarTransport/scalarTransport.H

@@ -0,0 +1,193 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2012-2016 OpenFOAM Foundation
+     \\/     M anipulation  | Copyright (C) 2015-2016 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::scalarTransport
+
+Group
+    grpSolversFunctionObjects
+
+Description
+    Evolves a passive scalar transport equation.
+
+    - To specify the field name set the 'field' entry
+    - To employ the same numerical schemes as another field set
+      the 'schemesField' entry,
+    - The diffusivity can be set manually using the 'D' entry, or retrieved
+      from the turbulence model (if applicable).
+
+
+    Example of function object specification to solve a scalar transport
+    equation:
+    \verbatim
+    functions
+    {
+        scalar1
+        {
+            type            scalarTransport;
+            functionObjectLibs ("libutilityFunctionObjects.so");
+
+            fvOptions
+            {
+                ...
+            }
+        }
+    }
+    \endverbatim
+
+    \heading Function object usage
+    \table
+        Property     | Description             | Required    | Default value
+        type         | Type name: scalarTransport | yes      |
+        phi          | Name of flux field      | no          | phi
+        rho          | Name of density field   | no          | rho
+        D            | Diffision coefficient   | no          | auto generated
+        nCorr        | Number of correctors    | no          | 0
+        resetOnStartUp | Reset scalar to zero on start-up | no | no
+        schemesField | Name of field to specify schemes | no | fieldName
+        fvOptions    | List of scalar sources  | no          |
+    \endtable
+
+See also
+    Foam::functionObjects::fvMeshFunctionObject
+
+SourceFiles
+    scalarTransport.C
+
+\*---------------------------------------------------------------------------*/
+
+#ifndef functionObjects_scalarTransport_H
+#define functionObjects_scalarTransport_H
+
+#include "fvMeshFunctionObject.H"
+#include "volFields.H"
+#include "fvOptionList.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+namespace Foam
+{
+namespace functionObjects
+{
+
+/*---------------------------------------------------------------------------*\
+                       Class scalarTransport Declaration
+\*---------------------------------------------------------------------------*/
+
+class scalarTransport
+:
+    public fvMeshFunctionObject
+{
+    // Private data
+
+        //- Name of field to process
+        word fieldName_;
+
+        //- On/off switch
+        bool active_;
+
+        //- Name of flux field (optional)
+        word phiName_;
+
+        //- Name of density field (optional)
+        word rhoName_;
+
+        //- Diffusion coefficient (optional)
+        scalar D_;
+
+        //- Flag to indicate whether a constant, uniform D_ is specified
+        bool constantD_;
+
+        //- Number of corrector iterations (optional)
+        label nCorr_;
+
+        //- Flag to reset the scalar to zero on start-up
+        bool resetOnStartUp_;
+
+        //- Name of field whose schemes are used (optional)
+        word schemesField_;
+
+        //- Run-time selectable finite volume options, e.g. sources, constraints
+        fv::optionList fvOptions_;
+
+
+    // Private Member Functions
+
+        //- Return reference to registered transported field
+        volScalarField& transportedField();
+
+        //- Return the diffusivity field
+        tmp<volScalarField> D(const surfaceScalarField& phi) const;
+
+        //- Disallow default bitwise copy construct
+        scalarTransport(const scalarTransport&) = delete;
+
+        //- Disallow default bitwise assignment
+        void operator=(const scalarTransport&) = delete;
+
+
+public:
+
+    //- Runtime type information
+    TypeName("scalarTransport");
+
+
+    // Constructors
+
+        //- Construct from Time and dictionary
+        scalarTransport
+        (
+            const word& name,
+            const Time& runTime,
+            const dictionary& dict
+        );
+
+
+    //- Destructor
+    virtual ~scalarTransport();
+
+
+    // Member Functions
+
+        //- Read the scalarTransport data
+        virtual bool read(const dictionary&);
+
+        //- Calculate the scalarTransport
+        virtual bool execute();
+
+        //- Do nothing.
+        //  The volScalarField is registered and written automatically
+        virtual bool write();
+};
+
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+} // End namespace functionObjects
+} // End namespace Foam
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#endif
+
+// ************************************************************************* //