| /*---------------------------------------------------------------------------*\ | |
| ========= | | |
| \\ / 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::zoneSet | |
| Description | |
| Zone container returned by zoneGenerator::generate | |
| Optionally contains any combination of point, cell or face zones generated | |
| by the zoneGenerator::generate function which may simply be the zones | |
| returned by a lookup from the lists of zones stored on the mesh or generated | |
| by the particular \c zoneGenerator from a geometric search for example. | |
| Having \c zoneSet optionally hold zones of more than one type is | |
| particularly useful for the generation of complex coupled or related zone | |
| systems, for example rotating regions requiring both the \c cellZone of the | |
| rotating cells and the faces of the outer moving/sliding boundary. | |
| SourceFiles | |
| zoneSetI.H | |
| zoneSet.C | |
| See also | |
| Foam::zoneGenerator | |
| \*---------------------------------------------------------------------------*/ | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| namespace Foam | |
| { | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| //- Enumeration defining the zone types | |
| enum class zoneTypes | |
| { | |
| point, | |
| cell, | |
| face | |
| }; | |
| //- Named enumeration defining the zone type names | |
| extern const NamedEnum<zoneTypes, 3> zoneTypesNames; | |
| //- Enumeration defining the zone types with an option for all the types | |
| enum class zoneTypesAll | |
| { | |
| point, | |
| cell, | |
| face, | |
| all | |
| }; | |
| //- Named enumeration defining the zone type names | |
| // with an option for all the types | |
| extern const NamedEnum<zoneTypesAll, 4> zoneTypesAllNames; | |
| /*---------------------------------------------------------------------------*\ | |
| Class zoneSet Declaration | |
| \*---------------------------------------------------------------------------*/ | |
| class zoneSet | |
| { | |
| // Private Data | |
| //- Temporary pointZone | |
| tmpNrc<pointZone> pZone_; | |
| //- Temporary cellZone | |
| tmpNrc<cellZone> cZone_; | |
| //- Temporary faceZone | |
| tmpNrc<faceZone> fZone_; | |
| // Private Member Functions | |
| //- Print to FatalError the names of all the types zones allocated | |
| template<class ZoneType> | |
| void checkValid(const tmpNrc<ZoneType>& zone) const; | |
| public: | |
| // Constructors | |
| //- Construct null | |
| inline zoneSet(); | |
| //- Construct copy transferring content of temporaries | |
| inline zoneSet(const zoneSet&); | |
| //- Construct copy moving content | |
| inline zoneSet(zoneSet&&) = default; | |
| //- Construct from pointZone pointer | |
| inline zoneSet(pointZone* pointZonePtr); | |
| //- Construct from cellZone pointer | |
| inline zoneSet(cellZone* cellZonePtr); | |
| //- Construct from faceZone pointer | |
| inline zoneSet(faceZone* faceZonePtr); | |
| //- Construct from pointZone, cellZone and faceZone pointers | |
| inline zoneSet | |
| ( | |
| pointZone* pointZonePtr, | |
| cellZone* cellZonePtr, | |
| faceZone* faceZonePtr | |
| ); | |
| //- Construct from pointZone | |
| inline zoneSet(const pointZone& pointZoneRef); | |
| //- Construct from cellZone | |
| inline zoneSet(const cellZone& cellZoneRef); | |
| //- Construct from faceZone | |
| inline zoneSet(const faceZone& faceZoneRef); | |
| //- Construct copy transferring content of temporaries if required | |
| inline zoneSet(const zoneSet&, bool allowTransfer); | |
| //- Construct and return a clone with a new name | |
| inline zoneSet clone(const word& name) const; | |
| // Member Functions | |
| //- Return true if the pointZone is allocated | |
| inline bool pValid() const; | |
| //- Return true if the cellZone is allocated | |
| inline bool cValid() const; | |
| //- Return true if the faceZone is allocated | |
| inline bool fValid() const; | |
| //- Return true if any of the zone types are allocated | |
| inline bool valid() const; | |
| //- Return true if the zone type specified by template specialisation | |
| // is allocated | |
| template<class ZoneType> | |
| inline bool valid() const; | |
| //- Return a reference to the pointZone if allocated | |
| // otherwise stop with an error | |
| inline const pointZone& pZone() const; | |
| //- Return a reference to the cellZone if allocated | |
| // otherwise stop with an error | |
| inline const cellZone& cZone() const; | |
| //- Return a reference to the faceZone if allocated | |
| // otherwise stop with an error | |
| inline const faceZone& fZone() const; | |
| //- Return a reference to the zone type | |
| // specified by template specialisation if allocated | |
| // otherwise stop with an error | |
| template<class ZoneType> | |
| inline const ZoneType& zone() const; | |
| //- Store the temporary zones and return the stored zoneSet | |
| zoneSet store() const; | |
| // Member Operators | |
| //- Assignment transferring the temporary zones | |
| void operator=(const zoneSet&); | |
| //- Assignment moving content | |
| inline zoneSet& operator=(zoneSet&&) = default; | |
| //- Assignment to pointZone, updating pZone_ | |
| inline void operator=(const pointZone&); | |
| //- Assignment to cellZone, updating cZone_ | |
| inline void operator=(const cellZone&); | |
| //- Assignment to faceZone, updating fZone_ | |
| inline void operator=(const faceZone&); | |
| }; | |
| template<> | |
| inline bool zoneSet::valid<pointZone>() const; | |
| template<> | |
| inline bool zoneSet::valid<cellZone>() const; | |
| template<> | |
| inline bool zoneSet::valid<faceZone>() const; | |
| template<> | |
| inline const pointZone& zoneSet::zone<pointZone>() const; | |
| template<> | |
| inline const cellZone& zoneSet::zone<cellZone>() const; | |
| template<> | |
| inline const faceZone& zoneSet::zone<faceZone>() const; | |
| template<class ZoneType> | |
| inline zoneTypes zoneType(); | |
| template<> | |
| inline zoneTypes zoneType<pointZone>(); | |
| template<> | |
| inline zoneTypes zoneType<cellZone>(); | |
| template<> | |
| inline zoneTypes zoneType<faceZone>(); | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| } // End namespace Foam | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| // ************************************************************************* // | |