0927fd47fa
Specific names have been given for expand functions. Unused functions have been removed, and functions only used locally have been removed from the namespace. Documentation has been corrected. Default and alternative value handling has been removed from code template expansion.
190 lines
4.2 KiB
C++
190 lines
4.2 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 "codedFunctionObjectTemplate.H"
|
|
#include "volFields.H"
|
|
#include "unitConversion.H"
|
|
#include "addToRunTimeSelectionTable.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
|
|
|
|
defineTypeNameAndDebug(${typeName}FunctionObject, 0);
|
|
|
|
addRemovableToRunTimeSelectionTable
|
|
(
|
|
functionObject,
|
|
${typeName}FunctionObject,
|
|
dictionary
|
|
);
|
|
|
|
|
|
// * * * * * * * * * * * * * * * 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
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * Local Functions * * * * * * * * * * * * * * //
|
|
|
|
//{{{ begin localCode
|
|
${localCode}
|
|
//}}} end localCode
|
|
|
|
|
|
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
|
|
|
|
const fvMesh& ${typeName}FunctionObject::mesh() const
|
|
{
|
|
return refCast<const fvMesh>(obr_);
|
|
}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
|
|
|
|
${typeName}FunctionObject::${typeName}FunctionObject
|
|
(
|
|
const word& name,
|
|
const Time& runTime,
|
|
const dictionary& dict
|
|
)
|
|
:
|
|
functionObjects::regionFunctionObject(name, runTime, dict)
|
|
{
|
|
read(dict);
|
|
}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
|
|
|
|
${typeName}FunctionObject::~${typeName}FunctionObject()
|
|
{}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
|
|
|
|
bool ${typeName}FunctionObject::read(const dictionary& dict)
|
|
{
|
|
if (${verbose})
|
|
{
|
|
Info<<"read ${typeName} sha1: ${SHA1sum}\n";
|
|
}
|
|
|
|
//{{{ begin code
|
|
${codeRead}
|
|
//}}} end code
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
Foam::wordList ${typeName}FunctionObject::fields() const
|
|
{
|
|
if (${verbose})
|
|
{
|
|
Info<<"fields ${typeName} sha1: ${SHA1sum}\n";
|
|
}
|
|
|
|
wordList fields;
|
|
//{{{ begin code
|
|
${codeFields}
|
|
//}}} end code
|
|
|
|
return fields;
|
|
}
|
|
|
|
|
|
bool ${typeName}FunctionObject::execute()
|
|
{
|
|
if (${verbose})
|
|
{
|
|
Info<<"execute ${typeName} sha1: ${SHA1sum}\n";
|
|
}
|
|
|
|
//{{{ begin code
|
|
${codeExecute}
|
|
//}}} end code
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
bool ${typeName}FunctionObject::write()
|
|
{
|
|
if (${verbose})
|
|
{
|
|
Info<<"write ${typeName} sha1: ${SHA1sum}\n";
|
|
}
|
|
|
|
//{{{ begin code
|
|
${codeWrite}
|
|
//}}} end code
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
bool ${typeName}FunctionObject::end()
|
|
{
|
|
if (${verbose})
|
|
{
|
|
Info<<"end ${typeName} sha1: ${SHA1sum}\n";
|
|
}
|
|
|
|
//{{{ begin code
|
|
${codeEnd}
|
|
//}}} end code
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// ************************************************************************* //
|