/usr/include/freefoam/OpenFOAM/FaceCellWave.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 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 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 | /*---------------------------------------------------------------------------*\
========= |
\\ / 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::FaceCellWave
Description
Wave propagation of information through grid. Every iteration
information goes through one layer of cells. Templated on information
that is transferred.
Handles parallel and cyclics and non-parallel cyclics.
Note: whether to propagate depends on the return value of Type::update
which returns true (i.e. propagate) if the value changes by more than a
certain tolerance.
This tolerance can be very strict for normal face-cell and parallel
cyclics (we use a value of 0.01 just to limit propagation of small changes)
but for non-parallel cyclics this tolerance can be critical and if chosen
too small can lead to non-convergence.
SourceFiles
FaceCellWave.C
\*---------------------------------------------------------------------------*/
#ifndef FaceCellWave_H
#define FaceCellWave_H
#include <OpenFOAM/boolList.H>
#include <OpenFOAM/labelList.H>
#include <OpenFOAM/primitiveFieldsFwd.H>
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of classes
class polyMesh;
class polyPatch;
/*---------------------------------------------------------------------------*\
Class FaceCellWaveName Declaration
\*---------------------------------------------------------------------------*/
TemplateName(FaceCellWave);
/*---------------------------------------------------------------------------*\
Class FaceCellWave Declaration
\*---------------------------------------------------------------------------*/
template <class Type>
class FaceCellWave
:
public FaceCellWaveName
{
// Private data
//- Reference to mesh
const polyMesh& mesh_;
//- Information for all faces
UList<Type>& allFaceInfo_;
//- Information for all cells
UList<Type>& allCellInfo_;
//- Has face changed
boolList changedFace_;
//- List of changed faces
labelList changedFaces_;
//- Number of changed faces
label nChangedFaces_;
// Cells that have changed
boolList changedCell_;
labelList changedCells_;
label nChangedCells_;
//- Contains cyclics
bool hasCyclicPatches_;
//- Number of evaluations
label nEvals_;
//- Number of unvisited cells/faces
label nUnvisitedCells_;
label nUnvisitedFaces_;
//- Iteration counter
label iter_;
// Static Functions
//- Write faces info
static Ostream& writeFaces
(
const label nFaces,
const labelList& faceLabels,
const List<Type>& faceInfo,
Ostream& os
);
//- Read faces info
static Istream& readFaces
(
label& nFaces,
labelList& faceLabels,
List<Type>& faceInfo,
Istream& is
);
// Private Member Functions
//- Disallow default bitwise copy construct
FaceCellWave(const FaceCellWave&);
//- Disallow default bitwise assignment
void operator=(const FaceCellWave&);
//- Updates cellInfo with information from neighbour. Updates all
// statistics.
bool updateCell
(
const label cellI,
const label neighbourFaceI,
const Type& neighbourInfo,
const scalar tol,
Type& cellInfo
);
//- Updates faceInfo with information from neighbour. Updates all
// statistics.
bool updateFace
(
const label faceI,
const label neighbourCellI,
const Type& neighbourInfo,
const scalar tol,
Type& faceInfo
);
//- Updates faceInfo with information from same face. Updates all
// statistics.
bool updateFace
(
const label faceI,
const Type& neighbourInfo,
const scalar tol,
Type& faceInfo
);
// Parallel, cyclic
//- Debugging: check info on both sides of cyclic
void checkCyclic(const polyPatch& pPatch) const;
//- Has cyclic patch?
bool hasCyclicPatch() const;
//- Merge received patch data into global data
void mergeFaceInfo
(
const polyPatch& patch,
const label nFaces,
const labelList&,
const List<Type>&,
const bool isParallel
);
//- Extract info for single patch only
label getChangedPatchFaces
(
const polyPatch& patch,
const label startFaceI,
const label nFaces,
labelList& changedPatchFaces,
List<Type>& changedPatchFacesInfo
) const;
//- Handle leaving domain. Implementation referred to Type
void leaveDomain
(
const polyPatch& patch,
const label nFaces,
const labelList& faceLabels,
List<Type>& faceInfo
) const;
//- Handle leaving domain. Implementation referred to Type
void enterDomain
(
const polyPatch& patch,
const label nFaces,
const labelList& faceLabels,
List<Type>& faceInfo
) const;
//- Send info to neighbour
void sendPatchInfo
(
const label neighbour,
const label nFaces,
const labelList&,
const List<Type>&
) const;
//- Receive info from neighbour. Returns number of faces received.
label receivePatchInfo
(
const label neighbour,
labelList&,
List<Type>&
) const;
//- Offset face labels by constant value
static void offset
(
const polyPatch& patch,
const label off,
const label nFaces,
labelList& faces
);
//- Apply transformation to Type
void transform
(
const tensorField& rotTensor,
const label nFaces,
List<Type>& faceInfo
);
//- Merge data from across processor boundaries
void handleProcPatches();
//- Merge data from across cyclics
void handleCyclicPatches();
// Private static data
static const scalar geomTol_;
static scalar propagationTol_;
public:
// Static Functions
//- Access to tolerance
static scalar propagationTol()
{
return propagationTol_;
}
//- Change tolerance
static void setPropagationTol(const scalar tol)
{
propagationTol_ = tol;
}
// Constructors
// Construct from mesh. Use setFaceInfo and iterate() to do actual
// calculation.
FaceCellWave
(
const polyMesh&,
UList<Type>& allFaceInfo,
UList<Type>& allCellInfo
);
//- Construct from mesh and list of changed faces with the Type
// for these faces. Iterates until nothing changes or maxIter reached.
// (maxIter can be 0)
FaceCellWave
(
const polyMesh&,
const labelList& initialChangedFaces,
const List<Type>& changedFacesInfo,
UList<Type>& allFaceInfo,
UList<Type>& allCellInfo,
const label maxIter
);
// Member Functions
// Access
//- Access allFaceInfo
UList<Type>& allFaceInfo()
{
return allFaceInfo_;
}
//- Access allCellInfo
UList<Type>& allCellInfo()
{
return allCellInfo_;
}
//- Access mesh
const polyMesh& mesh() const
{
return mesh_;
}
//- Get number of unvisited cells, i.e. cells that were not (yet)
// reached from walking across mesh. This can happen from
// - not enough iterations done
// - a disconnected mesh
// - a mesh without walls in it
label getUnsetCells() const;
//- Get number of unvisited faces
label getUnsetFaces() const;
// Edit
//- Set initial changed faces
void setFaceInfo
(
const labelList& changedFaces,
const List<Type>& changedFacesInfo
);
//- Propagate from face to cell. Returns total number of cells
// (over all processors) changed.
label faceToCell();
//- Propagate from cell to face. Returns total number of faces
// (over all processors) changed. (Faces on processorpatches are
// counted double)
label cellToFace();
//- Iterate until no changes or maxIter reached. Returns number of
// unset cells (see getUnsetCells)
label iterate(const label maxIter);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
# include <OpenFOAM/FaceCellWave.C>
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************ vim: set sw=4 sts=4 et: ************************ //
|