/usr/include/freefoam/OpenFOAM/lduAddressing.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 | /*---------------------------------------------------------------------------*\
========= |
\\ / 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::lduAddressing
Description
The class contains the addressing required by the lduMatrix: upper, lower
and losort.
The addressing can be created in two ways: either with references to
upper and lower in which case it stores references or from labelLists,
in which case it stores the addressing itself. Additionally, the losort
addressing belongs to the class is as on lazy evaluation.
The ordering of owner addresses is such that the labels are in
increasing order, with groups of identical labels for edges "owned" by
the same point. The neighbour labels are also ordered in ascending
order but only for groups of edges belonging to each point. An example
is given below:
@verbatim
owner eighbour
0 1
0 20
1 2
1 21
2 3
2 22
3 4
3 23
4 5
4 24
5 6
5 25
6 7
6 26
7 8
7 27
8 9
8 28
9 10
9 29
@endverbatim
There exists an alternative way of addressing the owner
list: instead of repeating the same label in the owner list, it is
possible to address the start of each point neighbours in the
neighbour list. This reduces the size of owner addressing from a list
over all edges to a list over all points + 1:
@verbatim
Owner start list: 0 2 4 6 8 10 12 14 16 18
@endverbatim
We shall use the second form of the addressing for fast lookup
of edge label from the known owner and neighbour, using the following
algorithm:
-# take the owner label and position the start of lookup
using the owner start list
-# loop through all neighbours of this owner (ending at the start of
lookup of owner + 1) until the match with current neighbour is found.
The index used on the neighbour list for the match is the edge index.
While owner start addressing allows us to find the edge owned by the
points, it is also necessary to find the edges for which the point is
a neighbour. Losort addressing lists the edges neighboured by the
point and we shall use the same trick as above to address into this
list. Thus, for every point the losort start gives the address of the
first face to neighbour this point.
SourceFiles
lduAddressing.C
\*---------------------------------------------------------------------------*/
#ifndef lduAddressing_H
#define lduAddressing_H
#include <OpenFOAM/labelList.H>
#include <OpenFOAM/lduSchedule.H>
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class lduAddressing Declaration
\*---------------------------------------------------------------------------*/
class lduAddressing
{
// Private data
//- Number of equations
label size_;
//- Demand-driven data
//- Losort addressing
mutable labelList* losortPtr_;
//- Owner start addressing
mutable labelList* ownerStartPtr_;
//- Losort start addressing
mutable labelList* losortStartPtr_;
// Private Member Functions
//- Disallow default bitwise copy construct
lduAddressing(const lduAddressing&);
//- Disallow default bitwise assignment
void operator=(const lduAddressing&);
//- Calculate losort
void calcLosort() const;
//- Calculate owner start
void calcOwnerStart() const;
//- Calculate losort start
void calcLosortStart() const;
public:
// Constructor
lduAddressing(const label nEqns)
:
size_(nEqns),
losortPtr_(NULL),
ownerStartPtr_(NULL),
losortStartPtr_(NULL)
{}
// Destructor
virtual ~lduAddressing();
// Member Functions
//- Return number of equations
label size() const
{
return size_;
}
//- Return lower addressing
virtual const unallocLabelList& lowerAddr() const = 0;
//- Return upper addressing
virtual const unallocLabelList& upperAddr() const = 0;
//- Return patch to internal addressing given patch number
virtual const unallocLabelList& patchAddr
(
const label patchNo
) const = 0;
// Return patch field evaluation schedule
virtual const lduSchedule& patchSchedule() const = 0;
//- Return losort addressing
const unallocLabelList& losortAddr() const;
//- Return owner start addressing
const unallocLabelList& ownerStartAddr() const;
//- Return losort start addressing
const unallocLabelList& losortStartAddr() const;
//- Return off-diagonal index given owner and neighbour label
label triIndex(const label a, const label b) const;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************ vim: set sw=4 sts=4 et: ************************ //
|