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  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
70  (
71  const dictionary& decompositionDict,
72  const dictionary& methodDict
73  );
74 
75  //- Disallow default bitwise copy construction
76  structured(const structured&) = delete;
77 
78 
79  //- Destructor
80  virtual ~structured()
81  {}
82 
83 
84  // Member Functions
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& cellCentres,
101  const scalarField& cellWeights
102  );
103 
104 
105  // Member Operators
106 
107  //- Disallow default bitwise assignment
108  void operator=(const structured&) = delete;
109 };
110 
111 
112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113 
114 } // End namespace decompositionMethods
115 } // End namespace Foam
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 #endif
120 
121 // ************************************************************************* //
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:79
structured(const dictionary &decompositionDict, const dictionary &methodDict)
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:78
TypeName("structured")
Runtime type information.
void operator=(const structured &)=delete
Disallow default bitwise assignment.
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:80
Foam::fvMesh mesh(Foam::IOobject(regionName, runTime.name(), runTime, Foam::IOobject::MUST_READ), false)
const pointField & points
Namespace for OpenFOAM.