manualDecomp.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 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 Class
25  Foam::manualDecomp
26 
27 Description
28  Decomposition given a cell-to-processor association in a file
29 
30 SourceFiles
31  manualDecomp.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef manualDecomp_H
36 #define manualDecomp_H
37 
38 #include "decompositionMethod.H"
39 
40 namespace Foam
41 {
42 
43 /*---------------------------------------------------------------------------*\
44  Class manualDecomp Declaration
45 \*---------------------------------------------------------------------------*/
46 
47 class manualDecomp
48 :
49  public decompositionMethod
50 {
51  // Private data
52 
53  fileName decompDataFile_;
54 
55 
56  // Private Member Functions
57 
58  //- Disallow default bitwise copy construct and assignment
59  void operator=(const manualDecomp&);
60  manualDecomp(const manualDecomp&);
61 
62 
63 public:
64 
65  //- Runtime type information
66  TypeName("manual");
67 
68 
69  // Constructors
70 
71  //- Construct given the decomposition dictionary
72  manualDecomp(const dictionary& decompositionDict);
73 
74  //- Destructor
75  virtual ~manualDecomp()
76  {}
77 
78 
79  // Member Functions
80 
81  //- Manual decompose does not care about proc boundaries - is all
82  // up to the user.
83  virtual bool parallelAware() const
84  {
85  return true;
86  }
87 
88  //- Return for every coordinate the wanted processor number. Use the
89  // mesh connectivity (if needed)
90  virtual labelList decompose
91  (
92  const polyMesh& mesh,
93  const pointField& cc,
94  const scalarField& cWeights
95  );
96 
97  //- Return for every coordinate the wanted processor number. Explicitly
98  // provided connectivity - does not use mesh_.
99  // The connectivity is equal to mesh.cellCells() except for
100  // - in parallel the cell numbers are global cell numbers (starting
101  // from 0 at processor0 and then incrementing all through the
102  // processors)
103  // - the connections are across coupled patches
105  (
106  const labelListList& globalCellCells,
107  const pointField& cc,
108  const scalarField& cWeights
109  )
110  {
112  return labelList(0);
113  }
114 
115 };
116 
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 } // End namespace Foam
121 
122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
123 
124 #endif
125 
126 // ************************************************************************* //
A class for handling file names.
Definition: fileName.H:69
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual ~manualDecomp()
Destructor.
Definition: manualDecomp.H:74
virtual labelList decompose(const polyMesh &mesh, const pointField &cc, const scalarField &cWeights)
Return for every coordinate the wanted processor number. Use the.
Definition: manualDecomp.C:67
dynamicFvMesh & mesh
List< label > labelList
A List of labels.
Definition: labelList.H:56
Abstract base class for decomposition.
TypeName("manual")
Runtime type information.
virtual bool parallelAware() const
Manual decompose does not care about proc boundaries - is all.
Definition: manualDecomp.H:82
Decomposition given a cell-to-processor association in a file.
Definition: manualDecomp.H:46
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
Definition: error.H:366
Namespace for OpenFOAM.