LduMatrixPreconditioner.C
Go to the documentation of this file.
1/*---------------------------------------------------------------------------*\
2 ========= |
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4 \\ / O peration |
5 \\ / A nd | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011-2016 OpenFOAM Foundation
9 Copyright (C) 2019-2021 OpenCFD Ltd.
10-------------------------------------------------------------------------------
11License
12 This file is part of OpenFOAM.
13
14 OpenFOAM is free software: you can redistribute it and/or modify it
15 under the terms of the GNU General Public License as published by
16 the Free Software Foundation, either version 3 of the License, or
17 (at your option) any later version.
18
19 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22 for more details.
23
24 You should have received a copy of the GNU General Public License
25 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26
27\*---------------------------------------------------------------------------*/
28
29#include "LduMatrix.H"
30
31// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
32
33template<class Type, class DType, class LUType>
36(
37 const solver& sol,
38 const dictionary& preconditionerDict
39)
40{
41 const word preconditionerName
42 (
43 preconditionerDict.get<word>("preconditioner")
44 );
45
46 if (sol.matrix().symmetric())
47 {
48 auto* ctorPtr = symMatrixConstructorTable(preconditionerName);
49
50 if (!ctorPtr)
51 {
53 (
54 preconditionerDict,
55 "symmetric matrix preconditioner",
56 preconditionerName,
57 *symMatrixConstructorTablePtr_
58 ) << exit(FatalIOError);
59 }
60
62 (
63 ctorPtr
64 (
65 sol,
66 preconditionerDict
67 )
68 );
69 }
70 else if (sol.matrix().asymmetric())
71 {
72 auto* ctorPtr = asymMatrixConstructorTable(preconditionerName);
73
74 if (!ctorPtr)
75 {
77 (
78 preconditionerDict,
79 "asymmetric matrix preconditioner",
80 preconditionerName,
81 *asymMatrixConstructorTablePtr_
82 ) << exit(FatalIOError);
83 }
84
86 (
87 ctorPtr
88 (
89 sol,
90 preconditionerDict
91 )
92 );
93 }
94
95 FatalIOErrorInFunction(preconditionerDict)
96 << "Cannot precondition incomplete matrix, "
97 "no diagonal or off-diagonal coefficient"
99
100 return nullptr;
101}
102
103
104// ************************************************************************* //
Abstract base-class for LduMatrix solvers.
Definition: LduMatrix.H:116
const LduMatrix< Type, DType, LUType > & matrix() const noexcept
Definition: LduMatrix.H:239
static autoPtr< Time > New()
Construct (dummy) Time - no functionObjects or libraries.
Definition: Time.C:717
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: autoPtr.H:66
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
T get(const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
A class for handling words, derived from Foam::string.
Definition: word.H:68
#define FatalIOErrorInLookup(ios, lookupTag, lookupName, lookupTable)
Report an error message using Foam::FatalIOError.
Definition: error.H:478
#define FatalIOErrorInFunction(ios)
Report an error message using Foam::FatalIOError.
Definition: error.H:473
IOerror FatalIOError
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:130