Function2: New run-time selectable function of two variables
with many options provided from simple constant values to complex functions, interpolated tabulated data etc. etc.
This commit is contained in:
Henry Weller
@ -93,7 +93,7 @@ public:
|
||||
|
||||
// Member Functions
|
||||
|
||||
//- Return constant value
|
||||
//- Return value as a function of scalar variable
|
||||
inline virtual ${TemplateType} value(const scalar x) const
|
||||
{
|
||||
//{{{ begin code
|
||||
|
||||
127
etc/codeTemplates/dynamicCode/Function2Template.C
Normal file
127
etc/codeTemplates/dynamicCode/Function2Template.C
Normal file
@ -0,0 +1,127 @@
|
||||
/*---------------------------------------------------------------------------*\
|
||||
========= |
|
||||
\\ / 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 "Function2Template.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:-false})
|
||||
{
|
||||
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:-false})
|
||||
{
|
||||
Info<< "Construct ${typeName} sha1: ${SHA1sum} as copy\n";
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
|
||||
|
||||
Foam::Function2s::${typeName}Function2${TemplateType}::
|
||||
~${typeName}Function2${TemplateType}()
|
||||
{
|
||||
if (${verbose:-false})
|
||||
{
|
||||
Info<< "Destroy ${typeName} sha1: ${SHA1sum}\n";
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
|
||||
|
||||
void Foam::Function2s::${typeName}Function2${TemplateType}::writeData
|
||||
(
|
||||
Ostream& os
|
||||
) const
|
||||
{
|
||||
NotImplemented;
|
||||
}
|
||||
|
||||
|
||||
// ************************************************************************* i/
|
||||
128
etc/codeTemplates/dynamicCode/Function2Template.H
Normal file
128
etc/codeTemplates/dynamicCode/Function2Template.H
Normal file
@ -0,0 +1,128 @@
|
||||
/*---------------------------------------------------------------------------*\
|
||||
========= |
|
||||
\\ / 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/>.
|
||||
|
||||
Description
|
||||
Template for use with dynamic code generation of a Function2.
|
||||
|
||||
- without state
|
||||
|
||||
SourceFiles
|
||||
Function2Template.C
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
#ifndef Function2Template_H
|
||||
#define Function2Template_H
|
||||
|
||||
#include "Function2.H"
|
||||
|
||||
//{{{ begin codeInclude
|
||||
${codeInclude}
|
||||
//}}} end codeInclude
|
||||
|
||||
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||
|
||||
namespace Foam
|
||||
{
|
||||
namespace Function2s
|
||||
{
|
||||
|
||||
/*---------------------------------------------------------------------------*\
|
||||
A templated Function2
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
class ${typeName}Function2${TemplateType}
|
||||
:
|
||||
public FieldFunction2<${TemplateType}, ${typeName}Function2${TemplateType}>
|
||||
{
|
||||
|
||||
public:
|
||||
|
||||
// Runtime type information
|
||||
TypeName("${typeName}");
|
||||
|
||||
|
||||
// Constructors
|
||||
|
||||
//- Construct from entry name and dictionary
|
||||
${typeName}Function2${TemplateType}
|
||||
(
|
||||
const word& entryName,
|
||||
const dictionary& dict
|
||||
);
|
||||
|
||||
//- Copy constructor
|
||||
${typeName}Function2${TemplateType}
|
||||
(
|
||||
const ${typeName}Function2${TemplateType}& f1
|
||||
);
|
||||
|
||||
//- Construct and return a clone
|
||||
virtual tmp<Function2<${TemplateType}>> clone() const
|
||||
{
|
||||
return tmp<Function2<${TemplateType}>>
|
||||
(
|
||||
new ${typeName}Function2${TemplateType}(*this)
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
//- Destructor
|
||||
virtual ~${typeName}Function2${TemplateType}();
|
||||
|
||||
|
||||
// Member Functions
|
||||
|
||||
//- Return value as a function of two scalars
|
||||
inline virtual ${TemplateType} value
|
||||
(
|
||||
const scalar x,
|
||||
const scalar y
|
||||
) const
|
||||
{
|
||||
//{{{ begin code
|
||||
${code}
|
||||
//}}} end code
|
||||
}
|
||||
|
||||
//- Write in dictionary format
|
||||
virtual void writeData(Ostream& os) const;
|
||||
|
||||
|
||||
// Member Operators
|
||||
|
||||
//- Disallow default bitwise assignment
|
||||
void operator=(const ${typeName}Function2${TemplateType}&) = delete;
|
||||
};
|
||||
|
||||
|
||||
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||
|
||||
} // End namespace Function2s
|
||||
} // End namespace Foam
|
||||
|
||||
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||
|
||||
#endif
|
||||
|
||||
// ************************************************************************* //
|
||||
Reference in New Issue
Block a user