dummyKahipDecomp.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) 2017-2021 OpenCFD Ltd.
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
28 #include "kahipDecomp.H"
30 
31 static const char* notImplementedMessage =
32 "Attempted to use <kahip> without the kahipDecomp library loaded.\n"
33 "This message is from the dummy kahipDecomp stub library instead.\n\n"
34 "Please install <kahip> and ensure libkahip.so is in LD_LIBRARY_PATH.\n"
35 "The kahipDecomp library can then be built from "
36 "src/parallel/decompose/kahipDecomp.\n"
37 "Dynamically loading or linking this library will add "
38 "<kahip> as a decomposition method.\n";
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44  defineTypeNameAndDebug(kahipDecomp, 0);
46  (
47  decompositionMethod,
48  kahipDecomp,
49  dictionary
50  );
51 }
52 
53 
54 // * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
55 
57 (
58  const labelList& adjncy,
59  const labelList& xadj,
60  const List<scalar>& cellWeights,
61  labelList& decomp
62 ) const
63 {
66 
67  return -1;
68 }
69 
70 
71 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
72 
74 (
75  const dictionary& decompDict,
76  const word& regionName
77 )
78 :
79  metisLikeDecomp("kahip", decompDict, regionName)
80 {}
81 
82 
83 // ************************************************************************* //
Foam::addToRunTimeSelectionTable
addToRunTimeSelectionTable(decompositionMethod, kahipDecomp, dictionary)
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::kahipDecomp::decomposeSerial
virtual label decomposeSerial(const labelList &adjncy, const labelList &xadj, const List< scalar > &cellWeights, labelList &decomp) const
Call kahip with options from dictionary.
Definition: dummyKahipDecomp.C:57
regionName
Foam::word regionName
Definition: createNamedDynamicFvMesh.H:1
Foam::metisLikeDecomp
Domain decomposition using METIS-like data structures.
Definition: metisLikeDecomp.H:51
notImplementedMessage
static const char * notImplementedMessage
Definition: dummyKahipDecomp.C:31
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:123
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:453
Foam::List< label >
Foam::kahipDecomp::kahipDecomp
kahipDecomp(const kahipDecomp &)=delete
No copy construct.
kahipDecomp.H
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)