File size: 4,440 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2023-2026 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::functionEntries::codeIncludeEntry
Description
Specify an include file or list of files for \#calc within \#codeBlock
For example if functions from transform.H are used in the \#calc expression
\verbatim
angleOfAttack 5; // degs
#codeBlock
angle #calc "-degToRad($angleOfAttack)";
#codeInclude "transform.H"
liftDir #calc "transform(Ry($angle), vector(0, 0, 1))";
dragDir #calc "transform(Ry($angle), vector(1, 0, 0))";
#endCodeBlock
\endverbatim
The usual expansion of environment variables and other constructs
(eg, the ~OpenFOAM/ expansion) is retained.
If multiple include files are required multiple \#codeInclude entries can
be used or more conveniently a list of file names specified, e.g.
\verbatim
#codeInclude ("transform.H" "Field.H")
\endverbatim
or formatted in a column if is a larger number of include files required:
\verbatim
#codeInclude
(
"transform.H"
"Field.H"
)
\endverbatim
See also
Foam::functionEntries::calcEntry
SourceFiles
codeIncludeEntry.C
\*---------------------------------------------------------------------------*/
#ifndef codeIncludeEntry_H
#define codeIncludeEntry_H
#include "functionEntry.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace functionEntries
{
/*---------------------------------------------------------------------------*\
Class codeIncludeEntry Declaration
\*---------------------------------------------------------------------------*/
class codeIncludeEntry
:
public functionEntry
{
// Private data
//- List of file names
List<fileName> fNames_;
public:
//- Runtime type information
FunctionTypeName("#codeInclude");
// Constructors
//- Construct from line number, dictionary and Istream
codeIncludeEntry
(
const label lineNumber,
const dictionary& parentDict,
Istream& is
);
//- Copy construct
codeIncludeEntry(const codeIncludeEntry&) = default;
//- Clone
virtual autoPtr<entry> clone(const dictionary&) const
{
return autoPtr<entry>(new codeIncludeEntry(*this));
}
// Member Functions
//- Execute the functionEntry in a sub-dict context
virtual bool execute(dictionary& parentDict, Istream&);
//- Return the include file names
const List<fileName>& fileNames() const
{
return fNames_;
}
//- Add the codeInclude entry to codeDict
static void addCodeInclude
(
const List<fileName>& fileNames,
const dictionary& contextDict,
dictionary& codeDict
);
// Member Operators
//- Disallow default bitwise assignment
void operator=(const codeIncludeEntry&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace functionEntries
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|