lduMatrixPreconditioner.C 4.02 KB
Newer Older
1 2 3 4
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
OpenFOAM bot's avatar
OpenFOAM bot committed
5
    \\  /    A nd           |
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
            FatalIOErrorInFunction(controls)
                << "Unknown symmetric matrix preconditioner "
98 99
                << name << nl << nl
                << "Valid symmetric matrix preconditioners :" << endl
100
                << symMatrixConstructorTablePtr_->sortedToc()
101 102 103 104 105
                << exit(FatalIOError);
        }

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

117
        if (!cstrIter.found())
118
        {
119 120
            FatalIOErrorInFunction(controls)
                << "Unknown asymmetric matrix preconditioner "
121 122
                << name << nl << nl
                << "Valid asymmetric matrix preconditioners :" << endl
123
                << asymMatrixConstructorTablePtr_->sortedToc()
124 125 126 127 128
                << exit(FatalIOError);
        }

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

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

142
    return nullptr;
143 144 145 146
}


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