lduMatrixPreconditioner.C 4.48 KB
Newer Older
1 2 3 4
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
Mark Olesen's avatar
Mark Olesen committed
5
    \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
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 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
Foam::word
Foam::lduMatrix::preconditioner::getName
(
    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;
}


62 63 64 65
Foam::autoPtr<Foam::lduMatrix::preconditioner>
Foam::lduMatrix::preconditioner::New
(
    const solver& sol,
66
    const dictionary& solverControls
67 68
)
{
69 70 71 72 73 74 75 76 77 78 79 80 81 82
    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;
83 84 85 86

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

        if (constructorIter == symMatrixConstructorTablePtr_->end())
        {
            FatalIOErrorIn
            (
93 94 95
                "lduMatrix::preconditioner::New"
                "(const solver&, const dictionary&)",
                controls
96
            )   << "Unknown symmetric matrix preconditioner "
97 98
                << name << nl << nl
                << "Valid symmetric matrix preconditioners :" << endl
99
                << symMatrixConstructorTablePtr_->sortedToc()
100 101 102 103 104 105 106 107
                << exit(FatalIOError);
        }

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

        if (constructorIter == asymMatrixConstructorTablePtr_->end())
        {
            FatalIOErrorIn
            (
121 122 123
                "lduMatrix::preconditioner::New"
                "(const solver&, const dictionary&)",
                controls
124
            )   << "Unknown asymmetric matrix preconditioner "
125 126
                << name << nl << nl
                << "Valid asymmetric matrix preconditioners :" << endl
127
                << asymMatrixConstructorTablePtr_->sortedToc()
128 129 130 131 132 133 134 135
                << exit(FatalIOError);
        }

        return autoPtr<lduMatrix::preconditioner>
        (
            constructorIter()
            (
                sol,
136
                controls
137 138 139 140 141 142 143
            )
        );
    }
    else
    {
        FatalIOErrorIn
        (
144 145 146 147
            "lduMatrix::preconditioner::New"
            "(const solver&, const dictionary&)",
            controls
        )   << "cannot solve incomplete matrix, "
148 149 150 151 152 153 154 155 156
               "no diagonal or off-diagonal coefficient"
            << exit(FatalIOError);

        return autoPtr<lduMatrix::preconditioner>(NULL);
    }
}


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