File size: 5,227 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2025-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::zoneGenerator
Description
Abstract base class for all zoneGenerators, providing runtime selection
See also
Foam::zoneSet
Foam::zoneGeneratorList
SourceFiles
zoneGenerator.C
\*---------------------------------------------------------------------------*/
#ifndef zoneGenerator_H
#define zoneGenerator_H
#include "zoneSet.H"
#include "runTimeSelectionTables.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of classes
class polyMesh;
/*---------------------------------------------------------------------------*\
Class zoneGenerator Declaration
\*---------------------------------------------------------------------------*/
class zoneGenerator
{
protected:
// Protected Data
//- Name of zone generator
const word name_;
//- Dictionary cached for error context
const dictionary dict_;
//- Name of the zone (defaults to the name of the generator)
const word zoneName_;
//- Reference to the polyMesh
const polyMesh& mesh_;
//- Switch to update the zones if the mesh points are moved
mutable bool moveUpdate_;
public:
friend class zoneGeneratorList;
//- Runtime type information
TypeName("zoneGenerator");
// Declare run-time constructor selection table
declareRunTimeSelectionTable
(
autoPtr,
zoneGenerator,
dictionary,
(
const word& name,
const polyMesh& mesh,
const dictionary& dict
),
(name, mesh, dict)
);
// Constructors
//- Construct from name, polyMesh and dictionary
zoneGenerator
(
const word& name,
const polyMesh& mesh,
const dictionary& dict
);
//- Disallow default bitwise copy construction
zoneGenerator(const zoneGenerator&) = delete;
// Selectors
//- Select constructed from name, mesh and dictionary
static autoPtr<zoneGenerator> New
(
const word& name,
const polyMesh& mesh,
const dictionary& dict
);
//- Select constructed from name, zoneType, mesh and dictionary
static autoPtr<zoneGenerator> New
(
const word& name,
const zoneTypes& zoneType,
const polyMesh& mesh,
const dictionary& dict
);
//- Select constructed from mesh and first valid dictionary
static autoPtr<zoneGenerator> New
(
const polyMesh& mesh,
const dictionary& dict
);
//- Destructor
virtual ~zoneGenerator();
// Member Functions
//- Return the zoneGenerator name
const word& name() const
{
return name_;
}
//- Return the zone name
const word& zoneName() const
{
return zoneName_;
}
//- Return reference to the polyMesh
const polyMesh& mesh() const
{
return mesh_;
}
//- Return the list of selected indices
static labelList indices(const boolList& selected);
//- Return true if the zoneGenerator updates any of the zones
// following mesh point motion
bool moveUpdate() const
{
return moveUpdate_;
}
//- Generate and return the zoneSet
virtual zoneSet generate() const = 0;
//- Regenerate the zoneSet following mesh point motion
virtual zoneSet movePoints() const;
// Member Operators
//- Disallow default bitwise assignment
void operator=(const zoneGenerator&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|