Loading...
Searching...
No Matches
addAllFaRegionOptions.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) 2025 OpenCFD Ltd.
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM, distributed under GPL-3.0-or-later.
12
13Description
14 Add multi-region command-line options:
15 -allAreas | -all-area-regions
16 -area-regions
17 -area-region
18
19Required Classes
20 - Foam::argList
21
22See Also
23 getAllFaRegionOptions.H
24
25\*---------------------------------------------------------------------------*/
26
27{
28 Foam::argList::addBoolOption
29 (
30 "allAreas",
31 "Use all regions in finite-area regionProperties"
32 );
33 Foam::argList::addOptionCompat("allAreas", { "all-area-regions", 0 });
34
35 Foam::argList::addOption
36 (
37 "area-regions",
38 "wordRes",
39 "Use specified area region. Eg, -area-regions film\n"
40 "Or from regionProperties. Eg, -area-regions '(film \"solid.*\")'"
41 );
42
43 Foam::argList::addOption
44 (
45 "area-region",
46 "name",
47 "Specify area-mesh region. Eg, -area-region shell"
48 );
49
50 // TBD:
51 //? Foam::argList::addOptionCompat("area-region", { "areaRegion", 0 });
52}
53
54
55// ************************************************************************* //
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:389
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:400
Foam::argList::addOptionCompat
static void addOptionCompat(const word &optName, std::pair< const char *, int > compat)
Specify an alias for the option name.
Definition argList.C:433