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