FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

DiagonalMatrix.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software: you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::DiagonalMatrix
00026 
00027 Description
00028     DiagonalMatrix<Type> is a 2D diagonal matrix of objects
00029     of type Type, size nxn
00030 
00031 SourceFiles
00032     DiagonalMatrix.C
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef DiagonalMatrix_H
00037 #define DiagonalMatrix_H
00038 
00039 #include <OpenFOAM/List.H>
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 // * * * * * *  * * * * * * Class Forward declaration  * * * * * * * * * * * //
00047 
00048 template<class Form, class Type> class Matrix;
00049 
00050 /*---------------------------------------------------------------------------*\
00051                            Class DiagonalMatrix Declaration
00052 \*---------------------------------------------------------------------------*/
00053 
00054 template<class Type>
00055 class DiagonalMatrix
00056 :
00057     public List<Type>
00058 {
00059 public:
00060 
00061     // Constructors
00062 
00063         //- Construct from diagonal component of a Matrix
00064         template<class Form>
00065         DiagonalMatrix<Type>(const Matrix<Form, Type>&);
00066 
00067         //- Construct empty from size
00068         DiagonalMatrix<Type>(const label size);
00069 
00070         //- Construct from size and a value
00071         DiagonalMatrix<Type>(const label, const Type&);
00072 
00073 
00074     // Member functions
00075 
00076         //- Invert the diaganol matrix and return itself
00077         DiagonalMatrix<Type>& invert();
00078 };
00079 
00080 
00081 // Global functions
00082 
00083 //- Return the diagonal Matrix inverse
00084 template<class Type>
00085 DiagonalMatrix<Type> inv(const DiagonalMatrix<Type>&);
00086 
00087 
00088 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00089 
00090 } // End namespace Foam
00091 
00092 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00093 
00094 #ifdef NoRepository
00095 #   include "DiagonalMatrix.C"
00096 #endif
00097 
00098 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00099 
00100 #endif
00101 
00102 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines