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

11 12 13 14
    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.
15 16 17 18 19 20 21

    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
22
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38

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

#include "lduMatrix.H"

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

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


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

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

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

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

    return name;
}


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

72 73 74 75 76
    // Handle primitive or dictionary entry

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

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

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

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

92
        if (!cstrIter.found())
93
        {
94
            FatalIOErrorInFunction
95
            (
96
                controls
97
            )   << "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
            FatalIOErrorInFunction
120
            (
121
                controls
122
            )   << "Unknown asymmetric matrix preconditioner "
123 124
                << name << nl << nl
                << "Valid asymmetric matrix preconditioners :" << endl
125
                << asymMatrixConstructorTablePtr_->sortedToc()
126 127 128 129 130
                << exit(FatalIOError);
        }

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

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

146
    return nullptr;
147 148 149 150
}


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