File size: 5,387 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 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2016-2025 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::includeFuncEntry
Description
Specify a functionObject dictionary file to include, expects the
functionObject name to follow with option arguments (without quotes).
Searches for functionObject dictionary file in user/group/shipped
directories allowing for version-specific and version-independent files
using the following hierarchy:
- \b user settings:
- ~/.OpenFOAM/\<VERSION\>/caseDicts/functions
- ~/.OpenFOAM/caseDicts/functions
- \b group (site) settings (when $WM_PROJECT_SITE is set):
- $WM_PROJECT_SITE/\<VERSION\>/etc/caseDicts/functions
- $WM_PROJECT_SITE/etc/caseDicts/functions
- \b group (site) settings (when $WM_PROJECT_SITE is not set):
- $WM_PROJECT_INST_DIR/site/\<VERSION\>/etc/caseDicts/functions
- $WM_PROJECT_INST_DIR/site/etc/caseDicts/functions
- \b other (shipped) settings:
- $WM_PROJECT_DIR/etc/caseDicts/functions
The optional field arguments included in the name are inserted in 'field' or
'fields' entries in the functionObject dictionary and included in the name
of the functionObject entry to avoid conflict.
Examples:
\verbatim
#includeFunc Q
#includeFunc components(U)
#includeFunc mag(Ux)
#includeFunc mag(p)
\endverbatim
Other dictionary entries may also be specified using named arguments.
SourceFiles
includeFuncEntry.C
\*---------------------------------------------------------------------------*/
#ifndef includeFuncEntry_H
#define includeFuncEntry_H
#include "functionEntry.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace functionEntries
{
/*---------------------------------------------------------------------------*\
Class includeFuncEntry Declaration
\*---------------------------------------------------------------------------*/
class includeFuncEntry
:
public functionEntry
{
protected:
//- Return the function name + arguments string
// for processing by readConfigFile
Tuple2<string, label> funcNameArgs() const
{
Tuple2<string, label> fNameArgs
(
operator[](0).wordToken(),
operator[](0).lineNumber()
);
if (size() > 1)
{
fNameArgs.first() +=
char(operator[](1).pToken())
+ operator[](2).stringToken()
+ char(operator[](3).pToken());
}
return fNameArgs;
}
public:
//- Runtime type information
FunctionTypeName("#includeFunc");
// Constructors
//- Construct from functionType, dictionary and Istream
includeFuncEntry
(
const functionName& functionType,
const label lineNumber,
const dictionary& parentDict,
Istream& is
);
//- Construct from line number, dictionary and Istream
includeFuncEntry
(
const label lineNumber,
const dictionary& parentDict,
Istream& is
);
//- Copy construct
includeFuncEntry(const includeFuncEntry&) = default;
//- Clone
virtual autoPtr<entry> clone(const dictionary&) const
{
return autoPtr<entry>(new includeFuncEntry(*this));
}
// Static Data Members
//- Default relative path to the directory structure
// containing the functionObject dictionary files
static fileName functionObjectDictPath;
//- Default relative path to the directory structure
// containing the functionObject template files
static fileName functionObjectTemplatePath;
// Member Functions
//- Expand the functionEntry into the contextDict
virtual bool execute(dictionary& contextDict, Istream&);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace functionEntries
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|