Files
OpenFOAM-12/etc/codeTemplates/dynamicCode/codedFunction2Template.C
Will Bainbridge ddeaa566ef coded: Permit both untyped and typed substitutions
Coded functionality now supports basic un-typed substitutions from the
surrounding dictionary. For example:

    value 1.2345;

    #codeExecute
    {
        scalar s = $value;
        ...
    };

It also now supports the more functional typed substitutions, such as:

    direction (1 0 0);

    #codeExecute
    {
        vector v = $<vector>direction;
        ...
    };

These substitutions are now possible in all code blocks. Blocks with
access to the dictionary (e.g., #codeRead) will do a lookup which will
not require re-compilation if the value is changed. Blocks without
access to the dictionary will have the value directly substituted, and
will require recompilation when the value is changed.
2024-01-10 15:41:57 +00:00

129 lines
3.4 KiB
C++

/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) YEAR OpenFOAM Foundation
\\/ 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 "codedFunction2Template.H"
#include "read.H"
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
namespace Foam
{
namespace Function2s
{
defineTypeNameAndDebug(${typeName}Function2${TemplateType}, 0);
}
Function2<${TemplateType}>::adddictionaryConstructorToTable<Function2s::
${typeName}Function2${TemplateType}>
${typeName}Function2${TemplateType}ConstructorToTable_;
}
// * * * * * * * * * * * * * * * Global Functions * * * * * * * * * * * * * //
extern "C"
{
// dynamicCode:
// SHA1 = ${SHA1sum}
//
// Unique function name that can be checked if the correct library version
// has been loaded
void ${typeName}_${SHA1sum}(bool load)
{
if (load)
{
// code that can be explicitly executed after loading
}
else
{
// code that can be explicitly executed before unloading
}
}
}
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
Foam::Function2s::${typeName}Function2${TemplateType}::
${typeName}Function2${TemplateType}
(
const word& entryName,
const dictionary& dict
)
:
FieldFunction2<${TemplateType}, ${typeName}Function2${TemplateType}>
(
entryName
)
{
if (${verbose})
{
Info<< "Construct ${typeName} sha1: ${SHA1sum} from dictionary\n";
}
}
Foam::Function2s::${typeName}Function2${TemplateType}::
${typeName}Function2${TemplateType}
(
const ${typeName}Function2${TemplateType}& f1
)
:
FieldFunction2<${TemplateType}, ${typeName}Function2${TemplateType}>
(
f1
)
{
if (${verbose})
{
Info<< "Construct ${typeName} sha1: ${SHA1sum} as copy\n";
}
}
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
Foam::Function2s::${typeName}Function2${TemplateType}::
~${typeName}Function2${TemplateType}()
{
if (${verbose})
{
Info<< "Destroy ${typeName} sha1: ${SHA1sum}\n";
}
}
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
void Foam::Function2s::${typeName}Function2${TemplateType}::write
(
Ostream& os
) const
{
NotImplemented;
}
// ************************************************************************* i/