OpenFOAM
v2406
The open source CFD toolbox
addAllRegionOptions.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) 2021 OpenCFD Ltd.
9
-------------------------------------------------------------------------------
10
License
11
This file is part of OpenFOAM, distributed under GPL-3.0-or-later.
12
13
Description
14
Add multi-region command-line options: -allRegions, -regions, -region
15
16
Required Classes
17
- Foam::argList
18
19
See Also
20
getAllRegionOptions.H
21
22
\*---------------------------------------------------------------------------*/
23
24
{
25
Foam::argList::addBoolOption
26
(
27
"allRegions"
,
28
"Use all regions in regionProperties"
29
);
30
31
Foam::argList::addOption
32
(
33
"regions"
,
34
"wordRes"
,
35
"Use specified mesh region. Eg, -regions gas\n"
36
"Or from regionProperties. Eg, -regions '(gas \"solid.*\")'"
37
);
38
39
Foam::argList::addOption
40
(
41
"region"
,
42
"name"
,
43
"Use specified mesh region. Eg, -region gas"
44
);
45
}
46
47
48
// ************************************************************************* //
Foam::argList::addBoolOption
static void addBoolOption(const word &optName, const string &usage="", bool advanced=false)
Add a bool option to validOptions with usage information.
Definition:
argList.C:374
Foam::argList::addOption
static void addOption(const word &optName, const string ¶m="", const string &usage="", bool advanced=false)
Add an option to validOptions with usage information.
Definition:
argList.C:385
src
OpenFOAM
include
addAllRegionOptions.H
Generated by
1.8.14