src/dummyThirdParty/metisDecomp/dummyMetisDecomp.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     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 #include "metisDecomp.H"
  27 #include "addToRunTimeSelectionTable.H"
  28 #include "Time.H"
  29
  30 static const char* notImplementedMessage =
  31 "You are trying to use metis but do not have the metisDecomp library loaded."
  32 "\nThis message is from the dummy metisDecomp stub library instead.\n"
  33 "\n"
  34 "Please install metis and make sure that libmetis.so is in your "
  35 "LD_LIBRARY_PATH.\n"
  36 "The metisDecomp library can then be built from "
  37 "$FOAM_SRC/parallel/decompose/metisDecomp and dynamically loading or linking"
  38 " this library will add metis as a decomposition method.\n"
  39 "Please be aware that there are license restrictions on using Metis.";
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45     defineTypeNameAndDebug(metisDecomp, 0);
  46
  47     addToRunTimeSelectionTable
  48     (
  49         decompositionMethod,
  50         metisDecomp,
  51         dictionary
  52     );
  53 }
  54
  55
  56 // * * * * * * * * * * * * * Private Member Functions  * * * * * * * * * * * //
  57
  58 Foam::label Foam::metisDecomp::decompose
  59 (
  60     const List<int>& adjncy,
  61     const List<int>& xadj,
  62     const scalarField& cellWeights,
  63     List<int>& finalDecomp
  64 )
  65 {
  66     FatalErrorIn
  67     (
  68         "labelList metisDecomp::decompose"
  69         "("
  70             "const List<int>&, "
  71             "const List<int>&, "
  72             "const scalarField&, "
  73             "List<int>&"
  74         ")"
  75     )   << notImplementedMessage << exit(FatalError);
  76
  77     return -1;
  78 }
  79
  80
  81 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  82
  83 Foam::metisDecomp::metisDecomp
  84 (
  85     const dictionary& decompositionDict
  86 )
  87 :
  88     decompositionMethod(decompositionDict)
  89 {}
  90
  91
  92 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  93
  94 Foam::labelList Foam::metisDecomp::decompose
  95 (
  96     const polyMesh& mesh,
  97     const pointField& points,
  98     const scalarField& pointWeights
  99 )
 100 {
 101     FatalErrorIn
 102     (
 103         "labelList metisDecomp::decompose"
 104         "("
 105             "const pointField&, "
 106             "const scalarField&"
 107         ")"
 108     )   << notImplementedMessage << exit(FatalError);
 109
 110     return labelList();
 111 }
 112
 113
 114 Foam::labelList Foam::metisDecomp::decompose
 115 (
 116     const polyMesh& mesh,
 117     const labelList& agglom,
 118     const pointField& agglomPoints,
 119     const scalarField& agglomWeights
 120 )
 121 {
 122     FatalErrorIn
 123     (
 124         "labelList metisDecomp::decompose"
 125         "("
 126             "const labelList&, "
 127             "const pointField&, "
 128             "const scalarField&"
 129         ")"
 130     )   << notImplementedMessage << exit(FatalError);
 131
 132     return labelList();
 133 }
 134
 135
 136 Foam::labelList Foam::metisDecomp::decompose
 137 (
 138     const labelListList& globalCellCells,
 139     const pointField& cellCentres,
 140     const scalarField& cellWeights
 141 )
 142 {
 143     FatalErrorIn
 144     (
 145         "labelList metisDecomp::decompose"
 146         "("
 147             "const labelListList&, "
 148             "const pointField&, "
 149             "const scalarField&"
 150         ")"
 151     )   << notImplementedMessage << exit(FatalError);
 152
 153     return labelList();
 154 }
 155
 156
 157 // ************************************************************************* //