getRegionOption.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) 2023 OpenCFD Ltd.
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM, distributed under GPL-3.0-or-later.
12 
13 Description
14  Get the value from the -region option
15 
16 Required Classes
17  - Foam::polyMesh
18 
19 Required Variables
20  - args [argList]
21 
22 Provided Variables
23  - regionName [word]
24 
25 \*---------------------------------------------------------------------------*/
26 
27 Foam::word regionName
28 (
29  args.getOrDefault<word>("region", Foam::polyMesh::defaultRegion)
30 );
31 
32 
33 // ************************************************************************* //
Foam::argList::getOrDefault
T getOrDefault(const word &optName, const T &deflt) const
Get a value from the named option if present, or return default.
Definition: argListI.H:300
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:63
Foam::polyMesh::defaultRegion
static word defaultRegion
Return the default region name.
Definition: polyMesh.H:405
regionName
Foam::word regionName(args.getOrDefault< word >("region", Foam::polyMesh::defaultRegion))
args
Foam::argList args(argc, argv)