ENH: autoLayerDriver: better layering information message
[OpenFOAM-2.0.x.git] / src / OpenFOAM / matrices / DiagonalMatrix / DiagonalMatrix.H
blobc89f915578e92b5dcd75f67973c0ed1c2339d6bc
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
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::DiagonalMatrix
27 Description
28     DiagonalMatrix<Type> is a 2D diagonal matrix of objects
29     of type Type, size nxn
31 SourceFiles
32     DiagonalMatrix.C
34 \*---------------------------------------------------------------------------*/
36 #ifndef DiagonalMatrix_H
37 #define DiagonalMatrix_H
39 #include "List.H"
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 namespace Foam
46 // * * * * * *  * * * * * * Class Forward declaration  * * * * * * * * * * * //
48 template<class Form, class Type> class Matrix;
50 /*---------------------------------------------------------------------------*\
51                            Class DiagonalMatrix Declaration
52 \*---------------------------------------------------------------------------*/
54 template<class Type>
55 class DiagonalMatrix
57     public List<Type>
59 public:
61     // Constructors
63         //- Construct from diagonal component of a Matrix
64         template<class Form>
65         DiagonalMatrix<Type>(const Matrix<Form, Type>&);
67         //- Construct empty from size
68         DiagonalMatrix<Type>(const label size);
70         //- Construct from size and a value
71         DiagonalMatrix<Type>(const label, const Type&);
74     // Member functions
76         //- Invert the diaganol matrix and return itself
77         DiagonalMatrix<Type>& invert();
81 // Global functions
83 //- Return the diagonal Matrix inverse
84 template<class Type>
85 DiagonalMatrix<Type> inv(const DiagonalMatrix<Type>&);
88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
90 } // End namespace Foam
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 #ifdef NoRepository
95 #   include "DiagonalMatrix.C"
96 #endif
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 #endif
102 // ************************************************************************* //