/usr/include/freefoam/conversion/boundaryRegion.H is in libfreefoam-dev 0.1.0+dfsg-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
\\/ 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
\*---------------------------------------------------------------------------*/
#ifndef boundaryRegion_H
#define boundaryRegion_H
#include <OpenFOAM/polyMesh.H>
#include <OpenFOAM/Map.H>
#include <OpenFOAM/dictionary.H>
#include <OpenFOAM/labelList.H>
#include <OpenFOAM/wordList.H>
#include <OpenFOAM/wordReList.H>
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class boundaryRegion Declaration
\*---------------------------------------------------------------------------*/
class boundaryRegion
:
public Map<dictionary>
{
// Private Member Functions
//- Disallow default bitwise copy construct
boundaryRegion(const boundaryRegion&);
public:
// Constructors
//- Construct null
boundaryRegion();
//- Construct read from registry, name. instance
boundaryRegion
(
const objectRegistry&,
const word& name = "boundaryRegion",
const fileName& instance = "constant"
);
//- 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 List<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
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************ vim: set sw=4 sts=4 et: ************************ //
|