Merge branch 'master' of ssh://git.code.sf.net/p/foam-extend/foam-extend-3.2
[foam-extend-3.2.git] / src / foam / matrices / blockLduMatrix / BlockLduSmoothers / BlockLduSmoother / BlockLduSmoother.C
blob7ee80d266f7aab2b437b58cdb58c61bde6dc379a
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | foam-extend: Open Source CFD
4    \\    /   O peration     | Version:     3.2
5     \\  /    A nd           | Web:         http://www.foam-extend.org
6      \\/     M anipulation  | For copyright notice see file Copyright
7 -------------------------------------------------------------------------------
8 License
9     This file is part of foam-extend.
11     foam-extend is free software: you can redistribute it and/or modify it
12     under the terms of the GNU General Public License as published by the
13     Free Software Foundation, either version 3 of the License, or (at your
14     option) any later version.
16     foam-extend is distributed in the hope that it will be useful, but
17     WITHOUT ANY WARRANTY; without even the implied warranty of
18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19     General Public License for more details.
21     You should have received a copy of the GNU General Public License
22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
24 Class
25     BlockLduSmoother
27 Description
28     Block LDU matrix smoother virtual base class
30 \*---------------------------------------------------------------------------*/
32 #include "BlockLduSmoother.H"
34 template<class Type>
35 class BlockNoSmoother;
37 // * * * * * * * * * * * * * * * * Selectors * * * * * * * * * * * * * * * * //
39 template<class Type>
40 Foam::autoPtr<Foam::BlockLduSmoother<Type> > Foam::BlockLduSmoother<Type>::New
42     const BlockLduMatrix<Type>& matrix,
43     const dictionary& dict,
44     const word keyword
47     word smootherName;
49     // Handle primitive or dictionary entry
50     const entry& e = dict.lookupEntry(keyword, false, false);
51     if (e.isDict())
52     {
53         e.dict().lookup(keyword) >> smootherName;
54     }
55     else
56     {
57         e.stream() >> smootherName;
58     }
60     const dictionary& controls = e.isDict() ? e.dict() : dictionary::null;
62     typename dictionaryConstructorTable::iterator constructorIter =
63         dictionaryConstructorTablePtr_->find(smootherName);
65     if (constructorIter == dictionaryConstructorTablePtr_->end())
66     {
67         FatalIOErrorIn
68         (
69             "autoPtr<BlockLduSmoother> BlockLduSmoother::New\n"
70             "(\n"
71             "    const BlockLduMatrix<Type>& matrix,\n"
72             "    const dictionary& dict,\n"
73             "    const word keyword\n"
74             ")",
75             dict
76         )   << "Unknown matrix smoother " << smootherName
77             << endl << endl
78             << "Valid matrix smoothers are :" << endl
79             << dictionaryConstructorTablePtr_->sortedToc()
80             << exit(FatalIOError);
81     }
83     return autoPtr<BlockLduSmoother<Type> >
84     (
85         constructorIter()
86         (
87             matrix,
88             controls
89         )
90     );
94 // ************************************************************************* //