diagonalSolver.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-2012 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  // Private Member Functions
54 
55  //- Disallow default bitwise copy construct
57 
58  //- Disallow default bitwise assignment
59  void operator=(const diagonalSolver&);
60 
61 
62 public:
63 
64  //- Runtime type information
65  TypeName("diagonal");
66 
67 
68  // Constructors
69 
70  //- Construct from matrix and solver controls
72  (
73  const word& fieldName,
74  const lduMatrix& matrix,
78  const dictionary& solverControls
79  );
80 
81 
82  // Member Functions
83 
84  //- Read and reset the solver parameters from the given stream
85  void read(const dictionary&)
86  {}
87 
88  //- Solve the matrix with this solver
90  (
92  const scalarField& source,
93  const direction cmpt=0
94  ) const;
95 };
96 
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 } // End namespace Foam
101 
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 
104 #endif
105 
106 // ************************************************************************* //
uint8_t direction
Definition: direction.H:46
const word & fieldName() const
Definition: lduMatrix.H:218
void read(const dictionary &)
Read and reset the solver parameters from the given stream.
const FieldField< Field, scalar > & interfaceIntCoeffs() const
Definition: lduMatrix.H:233
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Foam::diagonalSolver.
Generic field type.
Definition: FieldField.H:51
const lduInterfaceFieldPtrsList & interfaces() const
Definition: lduMatrix.H:238
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 lduMatrix & matrix() const
Definition: lduMatrix.H:223
solverPerformance solve(scalarField &psi, const scalarField &source, const direction cmpt=0) 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:79
TypeName("diagonal")
Runtime type information.
const FieldField< Field, scalar > & interfaceBouCoeffs() const
Definition: lduMatrix.H:228
const volScalarField & psi
Namespace for OpenFOAM.