cvControlsI.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) 2012-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 \*---------------------------------------------------------------------------*/
25 
26 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
27 
29 {
30  return foamyHexMeshDict_;
31 }
32 
33 
34 inline Foam::scalar Foam::cvControls::pointPairDistanceCoeff() const
35 {
36  return pointPairDistanceCoeff_;
37 }
38 
39 
41 {
42  return mixedFeaturePointPPDistanceCoeff_;
43 }
44 
45 
47 {
48  return featurePointExclusionDistanceCoeff_;
49 }
50 
51 
53 {
54  return featureEdgeExclusionDistanceCoeff_;
55 }
56 
57 
59 {
60  return guardFeaturePoints_;
61 }
62 
64 {
65  return edgeAiming_;
66 }
67 
69 {
70  return snapFeaturePoints_;
71 }
72 
74 {
75  return circulateEdges_;
76 }
77 
78 
80 {
81  return surfacePtExclusionDistanceCoeff_;
82 }
83 
85 {
86  return specialiseFeaturePoints_;
87 }
88 
90 {
91  return surfaceSearchDistanceCoeff_;
92 }
93 
94 
96 {
97  return maxSurfaceProtrusionCoeff_;
98 }
99 
100 
101 inline Foam::scalar Foam::cvControls::maxQuadAngle() const
102 {
103  return maxQuadAngle_;
104 }
105 
106 
108 {
109  return surfaceConformationRebuildFrequency_;
110 }
111 
112 
113 inline Foam::scalar Foam::cvControls::edgeSearchDistCoeffSqr() const
114 {
115  return edgeSearchDistCoeffSqr_;
116 }
117 
118 
120 {
121  return surfacePtReplaceDistCoeffSqr_;
122 }
123 
124 
126 {
127  return maxConformationIterations_;
128 }
129 
130 
132 {
133  return iterationToInitialHitRatioLimit_;
134 }
135 
136 
137 inline Foam::scalar Foam::cvControls::defaultCellSize() const
138 {
139  return defaultCellSize_;
140 }
141 
142 
143 inline Foam::scalar Foam::cvControls::minimumCellSize() const
144 {
145  return minimumCellSize_;
146 }
147 
148 
150 {
151  return objOutput_;
152 }
153 
154 
156 {
157  return timeChecks_;
158 }
159 
160 
162 {
163  return printVertexInfo_;
164 }
165 
166 
167 inline Foam::scalar Foam::cvControls::maxLoadUnbalance() const
168 {
169  return maxLoadUnbalance_;
170 }
171 
172 
174 {
175  return cosAlignmentAcceptanceAngle_;
176 }
177 
178 
179 inline Foam::scalar Foam::cvControls::insertionDistCoeff() const
180 {
181  return insertionDistCoeff_;
182 }
183 
184 
185 inline Foam::scalar Foam::cvControls::faceAreaRatioCoeff() const
186 {
187  return faceAreaRatioCoeff_;
188 }
189 
190 
192 {
193  return cosInsertionAcceptanceAngle_;
194 }
195 
196 
197 inline Foam::scalar Foam::cvControls::removalDistCoeff() const
198 {
199  return removalDistCoeff_;
200 }
201 
202 
204 {
205  return filterEdges_;
206 }
207 
209 {
210  return filterFaces_;
211 }
212 
214 {
215  return writeTetDualMesh_;
216 }
217 
219 {
220  return writeCellShapeControlMesh_;
221 }
222 
224 {
225  return writeBackgroundMeshDecomposition_;
226 }
227 
228 
229 // ************************************************************************* //
Switch printVertexInfo() const
Return the printVertexInfo Switch.
Definition: cvControlsI.H:161
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
scalar pointPairDistanceCoeff() const
Return the pointPairDistanceCoeff.
Definition: cvControlsI.H:34
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
scalar cosAlignmentAcceptanceAngle() const
Return the cosAlignmentAcceptanceAngle.
Definition: cvControlsI.H:173
Switch writeTetDualMesh() const
Write tetMesh at output time.
Definition: cvControlsI.H:213
scalar surfaceSearchDistanceCoeff() const
Return the surfaceSearchDistanceCoeff.
Definition: cvControlsI.H:89
A simple wrapper around bool so that it can be read as a word: true/false, on/off, yes/no, y/n, t/f, or none/any.
Definition: Switch.H:60
scalar faceAreaRatioCoeff() const
Return the faceAreaRatioCoeff.
Definition: cvControlsI.H:185
label surfaceConformationRebuildFrequency() const
Return the surfaceConformationRebuildFrequency.
Definition: cvControlsI.H:107
const dictionary & foamyHexMeshDict() const
Return the foamyHexMeshDict.
Definition: cvControlsI.H:28
scalar featureEdgeExclusionDistanceCoeff() const
Return the featureEdgeExclusionDistanceCoeff.
Definition: cvControlsI.H:52
scalar removalDistCoeff() const
Return removalDistCoeff.
Definition: cvControlsI.H:197
scalar defaultCellSize() const
Return the defaultCellSize.
Definition: cvControlsI.H:137
scalar maxQuadAngle() const
Return the maxQuadAngle.
Definition: cvControlsI.H:101
scalar featurePointExclusionDistanceCoeff() const
Return the featurePointExclusionDistanceCoeff.
Definition: cvControlsI.H:46
scalar surfacePtExclusionDistanceCoeff() const
Return the surfacePtExclusionDistanceCoeff.
Definition: cvControlsI.H:79
scalar maxSurfaceProtrusionCoeff() const
Return the maxSurfaceProtrusionCoeff.
Definition: cvControlsI.H:95
scalar edgeSearchDistCoeffSqr() const
Return the edgeSearchDistCoeffSqr for conformation.
Definition: cvControlsI.H:113
Switch filterFaces() const
Filter faces at output time.
Definition: cvControlsI.H:208
Switch writeBackgroundMeshDecomposition() const
Write backgroundMeshDecomposition at output time.
Definition: cvControlsI.H:223
Switch timeChecks() const
Return the timeChecks Switch.
Definition: cvControlsI.H:155
Switch edgeAiming() const
Definition: cvControlsI.H:63
scalar minimumCellSize() const
Return the minimumCellSize.
Definition: cvControlsI.H:143
label maxConformationIterations() const
Return the maxConformationIterations.
Definition: cvControlsI.H:125
Switch objOutput() const
Return the objOutput Switch.
Definition: cvControlsI.H:149
Switch snapFeaturePoints() const
Definition: cvControlsI.H:68
scalar maxLoadUnbalance() const
Return the maxLoadUnbalance.
Definition: cvControlsI.H:167
scalar iterationToInitialHitRatioLimit() const
Return the iterationToInitialHitRatioLimit.
Definition: cvControlsI.H:131
Switch filterEdges() const
Filter edges at output time.
Definition: cvControlsI.H:203
Switch writeCellShapeControlMesh() const
Write cellShapeControlMesh at output time.
Definition: cvControlsI.H:218
scalar cosInsertionAcceptanceAngle() const
Return the cosInsertionAcceptanceAngle.
Definition: cvControlsI.H:191
Switch circulateEdges() const
Definition: cvControlsI.H:73
Switch specialiseFeaturePoints() const
Return whether to use specialised feature points.
Definition: cvControlsI.H:84
scalar insertionDistCoeff() const
Return the insertionDistCoeff.
Definition: cvControlsI.H:179
scalar surfacePtReplaceDistCoeffSqr() const
Return the surfacePtReplaceDistCoeffSqr for conformation.
Definition: cvControlsI.H:119
Switch guardFeaturePoints() const
Definition: cvControlsI.H:58
scalar mixedFeaturePointPPDistanceCoeff() const
Return the mixedFeaturePointPPDistanceCoeff.
Definition: cvControlsI.H:40