File size: 4,305 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / 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::patchIdentifier
Description
Identifies patch by name, patch index and physical type
SourceFiles
patchIdentifier.C
\*---------------------------------------------------------------------------*/
#ifndef patchIdentifier_H
#define patchIdentifier_H
#include "wordList.H"
#include "label.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
class dictionary;
// Forward declaration of friend functions and operators
class patchIdentifier;
Ostream& operator<<(Ostream&, const patchIdentifier&);
/*---------------------------------------------------------------------------*\
Class patchIdentifier Declaration
\*---------------------------------------------------------------------------*/
class patchIdentifier
{
protected:
// Protected Data
//- Name of patch
word name_;
//- Index of patch in boundary
label index_;
//- Optional physical type
word physicalType_;
//- Optional groups patch belongs to
wordList inGroups_;
public:
// Constructors
//- Construct from components
patchIdentifier
(
const word& name,
const label index,
const word& physicalType = word::null,
const wordList& inGroups = wordList()
);
//- Construct from dictionary
patchIdentifier
(
const word& name,
const dictionary&,
const label index
);
//- Construct from geometric patch, resetting the index
patchIdentifier
(
const patchIdentifier&,
const label index
);
//- Destructor
virtual ~patchIdentifier();
// Member Functions
//- Return name
const word& name() const
{
return name_;
}
//- Return the index of this patch in the boundaryMesh
label index() const
{
return index_;
}
//- Return the optional physical type of the patch
const word& physicalType() const
{
return physicalType_;
}
//- Return the optional physical type of the patch for modification
word& physicalType()
{
return physicalType_;
}
//- Return the optional groups patch belongs to
const wordList& inGroups() const
{
return inGroups_;
}
//- Return the optional groups patch belongs to for modification
wordList& inGroups()
{
return inGroups_;
}
//- Test if in group
bool inGroup(const word&) const;
//- Write patchIdentifier as a dictionary
void write(Ostream&) const;
// Ostream Operator
friend Ostream& operator<<(Ostream&, const patchIdentifier&);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|