dummyMetisDecomp.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2015 OpenFOAM Foundation
9  Copyright (C) 2018-2019 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 \*---------------------------------------------------------------------------*/
28 
29 #include "metisDecomp.H"
31 
32 static const char* notImplementedMessage =
33 "Attempted to use <metis> without the metisDecomp library loaded.\n"
34 "This message is from the dummy metisDecomp stub library instead.\n\n"
35 "Please install <metis> and ensure libmetis.so is in LD_LIBRARY_PATH.\n"
36 "The metisDecomp library can then be built from "
37 "src/parallel/decompose/metisDecomp.\n"
38 "Dynamically loading or linking this library will add "
39 "<metis> as a decomposition method.\n";
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45  defineTypeNameAndDebug(metisDecomp, 0);
46 
48  (
49  decompositionMethod,
50  metisDecomp,
51  dictionary
52  );
53 }
54 
55 
56 // * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
57 
59 (
60  const labelList& adjncy,
61  const labelList& xadj,
62  const List<scalar>& cellWeights,
63  labelList& decomp
64 ) const
65 {
68 
69  return -1;
70 }
71 
72 
73 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
74 
76 (
77  const dictionary& decompDict
78 )
79 :
80  metisLikeDecomp("metis", decompDict)
81 {}
82 
83 
85 (
86  const dictionary& decompDict,
87  const word& regionName
88 )
89 :
90  metisLikeDecomp("metis", decompDict, regionName)
91 {}
92 
93 
94 // ************************************************************************* //
Foam::addToRunTimeSelectionTable
addToRunTimeSelectionTable(decompositionMethod, kahipDecomp, dictionary)
metisDecomp.H
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
Foam::metisDecomp::decomposeSerial
virtual label decomposeSerial(const labelList &adjncy, const labelList &xadj, const List< scalar > &cellWeights, labelList &decomp) const
Decompose non-parallel.
Definition: dummyMetisDecomp.C:59
regionName
Foam::word regionName
Definition: createNamedDynamicFvMesh.H:1
Foam::metisLikeDecomp
Domain decomposition using METIS-like data structures.
Definition: metisLikeDecomp.H:51
Foam::metisDecomp::metisDecomp
metisDecomp(const metisDecomp &)=delete
No copy construct.
notImplementedMessage
static const char * notImplementedMessage
Definition: dummyMetisDecomp.C:32
Foam::FatalError
error FatalError
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::exit
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:130
FatalErrorInFunction
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:381
Foam::List< label >
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)