procLduMatrix.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2023 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 public:
75 
76  friend class LUscalarMatrix;
77 
78 
79  // Constructors
80 
82  (
83  const lduMatrix& ldum,
84  const FieldField<Field, scalar>& interfaceCoeffs,
85  const lduInterfaceFieldPtrsList& interfaces
86  );
87 
89 
90  //- Disallow construction as copy
91  procLduMatrix(const procLduMatrix&) = delete;
92 
93 
94  // Member Functions
95 
96  label size() const
97  {
98  return diag_.size();
99  }
100 
101 
102  // Ostream operator
103 
104  friend Ostream& operator<<(Ostream&, const procLduMatrix&);
105 };
106 
107 
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 
110 } // End namespace Foam
111 
112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113 
114 #endif
115 
116 // ************************************************************************* //
Generic field type.
Definition: FieldField.H:77
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:60
Class to perform the LU decomposition on a symmetric matrix.
void size(const label)
Override size to be inconsistent with allocated storage.
Definition: ListI.H:164
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
A templated 1D list of pointers to objects of type <T>, where the size of the array is known and used...
Definition: PtrList.H:75
lduMatrix is a general matrix class in which the coefficients are stored as three arrays,...
Definition: lduMatrix.H:80
I/O for lduMatrix and interface values.
Definition: procLduMatrix.H:62
procLduMatrix(const lduMatrix &ldum, const FieldField< Field, scalar > &interfaceCoeffs, const lduInterfaceFieldPtrsList &interfaces)
Definition: procLduMatrix.C:33
label size() const
Definition: procLduMatrix.H:95
friend Ostream & operator<<(Ostream &, const procLduMatrix &)
Namespace for OpenFOAM.
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
Ostream & operator<<(Ostream &os, const fvConstraints &constraints)