mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
354bc8bdcb
codedFunctionObject: Added the "codeWrite" entry
for the "write" function for consistency.
The previous method of using the "code" entry for the "write"
function was inconsistent and very confusing.
174 lines
4.0 KiB
C
174 lines
4.0 KiB
C
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2011-2016 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 "functionObjectTemplate.H"
|
|
#include "fvCFD.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:-false})
|
|
{
|
|
Info<<"read ${typeName} sha1: ${SHA1sum}\n";
|
|
}
|
|
|
|
//{{{ begin code
|
|
${codeRead}
|
|
//}}} end code
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
bool ${typeName}FunctionObject::execute(const bool postProcess)
|
|
{
|
|
if (${verbose:-false})
|
|
{
|
|
Info<<"execute ${typeName} sha1: ${SHA1sum}\n";
|
|
}
|
|
|
|
//{{{ begin code
|
|
${codeExecute}
|
|
//}}} end code
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
bool ${typeName}FunctionObject::write(const bool postProcess)
|
|
{
|
|
if (${verbose:-false})
|
|
{
|
|
Info<<"write ${typeName} sha1: ${SHA1sum}\n";
|
|
}
|
|
|
|
//{{{ begin code
|
|
${codeWrite}
|
|
//}}} end code
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
bool ${typeName}FunctionObject::end()
|
|
{
|
|
if (${verbose:-false})
|
|
{
|
|
Info<<"end ${typeName} sha1: ${SHA1sum}\n";
|
|
}
|
|
|
|
//{{{ begin code
|
|
${codeEnd}
|
|
//}}} end code
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// ************************************************************************* //
|