diagonalSolver.C
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-2018 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 \*---------------------------------------------------------------------------*/
25 
26 #include "diagonalSolver.H"
27 
28 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
29 
30 namespace Foam
31 {
33 }
34 
35 
36 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
37 
39 (
40  const word& fieldName,
41  const lduMatrix& matrix,
42  const FieldField<Field, scalar>& interfaceBouCoeffs,
43  const FieldField<Field, scalar>& interfaceIntCoeffs,
44  const lduInterfaceFieldPtrsList& interfaces,
45  const dictionary& solverControls
46 )
47 :
49  (
50  fieldName,
51  matrix,
52  interfaceBouCoeffs,
53  interfaceIntCoeffs,
54  interfaces,
55  solverControls
56  )
57 {}
58 
59 
60 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
61 
63 (
65  const scalarField& source,
66  const direction cmpt
67 ) const
68 {
69  psi = source/matrix_.diag();
70 
71  return solverPerformance
72  (
73  typeName,
74  fieldName_,
75  0,
76  0,
77  0,
78  true,
79  false
80  );
81 }
82 
83 
84 // ************************************************************************* //
Generic field type.
Definition: FieldField.H:77
SolverPerformance is the class returned by the LduMatrix solver containing performance statistics.
Foam::diagonalSolver.
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.
solverPerformance solve(scalarField &psi, const scalarField &source, const direction cmpt=0) const
Solve the matrix with this solver.
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
lduMatrix is a general matrix class in which the coefficients are stored as three arrays,...
Definition: lduMatrix.H:80
Abstract base class for run-time selectable region solvers.
Definition: solver.H:56
A class for handling words, derived from string.
Definition: word.H:62
const volScalarField & psi
Namespace for OpenFOAM.
SolverPerformance< scalar > solverPerformance
SolverPerformance instantiated for a scalar.
defineTypeNameAndDebug(combustionModel, 0)
uint8_t direction
Definition: direction.H:45