lduMatrixPreconditioner.C 3.89 KB
Newer Older
1 2 3 4
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
5
    \\  /    A nd           | Copyright (C) 2019 OpenCFD Ltd.
6
     \\/     M anipulation  |
OpenFOAM bot's avatar
OpenFOAM bot committed
7 8
-------------------------------------------------------------------------------
                            | Copyright (C) 2011-2016 OpenFOAM Foundation
9 10 11 12
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

13 14 15 16
    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
17 18 19 20 21 22 23

    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.

    You should have received a copy of the GNU General Public License
24
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40

\*---------------------------------------------------------------------------*/

#include "lduMatrix.H"

// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //

namespace Foam
{
    defineRunTimeSelectionTable(lduMatrix::preconditioner, symMatrix);
    defineRunTimeSelectionTable(lduMatrix::preconditioner, asymMatrix);
}


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

41
Foam::word Foam::lduMatrix::preconditioner::getName
42 43 44 45 46 47
(
    const dictionary& solverControls
)
{
    word name;

48 49 50 51
    // Handle primitive or dictionary entry
    const entry& e =
        solverControls.lookupEntry("preconditioner", keyType::LITERAL);

52 53
    if (e.isDict())
    {
54
        e.dict().readEntry("preconditioner", name);
55 56 57 58 59 60 61 62 63 64
    }
    else
    {
        e.stream() >> name;
    }

    return name;
}


65 66 67 68
Foam::autoPtr<Foam::lduMatrix::preconditioner>
Foam::lduMatrix::preconditioner::New
(
    const solver& sol,
69
    const dictionary& solverControls
70 71
)
{
72 73
    word name;

74 75 76 77 78
    // Handle primitive or dictionary entry

    const entry& e =
        solverControls.lookupEntry("preconditioner", keyType::LITERAL);

79 80
    if (e.isDict())
    {
81
        e.dict().readEntry("preconditioner", name);
82 83 84 85 86 87 88
    }
    else
    {
        e.stream() >> name;
    }

    const dictionary& controls = e.isDict() ? e.dict() : dictionary::null;
89 90 91

    if (sol.matrix().symmetric())
    {
92
        auto cstrIter = symMatrixConstructorTablePtr_->cfind(name);
93

94
        if (!cstrIter.found())
95
        {
96 97 98 99 100 101 102
            FatalIOErrorInLookup
            (
                controls,
                "symmetric matrix preconditioner",
                name,
                *symMatrixConstructorTablePtr_
            ) << exit(FatalIOError);
103 104 105 106
        }

        return autoPtr<lduMatrix::preconditioner>
        (
107
            cstrIter()
108 109
            (
                sol,
110
                controls
111 112 113 114 115
            )
        );
    }
    else if (sol.matrix().asymmetric())
    {
116
        auto cstrIter = asymMatrixConstructorTablePtr_->cfind(name);
117

118
        if (!cstrIter.found())
119
        {
120 121 122 123 124 125 126
            FatalIOErrorInLookup
            (
                controls,
                "asymmetric matrix preconditioner",
                name,
                *asymMatrixConstructorTablePtr_
            ) << exit(FatalIOError);
127 128 129 130
        }

        return autoPtr<lduMatrix::preconditioner>
        (
131
            cstrIter()
132 133
            (
                sol,
134
                controls
135 136 137 138
            )
        );
    }

139 140
    FatalIOErrorInFunction(controls)
        << "cannot solve incomplete matrix, "
141 142 143
           "no diagonal or off-diagonal coefficient"
        << exit(FatalIOError);

144
    return nullptr;
145 146 147 148
}


// ************************************************************************* //