The open source CFD toolbox
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) 2016 OpenCFD Ltd.
9-------------------------------------------------------------------------------
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
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
29
30// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
31
33:
34 keepFluid_(true),
35 keepPorous_(true),
36 keepSolid_(true),
37 mergeInterfaces_(false),
38 renameInterfaces_(true),
39 removeBaffles_(false),
40 useNumberedNames_(false),
41 mergeTol_(0.05e-3),
42 undefScalar_(NAN)
43{}
44
45
46// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
47
49{
50 return keepFluid_;
51}
52
53
55{
56 return keepPorous_;
57}
58
59
61{
62 return keepSolid_;
63}
64
65
67{
68 return keepFluid_ || keepPorous_ || !keepSolid_;
69}
70
71
73{
74 return mergeInterfaces_;
75}
76
77
79{
80 return renameInterfaces_;
81}
82
83
85{
86 return removeBaffles_;
87}
88
89
91{
92 return useNumberedNames_;
93}
94
95
97{
98 return mergeTol_;
99}
100
101
103{
104 return undefScalar_;
105}
106
107
108
110{
111 keepFluid_ = b;
112}
113
114
116{
117 keepPorous_ = b;
118}
119
120
122{
123 keepSolid_ = b;
124}
125
126
128{
129 mergeInterfaces_ = b;
130}
131
132
134{
135 renameInterfaces_ = b;
136}
137
138
140{
141 removeBaffles_ = b;
142}
143
144
146{
147 useNumberedNames_ = b;
148}
149
150
152{
153 mergeTol_ = val;
154}
155
156
158{
159 undefScalar_ = val;
160}
161
162
163// ************************************************************************* //
bool keepFluid() const
Keep fluid regions (default true)
bool mergeInterfaces() const
Merge in-place interfaces (default true)
bool useNumberedNames() const
bool removeBaffles() const
Remove baffles by merging their respective faces (default false)
bool keptSomeRegion() const
Some region (fluid, porous, solid) is kept.
bool keepSolid() const
Keep solid regions (default true)
scalar undefScalar() const
Value to assign for undefined solutions (default: NaN)
bool renameInterfaces() const
Rename interface boundaries as InterfaceN_0, InterfaceN_1.
bool keepPorous() const
Keep porous regions (default true)
scalar mergeTol() const
Merge tolerance for points (default 0.05e-3)
options()
Construct with the defaults.
volScalarField & b
Definition: createFields.H:27