All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
refinementHistoryConstraint.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) 2015-2019 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::refinementHistoryConstraint
26 
27 Description
28  Constraint to keep all cells originating from refining the same cell
29  onto the same processor. Reads polyMesh/refinementHistory.
30 
31 SourceFiles
32  refinementHistoryConstraint.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef refinementHistoryConstraint_H
37 #define refinementHistoryConstraint_H
38 
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 
47 /*---------------------------------------------------------------------------*\
48  Class refinementHistoryConstraint Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 :
54 {
55  // Private Data
56 
57 public:
58 
59  //- Runtime type information
60  TypeName("refinementHistory");
61 
62 
63  // Constructors
64 
65  //- Construct with generic dictionary with optional entry for type
67  (
68  const dictionary& constraintsDict,
69  const word& type
70  );
71 
72  //- Construct from components
74 
75 
76  //- Destructor
78  {}
79 
80 
81  // Member Functions
82 
83  //- Add my constraints to list of constraints
84  virtual void add
85  (
86  const polyMesh& mesh,
87  boolList& blockedFace,
88  PtrList<labelList>& specifiedProcessorFaces,
89  labelList& specifiedProcessor,
90  List<labelPair>& explicitConnections
91  ) const;
92 
93  //- Apply any additional post-decomposition constraints
94  virtual void apply
95  (
96  const polyMesh& mesh,
97  const boolList& blockedFace,
98  const PtrList<labelList>& specifiedProcessorFaces,
99  const labelList& specifiedProcessor,
100  const List<labelPair>& explicitConnections,
101  labelList& decomposition
102  ) const;
103 };
104 
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 } // End namespace Foam
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 #endif
113 
114 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
Constraint to keep all cells originating from refining the same cell onto the same processor...
TypeName("refinementHistory")
Runtime type information.
virtual void apply(const polyMesh &mesh, const boolList &blockedFace, const PtrList< labelList > &specifiedProcessorFaces, const labelList &specifiedProcessor, const List< labelPair > &explicitConnections, labelList &decomposition) const
Apply any additional post-decomposition constraints.
dynamicFvMesh & mesh
refinementHistoryConstraint()
Construct from components.
A class for handling words, derived from string.
Definition: word.H:59
virtual void add(const polyMesh &mesh, boolList &blockedFace, PtrList< labelList > &specifiedProcessorFaces, labelList &specifiedProcessor, List< labelPair > &explicitConnections) const
Add my constraints to list of constraints.
A templated 1D list of pointers to objects of type <T>, where the size of the array is known and used...
Definition: List.H:70
fileType type(const fileName &, const bool checkVariants=true, const bool followLink=true)
Return the file type: directory or file.
Definition: POSIX.C:488
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
Namespace for OpenFOAM.