cv2DControlsI.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) 2013-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 inline Foam::scalar Foam::cv2DControls::minCellSize() const
29 {
30  return minCellSize_;
31 }
32 
33 
34 inline Foam::scalar Foam::cv2DControls::minCellSize2() const
35 {
36  return minCellSize2_;
37 }
38 
39 
40 inline Foam::scalar Foam::cv2DControls::maxQuadAngle() const
41 {
42  return maxQuadAngle_;
43 }
44 
45 
46 inline Foam::scalar Foam::cv2DControls::nearWallAlignedDist() const
47 {
48  return nearWallAlignedDist_;
49 }
50 
51 
52 inline Foam::scalar Foam::cv2DControls::nearWallAlignedDist2() const
53 {
54  return nearWallAlignedDist2_;
55 }
56 
57 
59 {
60  return insertSurfaceNearestPointPairs_;
61 }
62 
63 
65 {
66  return mirrorPoints_;
67 }
68 
69 
71 {
72  return insertSurfaceNearPointPairs_;
73 }
74 
75 
77 {
78  return objOutput_;
79 }
80 
81 
83 {
84  return meshedSurfaceOutput_;
85 }
86 
87 
89 {
90  return randomiseInitialGrid_;
91 }
92 
93 
94 inline Foam::scalar Foam::cv2DControls::randomPerturbation() const
95 {
96  return randomPerturbation_;
97 }
98 
99 
101 {
102  return maxBoundaryConformingIter_;
103 }
104 
105 
106 inline Foam::scalar Foam::cv2DControls::span() const
107 {
108  return span_;
109 }
110 
111 
112 inline Foam::scalar Foam::cv2DControls::span2() const
113 {
114  return span2_;
115 }
116 
117 
118 inline Foam::scalar Foam::cv2DControls::minEdgeLen() const
119 {
120  return minEdgeLen_;
121 }
122 
123 
124 inline Foam::scalar Foam::cv2DControls::minEdgeLen2() const
125 {
126  return minEdgeLen2_;
127 }
128 
129 
130 inline Foam::scalar Foam::cv2DControls::maxNotchLen() const
131 {
132  return maxNotchLen_;
133 }
134 
135 
136 inline Foam::scalar Foam::cv2DControls::maxNotchLen2() const
137 {
138  return maxNotchLen2_;
139 }
140 
141 
142 inline Foam::scalar Foam::cv2DControls::minNearPointDist() const
143 {
144  return minNearPointDist_;
145 }
146 
147 
148 inline Foam::scalar Foam::cv2DControls::minNearPointDist2() const
149 {
150  return minNearPointDist2_;
151 }
152 
153 
154 inline Foam::scalar Foam::cv2DControls::ppDist() const
155 {
156  return ppDist_;
157 }
158 
159 
160 // ************************************************************************* //
Foam::cv2DControls::maxNotchLen
scalar maxNotchLen() const
Return the maxNotchLen.
Definition: cv2DControlsI.H:130
Foam::cv2DControls::minEdgeLen
scalar minEdgeLen() const
Return the minEdgeLen.
Definition: cv2DControlsI.H:118
Foam::Switch
A simple wrapper around bool so that it can be read as a word: true/false, on/off,...
Definition: Switch.H:77
Foam::cv2DControls::minCellSize_
scalar minCellSize_
Definition: cv2DControls.H:86
Foam::cv2DControls::nearWallAlignedDist2
scalar nearWallAlignedDist2() const
Return square of nearWallAlignedDist.
Definition: cv2DControlsI.H:52
Foam::cv2DControls::span
scalar span() const
Return the span.
Definition: cv2DControlsI.H:106
Foam::cv2DControls::ppDist
scalar ppDist() const
Return the ppDist.
Definition: cv2DControlsI.H:154
Foam::cv2DControls::maxBoundaryConformingIter
label maxBoundaryConformingIter() const
Return the maximum number of boundary conformation iterations.
Definition: cv2DControlsI.H:100
Foam::cv2DControls::mirrorPoints
Switch mirrorPoints() const
Return mirrorPoints Switch.
Definition: cv2DControlsI.H:64
Foam::cv2DControls::meshedSurfaceOutput
Switch meshedSurfaceOutput() const
Return the meshedSurfaceOutput Switch.
Definition: cv2DControlsI.H:82
Foam::cv2DControls::minNearPointDist
scalar minNearPointDist() const
Return the minNearPointDist.
Definition: cv2DControlsI.H:142
Foam::cv2DControls::insertSurfaceNearPointPairs
Switch insertSurfaceNearPointPairs() const
Return insertSurfaceNearPointPairs Switch.
Definition: cv2DControlsI.H:70
Foam::cv2DControls::span2
scalar span2() const
Return the span squared.
Definition: cv2DControlsI.H:112
Foam::cv2DControls::minCellSize2
scalar minCellSize2() const
Return the square of the minimum cell size.
Definition: cv2DControlsI.H:34
Foam::cv2DControls::maxQuadAngle
scalar maxQuadAngle() const
Return the maximum quadrant angle.
Definition: cv2DControlsI.H:40
Foam::cv2DControls::insertSurfaceNearestPointPairs
Switch insertSurfaceNearestPointPairs() const
Return insertSurfaceNearestPointPairs Switch.
Definition: cv2DControlsI.H:58
Foam::cv2DControls::minNearPointDist2
scalar minNearPointDist2() const
Return the minNearPointDist squared.
Definition: cv2DControlsI.H:148
Foam::cv2DControls::minEdgeLen2
scalar minEdgeLen2() const
Return the minEdgeLen squared.
Definition: cv2DControlsI.H:124
Foam::cv2DControls::nearWallAlignedDist
scalar nearWallAlignedDist() const
Return number of layers to align with the nearest wall.
Definition: cv2DControlsI.H:46
Foam::cv2DControls::objOutput
Switch objOutput() const
Return the objOutput Switch.
Definition: cv2DControlsI.H:76
Foam::cv2DControls::maxNotchLen2
scalar maxNotchLen2() const
Return the maxNotchLen squared.
Definition: cv2DControlsI.H:136
Foam::cv2DControls::randomiseInitialGrid
Switch randomiseInitialGrid() const
Return the randomise initial point layout Switch.
Definition: cv2DControlsI.H:88
Foam::cv2DControls::minCellSize
scalar minCellSize() const
Return the minimum cell size.
Definition: cv2DControlsI.H:28
Foam::cv2DControls::randomPerturbation
scalar randomPerturbation() const
Return the random perturbation factor.
Definition: cv2DControlsI.H:94