Home
Downloads
Documentation
Installation
User Guide
man-pages
API Documentation
README
Release Notes
Changes
License
Support
SourceForge Project
Main Page
Related Pages
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Pages
src
OpenFOAM
matrices
DiagonalMatrix
DiagonalMatrix.H
Go to the documentation of this file.
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.
10
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.
15
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.
20
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/>.
23
24
Class
25
Foam::DiagonalMatrix
26
27
Description
28
DiagonalMatrix<Type> is a 2D diagonal matrix of objects
29
of type Type, size nxn
30
31
SourceFiles
32
DiagonalMatrix.C
33
34
\*---------------------------------------------------------------------------*/
35
36
#ifndef DiagonalMatrix_H
37
#define DiagonalMatrix_H
38
39
#include <
OpenFOAM/List.H
>
40
41
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42
43
namespace
Foam
44
{
45
46
// * * * * * * * * * * * * Class Forward declaration * * * * * * * * * * * //
47
48
template
<
class
Form,
class
Type>
class
Matrix;
49
50
/*---------------------------------------------------------------------------*\
51
Class DiagonalMatrix Declaration
52
\*---------------------------------------------------------------------------*/
53
54
template
<
class
Type>
55
class
DiagonalMatrix
56
:
57
public
List
<Type>
58
{
59
public
:
60
61
// Constructors
62
63
//- Construct from diagonal component of a Matrix
64
template
<
class
Form>
65
DiagonalMatrix<Type>
(
const
Matrix<Form, Type>
&);
66
67
//- Construct empty from size
68
DiagonalMatrix<Type>
(
const
label
size
);
69
70
//- Construct from size and a value
71
DiagonalMatrix<Type>
(
const
label,
const
Type&);
72
73
74
// Member functions
75
76
//- Invert the diaganol matrix and return itself
77
DiagonalMatrix<Type>
&
invert
();
78
};
79
80
81
// Global functions
82
83
//- Return the diagonal Matrix inverse
84
template
<
class
Type>
85
DiagonalMatrix<Type>
inv
(
const
DiagonalMatrix<Type>
&);
86
87
88
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
89
90
}
// End namespace Foam
91
92
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93
94
#ifdef NoRepository
95
# include "
DiagonalMatrix.C
"
96
#endif
97
98
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99
100
#endif
101
102
// ************************ vim: set sw=4 sts=4 et: ************************ //