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 class diagonalSolver
50 :
51  public lduMatrix::solver
52 {
53 
54 public:
55 
56  //- Runtime type information
57  TypeName("diagonal");
58 
59 
60  // Constructors
61 
62  //- Construct from matrix and solver controls
64  (
65  const word& fieldName,
66  const lduMatrix& matrix,
70  const dictionary& solverControls
71  );
72 
73  //- Disallow default bitwise copy construction
74  diagonalSolver(const diagonalSolver&) = delete;
75 
76 
77  // Member Functions
78 
79  //- Read and reset the solver parameters from the given stream
80  void read(const dictionary&)
81  {}
82 
83  //- Solve the matrix with this solver
85  (
87  const scalarField& source,
88  const direction cmpt=0
89  ) const;
90 
91 
92  // Member Operators
93 
94  //- Disallow default bitwise assignment
95  void operator=(const diagonalSolver&) = delete;
96 };
97 
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 } // End namespace Foam
102 
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 
105 #endif
106 
107 // ************************************************************************* //
void operator=(const diagonalSolver &)=delete
Disallow default bitwise assignment.
void read(const dictionary &)
Read and reset the solver parameters from the given stream.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
uint8_t direction
Definition: direction.H:45
Foam::diagonalSolver.
const lduMatrix & matrix() const
Definition: lduMatrix.H:226
const FieldField< Field, scalar > & interfaceBouCoeffs() const
Definition: lduMatrix.H:231
Generic field type.
Definition: FieldField.H:51
const FieldField< Field, scalar > & interfaceIntCoeffs() const
Definition: lduMatrix.H:236
A class for handling words, derived from string.
Definition: word.H:59
SolverPerformance is the class returned by the LduMatrix solver containing performance statistics...
Abstract base-class for lduMatrix solvers.
Definition: lduMatrix.H:93
const lduInterfaceFieldPtrsList & interfaces() const
Definition: lduMatrix.H:241
const volScalarField & psi
lduMatrix is a general matrix class in which the coefficients are stored as three arrays...
Definition: lduMatrix.H:79
TypeName("diagonal")
Runtime type information.
solverPerformance solve(scalarField &psi, const scalarField &source, const direction cmpt=0) const
Solve the matrix with this solver.
const word & fieldName() const
Definition: lduMatrix.H:221
diagonalSolver(const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces, const dictionary &solverControls)
Construct from matrix and solver controls.
Namespace for OpenFOAM.