dummyScotchDecomp.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 | Copyright (C) 2011-2015 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 "scotchDecomp.H"
28 #include "Time.H"
29 
30 static const char* notImplementedMessage =
31 "You are trying to use scotch but do not have the scotchDecomp library loaded."
32 "\nThis message is from the dummy scotchDecomp stub library instead.\n"
33 "\n"
34 "Please install scotch and make sure that libscotch.so is in your "
35 "LD_LIBRARY_PATH.\n"
36 "The scotchDecomp library can then be built in "
37 "$FOAM_SRC/parallel/decompose/decompositionMethods/scotchDecomp\n";
38 
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44  defineTypeNameAndDebug(scotchDecomp, 0);
45 
47  (
48  decompositionMethod,
49  scotchDecomp,
50  dictionary
51  );
52 }
53 
54 // * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
55 
56 void Foam::scotchDecomp::check(const int retVal, const char* str)
57 {}
58 
59 
61 (
62  const fileName& meshPath,
63  const List<label>& adjncy,
64  const List<label>& xadj,
65  const scalarField& cWeights,
66 
67  List<label>& finalDecomp
68 )
69 {
72 
73  return -1;
74 }
75 
76 
77 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
78 
80 (
81  const dictionary& decompositionDict
82 )
83 :
84  decompositionMethod(decompositionDict)
85 {}
86 
87 
88 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
89 
91 (
92  const polyMesh& mesh,
93  const pointField& points,
94  const scalarField& pointWeights
95 )
96 {
99 
100  return labelList::null();
101 }
102 
103 
105 (
106  const polyMesh& mesh,
107  const labelList& agglom,
108  const pointField& agglomPoints,
109  const scalarField& pointWeights
110 )
111 {
114 
115  return labelList::null();
116 }
117 
118 
120 (
121  const labelListList& globalCellCells,
122  const pointField& cellCentres,
123  const scalarField& cWeights
124 )
125 {
128 
129  return labelList::null();
130 }
131 
132 
133 // ************************************************************************* //
Foam::List::null
static const List< T > & null()
Return a null List.
Definition: ListI.H:43
Foam::fileName
A class for handling file names.
Definition: fileName.H:69
Foam::addToRunTimeSelectionTable
addToRunTimeSelectionTable(ensightPart, ensightPartCells, istream)
Foam::scotchDecomp::decompose
label decompose(const fileName &meshPath, const List< label > &adjncy, const List< label > &xadj, const scalarField &cWeights, List< label > &finalDecomp)
Definition: dummyScotchDecomp.C:61
Foam::polyMesh
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
Foam::scotchDecomp::check
static void check(const int, const char *)
Check and print error message.
Definition: dummyScotchDecomp.C:56
Foam::label
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
Foam::Field
Pre-declare SubField and related Field type.
Definition: Field.H:57
scotchDecomp.H
Foam::FatalError
error FatalError
Foam::dictionary
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:137
mesh
dynamicFvMesh & mesh
Definition: createDynamicFvMesh.H:18
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam::decompositionMethod
Abstract base class for decomposition.
Definition: decompositionMethod.H:48
Foam
Namespace for OpenFOAM.
Definition: combustionModel.C:30
notImplementedMessage
static const char * notImplementedMessage
Definition: dummyScotchDecomp.C:30
Foam::exit
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
FatalErrorInFunction
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:318
Foam::List< label >
points
const pointField & points
Definition: gmvOutputHeader.H:1
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)
Foam::scotchDecomp::scotchDecomp
scotchDecomp(const scotchDecomp &)