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-------------------------------------------------------------------------------
10License
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
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
82{
83 return surfacePtExclusionDistanceCoeff_;
84}
85
87{
88 return specialiseFeaturePoints_;
89}
90
92{
93 return surfaceSearchDistanceCoeff_;
94}
95
96
98{
99 return maxSurfaceProtrusionCoeff_;
100}
101
102
103inline Foam::scalar Foam::cvControls::maxQuadAngle() const
104{
105 return maxQuadAngle_;
106}
107
108
110{
111 return surfaceConformationRebuildFrequency_;
112}
113
114
116{
117 return edgeSearchDistCoeffSqr_;
118}
119
120
122{
123 return surfacePtReplaceDistCoeffSqr_;
124}
125
126
128{
129 return maxConformationIterations_;
130}
131
132
134{
135 return iterationToInitialHitRatioLimit_;
136}
137
138
139inline Foam::scalar Foam::cvControls::defaultCellSize() const
140{
141 return defaultCellSize_;
142}
143
144
145inline Foam::scalar Foam::cvControls::minimumCellSize() const
146{
147 return minimumCellSize_;
148}
149
150
152{
153 return objOutput_;
154}
155
156
158{
159 return timeChecks_;
160}
161
162
164{
165 return printVertexInfo_;
166}
167
168
169inline Foam::scalar Foam::cvControls::maxLoadUnbalance() const
170{
171 return maxLoadUnbalance_;
172}
173
174
176{
177 return cosAlignmentAcceptanceAngle_;
178}
179
180
181inline Foam::scalar Foam::cvControls::insertionDistCoeff() const
182{
183 return insertionDistCoeff_;
184}
185
186
187inline Foam::scalar Foam::cvControls::faceAreaRatioCoeff() const
188{
189 return faceAreaRatioCoeff_;
190}
191
192
194{
195 return cosInsertionAcceptanceAngle_;
196}
197
198
199inline Foam::scalar Foam::cvControls::removalDistCoeff() const
200{
201 return removalDistCoeff_;
202}
203
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// ************************************************************************* //
A simple wrapper around bool so that it can be read as a word: true/false, on/off,...
Definition: Switch.H:78
scalar defaultCellSize() const
Return the defaultCellSize.
Definition: cvControlsI.H:139
Switch objOutput() const
Return the objOutput Switch.
Definition: cvControlsI.H:151
Switch printVertexInfo() const
Return the printVertexInfo Switch.
Definition: cvControlsI.H:163
scalar insertionDistCoeff() const
Return the insertionDistCoeff.
Definition: cvControlsI.H:181
scalar surfaceSearchDistanceCoeff() const
Return the surfaceSearchDistanceCoeff.
Definition: cvControlsI.H:91
label surfaceConformationRebuildFrequency() const
Return the surfaceConformationRebuildFrequency.
Definition: cvControlsI.H:109
scalar edgeSearchDistCoeffSqr() const
Return the edgeSearchDistCoeffSqr for conformation.
Definition: cvControlsI.H:115
Switch snapFeaturePoints() const
Definition: cvControlsI.H:70
scalar surfacePtExclusionDistanceCoeff() const
Return the surfacePtExclusionDistanceCoeff.
Definition: cvControlsI.H:81
Switch filterFaces() const
Filter faces at output time.
Definition: cvControlsI.H:210
scalar cosInsertionAcceptanceAngle() const
Return the cosInsertionAcceptanceAngle.
Definition: cvControlsI.H:193
Switch timeChecks() const
Return the timeChecks Switch.
Definition: cvControlsI.H:157
const dictionary & foamyHexMeshDict() const
Return the foamyHexMeshDict.
Definition: cvControlsI.H:30
scalar featureEdgeExclusionDistanceCoeff() const
Return the featureEdgeExclusionDistanceCoeff.
Definition: cvControlsI.H:54
scalar maxSurfaceProtrusionCoeff() const
Return the maxSurfaceProtrusionCoeff.
Definition: cvControlsI.H:97
Switch writeTetDualMesh() const
Write tetMesh at output time.
Definition: cvControlsI.H:215
label maxConformationIterations() const
Return the maxConformationIterations.
Definition: cvControlsI.H:127
scalar minimumCellSize() const
Return the minimumCellSize.
Definition: cvControlsI.H:145
scalar cosAlignmentAcceptanceAngle() const
Return the cosAlignmentAcceptanceAngle.
Definition: cvControlsI.H:175
Switch circulateEdges() const
Definition: cvControlsI.H:75
Switch writeBackgroundMeshDecomposition() const
Write backgroundMeshDecomposition at output time.
Definition: cvControlsI.H:225
scalar mixedFeaturePointPPDistanceCoeff() const
Return the mixedFeaturePointPPDistanceCoeff.
Definition: cvControlsI.H:42
scalar maxLoadUnbalance() const
Return the maxLoadUnbalance.
Definition: cvControlsI.H:169
Switch edgeAiming() const
Definition: cvControlsI.H:65
scalar maxQuadAngle() const
Return the maxQuadAngle.
Definition: cvControlsI.H:103
Switch writeCellShapeControlMesh() const
Write cellShapeControlMesh at output time.
Definition: cvControlsI.H:220
scalar faceAreaRatioCoeff() const
Return the faceAreaRatioCoeff.
Definition: cvControlsI.H:187
Switch guardFeaturePoints() const
Definition: cvControlsI.H:60
scalar iterationToInitialHitRatioLimit() const
Return the iterationToInitialHitRatioLimit.
Definition: cvControlsI.H:133
Switch filterEdges() const
Filter edges at output time.
Definition: cvControlsI.H:205
Switch specialiseFeaturePoints() const
Return whether to use specialised feature points.
Definition: cvControlsI.H:86
scalar featurePointExclusionDistanceCoeff() const
Return the featurePointExclusionDistanceCoeff.
Definition: cvControlsI.H:48
scalar surfacePtReplaceDistCoeffSqr() const
Return the surfacePtReplaceDistCoeffSqr for conformation.
Definition: cvControlsI.H:121
scalar pointPairDistanceCoeff() const
Return the pointPairDistanceCoeff.
Definition: cvControlsI.H:36
scalar removalDistCoeff() const
Return removalDistCoeff.
Definition: cvControlsI.H:199
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126