LduMatrixPreconditioner.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-2019 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 "LduMatrix.H"
27 
28 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
29 
30 template<class Type, class DType, class LUType>
33 (
34  const solver& sol,
35  const dictionary& preconditionerDict
36 )
37 {
38  word preconditionerName = preconditionerDict.lookup("preconditioner");
39 
40  if (sol.matrix().symmetric())
41  {
42  typename symMatrixConstructorTable::iterator constructorIter =
43  symMatrixConstructorTablePtr_->find(preconditionerName);
44 
45  if (constructorIter == symMatrixConstructorTablePtr_->end())
46  {
48  (
49  preconditionerDict
50  ) << "Unknown symmetric matrix preconditioner "
51  << preconditionerName << endl << endl
52  << "Valid symmetric matrix preconditioners are :" << endl
53  << symMatrixConstructorTablePtr_->toc()
54  << exit(FatalIOError);
55  }
56 
58  (
59  constructorIter()
60  (
61  sol,
62  preconditionerDict
63  )
64  );
65  }
66  else if (sol.matrix().asymmetric())
67  {
68  typename asymMatrixConstructorTable::iterator constructorIter =
69  asymMatrixConstructorTablePtr_->find(preconditionerName);
70 
71  if (constructorIter == asymMatrixConstructorTablePtr_->end())
72  {
74  (
75  preconditionerDict
76  ) << "Unknown asymmetric matrix preconditioner "
77  << preconditionerName << endl << endl
78  << "Valid asymmetric matrix preconditioners are :" << endl
79  << asymMatrixConstructorTablePtr_->toc()
80  << exit(FatalIOError);
81  }
82 
84  (
85  constructorIter()
86  (
87  sol,
88  preconditionerDict
89  )
90  );
91  }
92  else
93  {
95  (
96  preconditionerDict
97  ) << "cannot precondition incomplete matrix, "
98  "no diagonal or off-diagonal coefficient"
99  << exit(FatalIOError);
100 
102  (
103  nullptr
104  );
105  }
106 }
107 
108 
109 // ************************************************************************* //
static autoPtr< preconditioner > New(const solver &sol, const dictionary &preconditionerDict)
Return a new preconditioner.
Abstract base-class for LduMatrix solvers.
Definition: LduMatrix.H:113
const LduMatrix< Type, DType, LUType > & matrix() const
Definition: LduMatrix.H:235
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
ITstream & lookup(const word &, bool recursive=false, bool patternMatch=true) const
Find and return an entry data stream.
Definition: dictionary.C:710
A class for handling words, derived from string.
Definition: word.H:62
#define FatalIOErrorInFunction(ios)
Report an error message using Foam::FatalIOError.
Definition: error.H:346
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:257
IOerror FatalIOError