File size: 5,531 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 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 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::zoneGenerators::coded
Description
Coded zoneGenerator
The code provided should set \c pointIndices and/or \c cellIndices
and/or \c faceIndices and optionally \c faceMap. These index lists
are automatically converted into the corresponding zones in the \c zoneSet
which is returned by the \c zoneGenerator.
The entries are:
\plaintable
code | Code to set pointIndices, cellIndices, faceIndices
codeInclude | Include files
codeOptions | Include paths; inserted into EXE_INC in Make/options
codeLibs | Link line; inserted into LIB_LIBS in Make/options
\endplaintable
Example of a zoneGenerators::coded which creates a \c cellZone of the cells
in which the value of the turbulent kinetic energy is within the highest
10%:
\verbatim
cellZone
{
type coded;
// Regenerate cellZone for every evaluation
regenerate yes;
code
#{
// Lookup field from the objectRegistry, e.g. k
const volScalarField& k = mesh().lookupObject<volScalarField>("k");
// Calculate the minimum and maximum k values
const scalar mink = min(k).value();
const scalar maxk = max(k).value();
// Fraction of the range of k
const scalar f = 0.1;
// Lowest k in selection
const scalar lowk = f*mink + (1.0 - f)*maxk;
cellIndices = selectIndices
(
k,
[&](const scalar k)
{
return k > lowk;
}
);
#};
}
\endverbatim
See also
Foam::zoneGenerator
Foam::codedBase
SourceFiles
coded_zoneGenerator.C
\*---------------------------------------------------------------------------*/
#ifndef coded_zoneGenerator_H
#define coded_zoneGenerator_H
#include "zoneGenerator.H"
#include "codedBase.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace zoneGenerators
{
/*---------------------------------------------------------------------------*\
Class coded Declaration
\*---------------------------------------------------------------------------*/
class coded
:
public zoneGenerator,
public codedBase
{
// Private Data
//- Keywords associated with source code
static const wordList codeKeys;
//- Name of the dictionary variables in the source code
static const wordList codeDictVars;
// Name of the code options template file
static const word codeOptions;
// Names of the source files to compile
static const wordList compileFiles;
// Names of the source files to copy (header files)
static const wordList copyFiles;
//- The dynamically generated zoneGenerator pointer
mutable autoPtr<zoneGenerator> redirectZoneGeneratorPtr_;
public:
//- Runtime type information
TypeName("coded");
// Constructors
//- Construct from name, polyMesh and dictionary
coded
(
const word& name,
const polyMesh& mesh,
const dictionary& dict
);
//- Disallow default bitwise copy construction
coded(const coded&) = delete;
//- Destructor
virtual ~coded();
// Member Functions
//- Generate and return the zoneSet
virtual zoneSet generate() const;
// Member Operators
//- Disallow default bitwise assignment
void operator=(const coded&) = delete;
};
//- Helper struct to enable the zone type for the corresponding list of indices
// which allows for the generation of empty zones
struct enabledLabelList
:
public labelList
{
bool enabled_;
enabledLabelList()
:
enabled_(false)
{}
void operator=(const labelList& indices)
{
labelList::operator=(indices);
enabled_ = true;
}
bool enabled() const
{
return enabled_ || size();
}
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace zoneGenerators
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|