cvControlsI.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2012-2015 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
28 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
29 
31 {
32  return foamyHexMeshDict_;
33 }
34 
35 
36 inline Foam::scalar Foam::cvControls::pointPairDistanceCoeff() const
37 {
38  return pointPairDistanceCoeff_;
39 }
40 
41 
43 {
44  return mixedFeaturePointPPDistanceCoeff_;
45 }
46 
47 
49 {
50  return featurePointExclusionDistanceCoeff_;
51 }
52 
53 
55 {
56  return featureEdgeExclusionDistanceCoeff_;
57 }
58 
59 
61 {
62  return guardFeaturePoints_;
63 }
64 
66 {
67  return edgeAiming_;
68 }
69 
71 {
72  return snapFeaturePoints_;
73 }
74 
76 {
77  return circulateEdges_;
78 }
79 
80 
81 inline Foam::scalar Foam::cvControls::surfacePtExclusionDistanceCoeff() const
82 {
83  return surfacePtExclusionDistanceCoeff_;
84 }
85 
87 {
88  return specialiseFeaturePoints_;
89 }
90 
91 inline Foam::scalar Foam::cvControls::surfaceSearchDistanceCoeff() const
92 {
93  return surfaceSearchDistanceCoeff_;
94 }
95 
96 
97 inline Foam::scalar Foam::cvControls::maxSurfaceProtrusionCoeff() const
98 {
99  return maxSurfaceProtrusionCoeff_;
100 }
101 
103 inline Foam::scalar Foam::cvControls::maxQuadAngle() const
104 {
105  return maxQuadAngle_;
106 }
107 
110 {
111  return surfaceConformationRebuildFrequency_;
112 }
113 
115 inline Foam::scalar Foam::cvControls::edgeSearchDistCoeffSqr() const
116 {
117  return edgeSearchDistCoeffSqr_;
118 }
119 
121 inline Foam::scalar Foam::cvControls::surfacePtReplaceDistCoeffSqr() const
122 {
123  return surfacePtReplaceDistCoeffSqr_;
124 }
125 
127 inline Foam::label Foam::cvControls::maxConformationIterations() const
128 {
129  return maxConformationIterations_;
130 }
131 
133 inline Foam::scalar Foam::cvControls::iterationToInitialHitRatioLimit() const
134 {
135  return iterationToInitialHitRatioLimit_;
136 }
137 
139 inline Foam::scalar Foam::cvControls::defaultCellSize() const
140 {
141  return defaultCellSize_;
142 }
143 
145 inline Foam::scalar Foam::cvControls::minimumCellSize() const
146 {
147  return minimumCellSize_;
148 }
149 
152 {
153  return objOutput_;
154 }
155 
158 {
159  return timeChecks_;
160 }
161 
164 {
165  return printVertexInfo_;
166 }
167 
169 inline Foam::scalar Foam::cvControls::maxLoadUnbalance() const
170 {
171  return maxLoadUnbalance_;
172 }
173 
175 inline Foam::scalar Foam::cvControls::cosAlignmentAcceptanceAngle() const
176 {
177  return cosAlignmentAcceptanceAngle_;
178 }
179 
181 inline Foam::scalar Foam::cvControls::insertionDistCoeff() const
182 {
183  return insertionDistCoeff_;
184 }
185 
187 inline Foam::scalar Foam::cvControls::faceAreaRatioCoeff() const
188 {
189  return faceAreaRatioCoeff_;
190 }
191 
193 inline Foam::scalar Foam::cvControls::cosInsertionAcceptanceAngle() const
194 {
195  return cosInsertionAcceptanceAngle_;
196 }
197 
199 inline Foam::scalar Foam::cvControls::removalDistCoeff() const
200 {
201  return removalDistCoeff_;
202 }
204 
206 {
207  return filterEdges_;
208 }
209 
211 {
212  return filterFaces_;
213 }
214 
216 {
217  return writeTetDualMesh_;
218 }
219 
221 {
222  return writeCellShapeControlMesh_;
223 }
224 
226 {
227  return writeBackgroundMeshDecomposition_;
228 }
229 
230 
231 // ************************************************************************* //
Switch printVertexInfo() const
Return the printVertexInfo Switch.
Definition: cvControlsI.H:156
scalar pointPairDistanceCoeff() const
Return the pointPairDistanceCoeff.
Definition: cvControlsI.H:29
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition: dictionary.H:129
scalar cosAlignmentAcceptanceAngle() const
Return the cosAlignmentAcceptanceAngle.
Definition: cvControlsI.H:168
Switch writeTetDualMesh() const
Write tetMesh at output time.
Definition: cvControlsI.H:208
scalar surfaceSearchDistanceCoeff() const
Return the surfaceSearchDistanceCoeff.
Definition: cvControlsI.H:84
A simple wrapper around bool so that it can be read as a word: true/false, on/off, yes/no, any/none. Also accepts 0/1 as a string and shortcuts t/f, y/n.
Definition: Switch.H:77
scalar faceAreaRatioCoeff() const
Return the faceAreaRatioCoeff.
Definition: cvControlsI.H:180
label surfaceConformationRebuildFrequency() const
Return the surfaceConformationRebuildFrequency.
Definition: cvControlsI.H:102
const dictionary & foamyHexMeshDict() const
Return the foamyHexMeshDict.
Definition: cvControlsI.H:23
scalar featureEdgeExclusionDistanceCoeff() const
Return the featureEdgeExclusionDistanceCoeff.
Definition: cvControlsI.H:47
scalar removalDistCoeff() const
Return removalDistCoeff.
Definition: cvControlsI.H:192
scalar defaultCellSize() const
Return the defaultCellSize.
Definition: cvControlsI.H:132
scalar maxQuadAngle() const
Return the maxQuadAngle.
Definition: cvControlsI.H:96
scalar featurePointExclusionDistanceCoeff() const
Return the featurePointExclusionDistanceCoeff.
Definition: cvControlsI.H:41
scalar surfacePtExclusionDistanceCoeff() const
Return the surfacePtExclusionDistanceCoeff.
Definition: cvControlsI.H:74
scalar maxSurfaceProtrusionCoeff() const
Return the maxSurfaceProtrusionCoeff.
Definition: cvControlsI.H:90
scalar edgeSearchDistCoeffSqr() const
Return the edgeSearchDistCoeffSqr for conformation.
Definition: cvControlsI.H:108
Switch filterFaces() const
Filter faces at output time.
Definition: cvControlsI.H:203
Switch writeBackgroundMeshDecomposition() const
Write backgroundMeshDecomposition at output time.
Definition: cvControlsI.H:218
Switch timeChecks() const
Return the timeChecks Switch.
Definition: cvControlsI.H:150
Switch edgeAiming() const
Definition: cvControlsI.H:58
scalar minimumCellSize() const
Return the minimumCellSize.
Definition: cvControlsI.H:138
label maxConformationIterations() const
Return the maxConformationIterations.
Definition: cvControlsI.H:120
Switch objOutput() const
Return the objOutput Switch.
Definition: cvControlsI.H:144
Switch snapFeaturePoints() const
Definition: cvControlsI.H:63
scalar maxLoadUnbalance() const
Return the maxLoadUnbalance.
Definition: cvControlsI.H:162
scalar iterationToInitialHitRatioLimit() const
Return the iterationToInitialHitRatioLimit.
Definition: cvControlsI.H:126
Switch filterEdges() const
Filter edges at output time.
Definition: cvControlsI.H:198
Switch writeCellShapeControlMesh() const
Write cellShapeControlMesh at output time.
Definition: cvControlsI.H:213
scalar cosInsertionAcceptanceAngle() const
Return the cosInsertionAcceptanceAngle.
Definition: cvControlsI.H:186
Switch circulateEdges() const
Definition: cvControlsI.H:68
Switch specialiseFeaturePoints() const
Return whether to use specialised feature points.
Definition: cvControlsI.H:79
scalar insertionDistCoeff() const
Return the insertionDistCoeff.
Definition: cvControlsI.H:174
scalar surfacePtReplaceDistCoeffSqr() const
Return the surfacePtReplaceDistCoeffSqr for conformation.
Definition: cvControlsI.H:114
Switch guardFeaturePoints() const
Definition: cvControlsI.H:53
scalar mixedFeaturePointPPDistanceCoeff() const
Return the mixedFeaturePointPPDistanceCoeff.
Definition: cvControlsI.H:35