lduMatrixPreconditioner.C 4.22 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 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
(
    const dictionary& solverControls
)
{
    word name;

    // handle primitive or dictionary entry
    const entry& e = solverControls.lookupEntry("preconditioner", false, false);
    if (e.isDict())
    {
        e.dict().lookup("preconditioner") >> name;
    }
    else
    {
        e.stream() >> name;
    }

    return name;
}


61 62 63 64
Foam::autoPtr<Foam::lduMatrix::preconditioner>
Foam::lduMatrix::preconditioner::New
(
    const solver& sol,
65
    const dictionary& solverControls
66 67
)
{
68 69 70 71 72 73 74 75 76 77 78 79 80 81
    word name;

    // handle primitive or dictionary entry
    const entry& e = solverControls.lookupEntry("preconditioner", false, false);
    if (e.isDict())
    {
        e.dict().lookup("preconditioner") >> name;
    }
    else
    {
        e.stream() >> name;
    }

    const dictionary& controls = e.isDict() ? e.dict() : dictionary::null;
82 83 84 85

    if (sol.matrix().symmetric())
    {
        symMatrixConstructorTable::iterator constructorIter =
86
            symMatrixConstructorTablePtr_->find(name);
87 88 89

        if (constructorIter == symMatrixConstructorTablePtr_->end())
        {
90
            FatalIOErrorInFunction
91
            (
92
                controls
93
            )   << "Unknown symmetric matrix preconditioner "
94 95
                << name << nl << nl
                << "Valid symmetric matrix preconditioners :" << endl
96
                << symMatrixConstructorTablePtr_->sortedToc()
97 98 99 100 101 102 103 104
                << exit(FatalIOError);
        }

        return autoPtr<lduMatrix::preconditioner>
        (
            constructorIter()
            (
                sol,
105
                controls
106 107 108 109 110 111
            )
        );
    }
    else if (sol.matrix().asymmetric())
    {
        asymMatrixConstructorTable::iterator constructorIter =
112
            asymMatrixConstructorTablePtr_->find(name);
113 114 115

        if (constructorIter == asymMatrixConstructorTablePtr_->end())
        {
116
            FatalIOErrorInFunction
117
            (
118
                controls
119
            )   << "Unknown asymmetric matrix preconditioner "
120 121
                << name << nl << nl
                << "Valid asymmetric matrix preconditioners :" << endl
122
                << asymMatrixConstructorTablePtr_->sortedToc()
123 124 125 126 127 128 129 130
                << exit(FatalIOError);
        }

        return autoPtr<lduMatrix::preconditioner>
        (
            constructorIter()
            (
                sol,
131
                controls
132 133 134 135 136
            )
        );
    }
    else
    {
137
        FatalIOErrorInFunction
138
        (
139 140
            controls
        )   << "cannot solve incomplete matrix, "
141 142 143
               "no diagonal or off-diagonal coefficient"
            << exit(FatalIOError);

144
        return autoPtr<lduMatrix::preconditioner>(nullptr);
145 146 147 148 149
    }
}


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