STYLE: directMappedVelocityFluxFixedValueFvPatchField.H : correct comment
[OpenFOAM-1.7.x.git] / src / OpenFOAM / matrices / LUscalarMatrix / procLduMatrix.H
blobf22fbb73356084c30d3f34aa6ea3f3f66f766d2a
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-2010 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
13     the Free Software Foundation, either version 3 of the License, or
14     (at your 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, see <http://www.gnu.org/licenses/>.
24 Class
25     Foam::procLduMatrix
27 Description
28     Foam::procLduMatrix
30 SourceFiles
31     procLduMatrix.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef procLduMatrix_H
36 #define procLduMatrix_H
38 #include "labelList.H"
39 #include "scalarField.H"
40 #include "FieldField.H"
41 #include "lduInterfaceFieldPtrsList.H"
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 namespace Foam
48 class procLduInterface;
49 class lduMatrix;
51 // Forward declaration of friend functions and operators
53 class procLduMatrix;
55 Ostream& operator<<(Ostream&, const procLduMatrix&);
58 /*---------------------------------------------------------------------------*\
59                            Class procLduMatrix Declaration
60 \*---------------------------------------------------------------------------*/
62 class procLduMatrix
64     // Private data
66         labelList upperAddr_;
67         labelList lowerAddr_;
68         scalarField diag_;
69         scalarField upper_;
70         scalarField lower_;
71         PtrList<procLduInterface> interfaces_;
74     // Private member functions
76         //- Dissallow construction as copy
77         procLduMatrix(const procLduMatrix&);
80 public:
82     friend class LUscalarMatrix;
85     // Constructors
87         procLduMatrix
88         (
89             const lduMatrix& ldum,
90             const FieldField<Field, scalar>& interfaceCoeffs,
91             const lduInterfaceFieldPtrsList& interfaces
92         );
94         procLduMatrix(Istream& is);
97     // Member functions
99         label size() const
100         {
101             return diag_.size();
102         }
105     // Ostream operator
107         friend Ostream& operator<<(Ostream&, const procLduMatrix&);
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113 } // End namespace Foam
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117 #endif
119 // ************************************************************************* //