All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
cv2DControlsI.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) 2013-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 inline Foam::scalar Foam::cv2DControls::minCellSize() const
27 {
28  return minCellSize_;
29 }
30 
31 
32 inline Foam::scalar Foam::cv2DControls::minCellSize2() const
33 {
34  return minCellSize2_;
35 }
36 
37 
38 inline Foam::scalar Foam::cv2DControls::maxQuadAngle() const
39 {
40  return maxQuadAngle_;
41 }
42 
43 
44 inline Foam::scalar Foam::cv2DControls::nearWallAlignedDist() const
45 {
46  return nearWallAlignedDist_;
47 }
48 
49 
50 inline Foam::scalar Foam::cv2DControls::nearWallAlignedDist2() const
51 {
52  return nearWallAlignedDist2_;
53 }
54 
55 
57 {
59 }
60 
61 
63 {
64  return mirrorPoints_;
65 }
66 
67 
69 {
71 }
72 
73 
75 {
76  return objOutput_;
77 }
78 
79 
81 {
82  return meshedSurfaceOutput_;
83 }
84 
85 
87 {
88  return randomiseInitialGrid_;
89 }
90 
91 
92 inline Foam::scalar Foam::cv2DControls::randomPerturbation() const
93 {
94  return randomPerturbation_;
95 }
96 
97 
99 {
101 }
102 
103 
104 inline Foam::scalar Foam::cv2DControls::span() const
105 {
106  return span_;
107 }
108 
109 
110 inline Foam::scalar Foam::cv2DControls::span2() const
111 {
112  return span2_;
113 }
114 
115 
116 inline Foam::scalar Foam::cv2DControls::minEdgeLen() const
117 {
118  return minEdgeLen_;
119 }
120 
121 
122 inline Foam::scalar Foam::cv2DControls::minEdgeLen2() const
123 {
124  return minEdgeLen2_;
125 }
126 
127 
128 inline Foam::scalar Foam::cv2DControls::maxNotchLen() const
129 {
130  return maxNotchLen_;
131 }
132 
133 
134 inline Foam::scalar Foam::cv2DControls::maxNotchLen2() const
135 {
136  return maxNotchLen2_;
137 }
138 
139 
140 inline Foam::scalar Foam::cv2DControls::minNearPointDist() const
141 {
142  return minNearPointDist_;
143 }
144 
145 
146 inline Foam::scalar Foam::cv2DControls::minNearPointDist2() const
147 {
148  return minNearPointDist2_;
149 }
150 
151 
152 inline Foam::scalar Foam::cv2DControls::ppDist() const
153 {
154  return ppDist_;
155 }
156 
157 
158 // ************************************************************************* //
Switch mirrorPoints_
Mirror near-boundary points rather than insert point-pairs.
Definition: cv2DControls.H:92
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 minCellSize_
Minimum cell size below which protrusions through the surface.
Definition: cv2DControls.H:73
Switch insertSurfaceNearPointPairs_
Insert point-pairs vor dual-cell vertices very near the surface.
Definition: cv2DControls.H:95
scalar randomPerturbation_
Definition: cv2DControls.H:103
scalar maxNotchLen() const
Return the maxNotchLen.
scalar maxNotchLen2_
Square of maxNotchLen.
Definition: cv2DControls.H:128
Switch objOutput() const
Return the objOutput Switch.
Definition: cv2DControlsI.H:74
scalar span() const
Return the span.
scalar maxNotchLen2() const
Return the maxNotchLen squared.
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 nearWallAlignedDist2() const
Return square of nearWallAlignedDist.
Definition: cv2DControlsI.H:50
scalar nearWallAlignedDist2_
Square of nearWallAlignedDist.
Definition: cv2DControls.H:86
scalar minNearPointDist2() const
Return the minNearPointDist squared.
scalar nearWallAlignedDist_
Near-wall region where cells are aligned with the wall.
Definition: cv2DControls.H:83
Switch meshedSurfaceOutput() const
Return the meshedSurfaceOutput Switch.
Definition: cv2DControlsI.H:80
Switch insertSurfaceNearestPointPairs_
Insert near-boundary point mirror or point-pairs.
Definition: cv2DControls.H:89
label maxBoundaryConformingIter_
Definition: cv2DControls.H:105
scalar minNearPointDist() const
Return the minNearPointDist.
scalar ppDist_
Distance between boundary conforming point-pairs.
Definition: cv2DControls.H:138
Switch randomiseInitialGrid_
Definition: cv2DControls.H:101
scalar maxQuadAngle_
Maximum quadrant angle allowed at a concave corner before.
Definition: cv2DControls.H:80
scalar ppDist() const
Return the ppDist.
label maxBoundaryConformingIter() const
Return the maximum number of boundary conformation iterations.
Definition: cv2DControlsI.H:98
scalar span2_
Square of span.
Definition: cv2DControls.H:114
scalar minCellSize2() const
Return the square of the minimum cell size.
Definition: cv2DControlsI.H:32
scalar minNearPointDist_
The minimum distance allowed between a dual-cell vertex.
Definition: cv2DControls.H:132
scalar minEdgeLen2_
Square of minEdgeLen.
Definition: cv2DControls.H:121
scalar span_
Maximum cartesian span of the geometry.
Definition: cv2DControls.H:111
scalar maxQuadAngle() const
Return the maximum quadrant angle.
Definition: cv2DControlsI.H:38
scalar minEdgeLen2() const
Return the minEdgeLen squared.
scalar minNearPointDist2_
Square of minNearPoint.
Definition: cv2DControls.H:135
Switch mirrorPoints() const
Return mirrorPoints Switch.
Definition: cv2DControlsI.H:62
scalar minCellSize2_
Square of minCellSize.
Definition: cv2DControls.H:76
Switch insertSurfaceNearPointPairs() const
Return insertSurfaceNearPointPairs Switch.
Definition: cv2DControlsI.H:68
scalar minCellSize() const
Return the minimum cell size.
Definition: cv2DControlsI.H:26
scalar minEdgeLen_
Minimum edge-length of the cell size below which protrusions.
Definition: cv2DControls.H:118
scalar minEdgeLen() const
Return the minEdgeLen.
scalar span2() const
Return the span squared.
Switch insertSurfaceNearestPointPairs() const
Return insertSurfaceNearestPointPairs Switch.
Definition: cv2DControlsI.H:56
Switch randomiseInitialGrid() const
Return the randomise initial point layout Switch.
Definition: cv2DControlsI.H:86
scalar randomPerturbation() const
Return the random perturbation factor.
Definition: cv2DControlsI.H:92
scalar nearWallAlignedDist() const
Return number of layers to align with the nearest wall.
Definition: cv2DControlsI.H:44
Switch meshedSurfaceOutput_
Definition: cv2DControls.H:99
scalar maxNotchLen_
Maximum notch size below which protrusions into the surface are.
Definition: cv2DControls.H:125