mirror of
https://github.com/OpenFOAM/OpenFOAM-6.git
synced 2025-12-08 06:57:46 +00:00
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.
147 lines
3.6 KiB
C++
147 lines
3.6 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/>.
|
|
|
|
Class
|
|
Foam::dynamicCodeContext
|
|
|
|
Description
|
|
Encapsulation of dynamic code dictionaries
|
|
|
|
SourceFiles
|
|
dynamicCodeContext.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef dynamicCodeContext_H
|
|
#define dynamicCodeContext_H
|
|
|
|
#include "dictionary.H"
|
|
#include "SHA1Digest.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class dynamicCodeContext Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class dynamicCodeContext
|
|
{
|
|
// Private data
|
|
|
|
//- The parent dictionary context
|
|
const dictionary& dict_;
|
|
|
|
//- Optional "code" entry
|
|
string code_;
|
|
|
|
//- Optional "localCode" entry
|
|
string localCode_;
|
|
|
|
//- Optional "codeInclude" entry
|
|
string include_;
|
|
|
|
//- Optional "codeOptions" entry
|
|
string options_;
|
|
|
|
//- Optional "codeLib" entry
|
|
string libs_;
|
|
|
|
//- Calculated SHA1Digest
|
|
SHA1Digest sha1_;
|
|
|
|
|
|
public:
|
|
|
|
// Constructors
|
|
|
|
//- Construct from a dictionary
|
|
dynamicCodeContext(const dictionary&);
|
|
|
|
|
|
// Member functions
|
|
|
|
//- Return the parent dictionary context
|
|
const dictionary& dict() const
|
|
{
|
|
return dict_;
|
|
}
|
|
|
|
//- Return the code-includes
|
|
const string& include() const
|
|
{
|
|
return include_;
|
|
}
|
|
|
|
//- Return the code-options
|
|
const string& options() const
|
|
{
|
|
return options_;
|
|
}
|
|
|
|
//- Return the code-libs
|
|
const string& libs() const
|
|
{
|
|
return libs_;
|
|
}
|
|
|
|
//- Return the code
|
|
const string& code() const
|
|
{
|
|
return code_;
|
|
}
|
|
|
|
//- Return the local (file-scope) code
|
|
const string& localCode() const
|
|
{
|
|
return localCode_;
|
|
}
|
|
|
|
//- Return SHA1 digest calculated from include, options, code
|
|
const SHA1Digest& sha1() const
|
|
{
|
|
return sha1_;
|
|
}
|
|
|
|
//- Helper: add \#line directive
|
|
static void addLineDirective
|
|
(
|
|
string&,
|
|
const label lineNum,
|
|
const fileName& name
|
|
);
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|