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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2013 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::procLduMatrix
28 
29 Description
30  I/O for lduMatrix and interface values.
31 
32 SourceFiles
33  procLduMatrix.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef procLduMatrix_H
38 #define procLduMatrix_H
39 
40 #include "labelList.H"
41 #include "scalarField.H"
42 #include "FieldField.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 class procLduInterface;
51 class lduMatrix;
52 
53 // Forward declaration of friend functions and operators
54 
55 class procLduMatrix;
56 
57 Ostream& operator<<(Ostream&, const procLduMatrix&);
58 
59 
60 /*---------------------------------------------------------------------------*\
61  Class procLduMatrix Declaration
62 \*---------------------------------------------------------------------------*/
63 
64 class procLduMatrix
65 {
66  // Private data
67 
68  labelList upperAddr_;
69  labelList lowerAddr_;
70  scalarField diag_;
71  scalarField upper_;
72  scalarField lower_;
73  PtrList<procLduInterface> interfaces_;
74 
75 
76  // Private Member Functions
77 
78  //- No copy construct
79  procLduMatrix(const procLduMatrix&) = delete;
80 
81 
82 public:
83 
84  friend class LUscalarMatrix;
85 
86 
87  // Constructors
88 
90  (
91  const lduMatrix& ldum,
92  const FieldField<Field, scalar>& interfaceCoeffs,
93  const lduInterfaceFieldPtrsList& interfaces
94  );
95 
97 
98 
99  // Member functions
100 
101  label size() const
102  {
103  return diag_.size();
104  }
105 
106 
107  // Ostream operator
108 
109  friend Ostream& operator<<(Ostream&, const procLduMatrix&);
110 };
111 
112 
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114 
115 } // End namespace Foam
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 #endif
120 
121 // ************************************************************************* //
Foam::FieldField
A field of fields is a PtrList of fields with reference counting.
Definition: FieldField.H:53
FieldField.H
scalarField.H
Foam::lduMatrix
lduMatrix is a general matrix class in which the coefficients are stored as three arrays,...
Definition: lduMatrix.H:83
Foam::procLduMatrix::operator<<
friend Ostream & operator<<(Ostream &, const procLduMatrix &)
lduInterfaceFieldPtrsList.H
Foam::procLduMatrix
I/O for lduMatrix and interface values.
Definition: procLduMatrix.H:63
Foam::operator<<
Ostream & operator<<(Ostream &, const boundaryPatch &p)
Write boundaryPatch as dictionary entries (without surrounding braces)
Definition: boundaryPatch.C:83
labelList.H
Foam::Field< scalar >
Foam::Istream
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:61
Foam::UPtrList< const lduInterfaceField >
Foam::PtrList
A list of pointers to objects of type <T>, with allocation/deallocation management of the pointers....
Definition: List.H:59
Foam::LUscalarMatrix
Class to perform the LU decomposition on a symmetric matrix.
Definition: LUscalarMatrix.H:56
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::List< label >
Foam::procLduMatrix::size
label size() const
Definition: procLduMatrix.H:100
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56