DiagonalSolver.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-2020 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::DiagonalSolver
26 
27 Description
28  Foam::DiagonalSolver
29 
30 SourceFiles
31  DiagonalSolver.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef DiagonalSolver_H
36 #define DiagonalSolver_H
37 
38 #include "LduMatrix.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class DiagonalSolver Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 template<class Type, class DType, class LUType>
50 class DiagonalSolver
51 :
52  public LduMatrix<Type, DType, LUType>::solver
53 {
54 
55 public:
56 
57  //- Runtime type information
58  TypeName("diagonal");
59 
60 
61  // Constructors
62 
63  //- Construct from matrix
65  (
66  const word& fieldName,
68  const dictionary& solverDict
69  );
70 
71  //- Disallow default bitwise copy construction
72  DiagonalSolver(const DiagonalSolver&) = delete;
73 
74 
75  // Member Functions
76 
77  //- Read and reset the solver parameters from the given dictionary
78  void read(const dictionary& solverDict);
79 
80  //- Solve the matrix with this solver
82 
83 
84  // Member Operators
85 
86  //- Disallow default bitwise assignment
87  void operator=(const DiagonalSolver&) = delete;
88 };
89 
90 
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 
93 } // End namespace Foam
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 #ifdef NoRepository
98  #include "DiagonalSolver.C"
99 #endif
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 #endif
104 
105 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
TypeName("diagonal")
Runtime type information.
Foam::DiagonalSolver.
const LduMatrix< Type, DType, LUType > & matrix() const
Definition: LduMatrix.H:235
const word & fieldName() const
Definition: LduMatrix.H:230
void operator=(const DiagonalSolver &)=delete
Disallow default bitwise assignment.
Pre-declare SubField and related Field type.
Definition: Field.H:56
A class for handling words, derived from string.
Definition: word.H:59
SolverPerformance is the class returned by the LduMatrix solver containing performance statistics...
virtual SolverPerformance< Type > solve(Field< Type > &psi) const
Solve the matrix with this solver.
LduMatrix is a general matrix class in which the coefficients are stored as three arrays...
Definition: LduMatrix.H:69
void read(const dictionary &solverDict)
Read and reset the solver parameters from the given dictionary.
const volScalarField & psi
DiagonalSolver(const word &fieldName, const LduMatrix< Type, DType, LUType > &matrix, const dictionary &solverDict)
Construct from matrix.
Namespace for OpenFOAM.