initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / src / finiteVolume / fvMesh / extendedStencil / cellToFace / extendedCentredCellToFaceStencil.H
blobc58e81db922cc3407bfcaaba91245977b2cf53ed
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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 the
13     Free Software Foundation; either version 2 of the License, or (at your
14     option) any later version.
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.
21     You should have received a copy of the GNU General Public License
22     along with OpenFOAM; if not, write to the Free Software Foundation,
23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 Class
26     Foam::extendedCentredCellToFaceStencil
28 Description
30 SourceFiles
31     extendedCentredCellToFaceStencil.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef extendedCentredCellToFaceStencil_H
36 #define extendedCentredCellToFaceStencil_H
38 #include "extendedCellToFaceStencil.H"
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 namespace Foam
45 class cellToFaceStencil;
47 /*---------------------------------------------------------------------------*\
48                            Class extendedCentredCellToFaceStencil Declaration
49 \*---------------------------------------------------------------------------*/
51 class extendedCentredCellToFaceStencil
53     public extendedCellToFaceStencil
55     // Private data
57         //- Swap map for getting neigbouring data
58         autoPtr<mapDistribute> mapPtr_;
60         //- Per face the stencil.
61         labelListList stencil_;
64     // Private Member Functions
66         //- Disallow default bitwise copy construct
67         extendedCentredCellToFaceStencil
68         (
69             const extendedCentredCellToFaceStencil&
70         );
72         //- Disallow default bitwise assignment
73         void operator=(const extendedCentredCellToFaceStencil&);
76 public:
78     // Constructors
80         //- Construct from uncompacted face stencil
81         explicit extendedCentredCellToFaceStencil(const cellToFaceStencil&);
84     // Member Functions
86         //- Return reference to the parallel distribution map
87         const mapDistribute& map() const
88         {
89             return mapPtr_();
90         }
92         //- Return reference to the stencil
93         const labelListList& stencil() const
94         {
95             return stencil_;
96         }
98         //- After removing elements from the stencil adapt the schedule (map).
99         void compact();
101         //- Use map to get the data into stencil order
102         template<class T>
103         void collectData
104         (
105             const GeometricField<T, fvPatchField, volMesh>& fld,
106             List<List<T> >& stencilFld
107         ) const
108         {
109             extendedCellToFaceStencil::collectData
110             (
111                 map(),
112                 stencil(),
113                 fld,
114                 stencilFld
115             );
116         }
118         //- Sum vol field contributions to create face values
119         template<class Type>
120         tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > weightedSum
121         (
122             const GeometricField<Type, fvPatchField, volMesh>& fld,
123             const List<List<scalar> >& stencilWeights
124         ) const
125         {
126             return extendedCellToFaceStencil::weightedSum
127             (
128                 map(),
129                 stencil(),
130                 fld,
131                 stencilWeights
132             );
133         }
138 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
140 } // End namespace Foam
142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
144 #endif
146 // ************************************************************************* //