ENH: coded version of PatchFunction1. See #1709.

etc/codeTemplates/dynamicCode/codedPatchFunction1Template.H

@@ -0,0 +1,151 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | www.openfoam.com
+     \\/     M anipulation  |
+-------------------------------------------------------------------------------
+    Copyright (C) 2020 OpenCFD Ltd.
+    Copyright (C) YEAR AUTHOR, AFFILIATION
+-------------------------------------------------------------------------------
+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/>.
+
+Description
+    Template for use with dynamic code generation of a PatchFunction1
+
+SourceFiles
+    codedPatchFunction1Template.C
+
+\*---------------------------------------------------------------------------*/
+
+#ifndef codedPatchFunction1Template${FieldType}_H
+#define codedPatchFunction1Template${FieldType}_H
+
+#include "PatchFunction1.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+namespace Foam
+{
+namespace PatchFunction1Types
+{
+
+/*---------------------------------------------------------------------------*\
+                        A coded version PatchFunction1
+\*---------------------------------------------------------------------------*/
+
+class ${typeName}PatchFunction1${FieldType}
+:
+    public PatchFunction1<${TemplateType}>
+{
+    // Private Member Functions
+
+        //- Report a message with the SHA1sum
+        inline static void printMessage(const char* message)
+        {
+            Info<< message << " sha1: " << SHA1sum << '\n';
+        }
+
+public:
+
+    //- SHA1 representation of the code content
+    static constexpr const char* const SHA1sum = "${SHA1sum}";
+
+    //- Runtime type information
+    TypeName("${typeName}");
+
+
+    // Constructors
+
+        //- Construct from patch and internal field
+        ${typeName}PatchFunction1${FieldType}
+        (
+            const polyPatch& pp,
+            const word& type,
+            const word& entryName,
+            const dictionary& dict,
+            const bool faceValues = true
+        );
+
+        //- Construct as copy
+        ${typeName}PatchFunction1${FieldType}
+        (
+            const ${typeName}PatchFunction1${FieldType}&
+        );
+
+        //- Construct as copy, resetting patch
+        ${typeName}PatchFunction1${FieldType}
+        (
+            const ${typeName}PatchFunction1${FieldType}&,
+            const polyPatch& pp
+        );
+
+        //- Construct and return a clone
+        virtual tmp<PatchFunction1<${TemplateType}>> clone() const
+        {
+            return tmp<PatchFunction1<${TemplateType}>>
+            (
+                new ${typeName}PatchFunction1${FieldType}(*this)
+            );
+        }
+
+        //- Construct and return a clone setting patch
+        virtual tmp<PatchFunction1<${TemplateType}>> clone
+        (
+            const polyPatch& pp
+        ) const
+        {
+            return tmp<PatchFunction1<${TemplateType}>>
+            (
+                new ${typeName}PatchFunction1${FieldType}(*this, pp)
+            );
+        }
+
+
+    //- Destructor
+    virtual ~${typeName}PatchFunction1${FieldType}() = default;
+
+
+    // Member Functions
+
+            //- Return value as a function of (scalar) independent variable
+            virtual tmp<Field<${TemplateType}>> value(const scalar x) const;
+
+            //- Is value constant (i.e. independent of x)
+            virtual bool constant() const
+            {
+                return false;
+            }
+
+            //- Is value uniform (i.e. independent of coordinate)
+            virtual bool uniform() const
+            {
+                return false;
+            }
+};
+
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+} // End namespace PatchFunction1Types
+} // End namespace Foam
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#endif
+
+// ************************************************************************* //