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 See Also
17  getAllRegionOptions.H
18 
19 \*---------------------------------------------------------------------------*/
20 
21 {
22  Foam::argList::addBoolOption
23  (
24  "allRegions",
25  "Use all regions in regionProperties"
26  );
27 
28  Foam::argList::addOption
29  (
30  "regions",
31  "wordRes",
32  "Use specified mesh region. Eg, -regions gas\n"
33  "Or from regionProperties. Eg, -regions '(gas \"solid.*\")'"
34  );
35 
36  Foam::argList::addOption
37  (
38  "region",
39  "name",
40  "Use specified mesh region. Eg, -region gas"
41  );
42 }
43 
44 
45 // ************************************************************************* //
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:324
Foam::argList::addOption
static void addOption(const word &optName, const string &param="", const string &usage="", bool advanced=false)
Add an option to validOptions with usage information.
Definition: argList.C:335