| /*---------------------------------------------------------------------------*\ | |
| ========= | | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | |
| \\ / O peration | Website: https://openfoam.org | |
| \\ / A nd | Copyright (C) 2011-2020 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::boundaryRegion | |
| Description | |
| The boundaryRegion persistent data saved as a Map<dictionary>. | |
| The meshReader supports boundaryRegion information. | |
| The <tt>constant/boundaryRegion</tt> file is an \c IOMap<dictionary> | |
| that is used to save the information persistently. | |
| It contains the boundaryRegion information of the following form: | |
| \verbatim | |
| ( | |
| INT | |
| { | |
| BoundaryType WORD; | |
| Label WORD; | |
| } | |
| ... | |
| ) | |
| \endverbatim | |
| SourceFiles | |
| boundaryRegion.C | |
| \*---------------------------------------------------------------------------*/ | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| namespace Foam | |
| { | |
| /*---------------------------------------------------------------------------*\ | |
| Class boundaryRegion Declaration | |
| \*---------------------------------------------------------------------------*/ | |
| class boundaryRegion | |
| : | |
| public Map<dictionary> | |
| { | |
| public: | |
| // Constructors | |
| //- Construct null | |
| boundaryRegion(); | |
| //- Construct read from registry, name. instance | |
| boundaryRegion | |
| ( | |
| const objectRegistry&, | |
| const word& name = "boundaryRegion", | |
| const fileName& instance = "constant" | |
| ); | |
| //- Disallow default bitwise copy construction | |
| boundaryRegion(const boundaryRegion&) = delete; | |
| //- Destructor | |
| ~boundaryRegion(); | |
| // Member Functions | |
| //- Append to the end, return index | |
| label append(const dictionary&); | |
| //- Return index corresponding to patch 'name' | |
| // returns -1 if not found | |
| label findIndex(const word& name) const; | |
| //- Return a Map of (id => name) | |
| Map<word> names() const; | |
| //- Return a Map of (id => names) selected by patterns | |
| Map<word> names(const UList<wordRe>& patterns) const; | |
| //- Return a Map of (id => type) | |
| Map<word> boundaryTypes() const; | |
| //- Return BoundaryType corresponding to patch 'name' | |
| word boundaryType(const word& name) const; | |
| //- Read constant/boundaryRegion | |
| void readDict | |
| ( | |
| const objectRegistry&, | |
| const word& name = "boundaryRegion", | |
| const fileName& instance = "constant" | |
| ); | |
| //- Write constant/boundaryRegion for later reuse | |
| void writeDict | |
| ( | |
| const objectRegistry&, | |
| const word& name = "boundaryRegion", | |
| const fileName& instance = "constant" | |
| ) const; | |
| // Member Operators | |
| //- Assignment | |
| void operator=(const boundaryRegion&); | |
| //- Assign from Map<dictionary> | |
| void operator=(const Map<dictionary>&); | |
| // Friend Functions | |
| //- Rename regions | |
| // each dictionary entry is a single word: | |
| // \verbatim | |
| // newPatchName originalName; | |
| // \endverbatim | |
| void rename(const dictionary&); | |
| }; | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| } // End namespace Foam | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| // ************************************************************************* // | |