bandCompression.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 InNamespace
25  Foam
26 
27 Description
28  The bandCompression function renumbers the addressing such that the
29  band of the matrix is reduced. The algorithm uses a simple search
30  through the neighbour list in order of connectivity.
31  (CutHill-McKee algorithm)
32 
33 SourceFiles
34  bandCompression.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef bandCompression_H
39 #define bandCompression_H
40 
41 #include "labelList.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 //- Renumbers the addressing to reduce the band of the matrix.
49 // The algorithm uses a simple search through the neighbour list
50 // Returns the order in which the cells need to be visited (i.e. ordered to
51 // original)
52 labelList bandCompression(const labelListList& addressing);
53 
54 //- Renumber with addressing in losort form (neighbour + start in neighbour)
55 labelList bandCompression(const labelList& cellCells, const labelList& offsets);
56 
57 } // End namespace Foam
58 
59 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
60 
61 #endif
62 
63 // ************************************************************************* //
List< labelList > labelListList
A List of labelList.
Definition: labelList.H:57
List< label > labelList
A List of labels.
Definition: labelList.H:56
labelList bandCompression(const labelListList &addressing)
Renumbers the addressing to reduce the band of the matrix.
Namespace for OpenFOAM.