procLduMatrix.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) 2011-2013 OpenFOAM Foundation
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::procLduMatrix
26 
27 Description
28  I/O for lduMatrix and interface values.
29 
30 SourceFiles
31  procLduMatrix.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef procLduMatrix_H
36 #define procLduMatrix_H
37 
38 #include "labelList.H"
39 #include "scalarField.H"
40 #include "FieldField.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 class procLduInterface;
49 class lduMatrix;
50 
51 // Forward declaration of friend functions and operators
52 
53 class procLduMatrix;
54 
55 Ostream& operator<<(Ostream&, const procLduMatrix&);
56 
57 
58 /*---------------------------------------------------------------------------*\
59  Class procLduMatrix Declaration
60 \*---------------------------------------------------------------------------*/
61 
62 class procLduMatrix
63 {
64  // Private data
65 
66  labelList upperAddr_;
67  labelList lowerAddr_;
68  scalarField diag_;
69  scalarField upper_;
70  scalarField lower_;
71  PtrList<procLduInterface> interfaces_;
72 
73 
74  // Private Member Functions
75 
76  //- Dissallow construction as copy
78 
79 
80 public:
81 
82  friend class LUscalarMatrix;
83 
84 
85  // Constructors
86 
88  (
89  const lduMatrix& ldum,
90  const FieldField<Field, scalar>& interfaceCoeffs,
91  const lduInterfaceFieldPtrsList& interfaces
92  );
93 
95 
96 
97  // Member functions
98 
99  label size() const
100  {
101  return diag_.size();
102  }
103 
104 
105  // Ostream operator
106 
107  friend Ostream& operator<<(Ostream&, const procLduMatrix&);
108 };
109 
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 } // End namespace Foam
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 #endif
118 
119 // ************************************************************************* //
label size() const
Definition: procLduMatrix.H:98
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
Class to perform the LU decomposition on a symmetric matrix.
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
void size(const label)
Override size to be inconsistent with allocated storage.
Definition: ListI.H:163
Generic field type.
Definition: FieldField.H:51
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
lduMatrix is a general matrix class in which the coefficients are stored as three arrays...
Definition: lduMatrix.H:79
A templated 1D list of pointers to objects of type <T>, where the size of the array is known and used...
Definition: List.H:63
Ostream & operator<<(Ostream &, const ensightPart &)
friend Ostream & operator<<(Ostream &, const procLduMatrix &)
I/O for lduMatrix and interface values.
Definition: procLduMatrix.H:61
Namespace for OpenFOAM.