Loading...
Searching...
No Matches
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-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM, distributed under GPL-3.0-or-later.
12
13Description
14 Get the value from the -region option
15
16Required Classes
17 - Foam::polyMesh
18
19Required Variables
20 - args [argList]
21
22Provided Variables
23 - regionName [word]
24
25\*---------------------------------------------------------------------------*/
26
27Foam::word regionName
28(
29 args.getOrDefault<word>("region", Foam::polyMesh::defaultRegion)
30);
31
32
33// ************************************************************************* //
Foam::polyMesh::defaultRegion
static word defaultRegion
Return the default region name.
Definition polyMesh.H:406
Foam::word
A class for handling words, derived from Foam::string.
Definition word.H:66
regionName
Foam::word regionName(args.getOrDefault< word >("region", Foam::polyMesh::defaultRegion))
args
Foam::argList args(argc, argv)