structuredDecomp.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-2021 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::structuredDecomp
26 
27 Description
28  Decomposition by walking out decomposition of patch cells mesh.
29 
30 SourceFiles
31  structuredDecomp.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef structuredDecomp_H
36 #define structuredDecomp_H
37 
38 #include "decompositionMethod.H"
39 
40 namespace Foam
41 {
42 
43 /*---------------------------------------------------------------------------*\
44  Class structuredDecomp Declaration
45 \*---------------------------------------------------------------------------*/
46 
47 class structuredDecomp
48 :
49  public decompositionMethod
50 {
51  // Private Data
52 
53  dictionary methodDict_;
54 
55  wordReList patches_;
56 
58 
59 
60 public:
61 
62  //- Runtime type information
63  TypeName("structured");
64 
65 
66  // Constructors
67 
68  //- Construct given the decomposition dictionary
69  structuredDecomp(const dictionary& decompositionDict);
70 
71  //- Disallow default bitwise copy construction
72  structuredDecomp(const structuredDecomp&) = delete;
73 
74 
75  //- Destructor
76  virtual ~structuredDecomp()
77  {}
78 
79 
80  // Member Functions
81 
82  //- Is method parallel aware (i.e. does it synchronise domains across
83  // proc boundaries)
84  virtual bool parallelAware() const;
85 
86  //- Return for every coordinate the wanted processor number. Use the
87  // mesh connectivity (if needed)
88  virtual labelList decompose
89  (
90  const polyMesh& mesh,
91  const pointField& points,
92  const scalarField& pointWeights
93  );
94 
95  //- Return for every coordinate the wanted processor number. Explicitly
96  // provided connectivity - does not use mesh_.
97  virtual labelList decompose
98  (
99  const labelListList& globalCellCells,
100  const pointField& cc,
101  const scalarField& cWeights
102  );
103 
104 
105  // Member Operators
106 
107  //- Disallow default bitwise assignment
108  void operator=(const structuredDecomp&) = delete;
109 };
110 
111 
112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113 
114 } // End namespace Foam
115 
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117 
118 #endif
119 
120 // ************************************************************************* //
void operator=(const structuredDecomp &)=delete
Disallow default bitwise assignment.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
TypeName("structured")
Runtime type information.
dynamicFvMesh & mesh
const pointField & points
Decomposition by walking out decomposition of patch cells mesh.
virtual labelList decompose(const polyMesh &mesh, const pointField &points, const scalarField &pointWeights)
Return for every coordinate the wanted processor number. Use the.
virtual ~structuredDecomp()
Destructor.
Abstract base class for decomposition.
virtual bool parallelAware() const
Is method parallel aware (i.e. does it synchronise domains across.
structuredDecomp(const dictionary &decompositionDict)
Construct given the decomposition dictionary.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
Namespace for OpenFOAM.