fileOperationInitialise.C
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) 2017-2018 OpenFOAM Foundation
9  Copyright (C) 2019-2022 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 \*---------------------------------------------------------------------------*/
28 
30 #include "OSspecific.H"
32 
33 /* * * * * * * * * * * * * * * Static Member Data * * * * * * * * * * * * * */
34 
35 namespace Foam
36 {
37 namespace fileOperations
38 {
39  defineTypeNameAndDebug(fileOperationInitialise, 0);
40  defineRunTimeSelectionTable(fileOperationInitialise, word);
41 }
42 }
43 
44 
45 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
46 
48 (
49  int& argc,
50  char**& argv
51 )
52 {
53  // Check for -ioRanks: requires an argument
54  int index = -1;
55  for (int argi = 1; argi < argc; ++argi)
56  {
57  const char *optName = argv[argi];
58 
59  if (optName[0] == '-')
60  {
61  ++optName; // Looks like an option, skip leading '-'
62  bool emitErrorMessage = false;
63 
64  if (strcmp(optName, "ioRanks") == 0)
65  {
66  // Requires a parameter
67  if (argi < argc-1)
68  {
69  index = argi;
70  ++argi;
71  Foam::setEnv("FOAM_IORANKS", argv[argi], true);
72  break;
73  }
74  else
75  {
76  emitErrorMessage = true;
77  }
78  }
79 
80  if (emitErrorMessage)
81  {
82  // Missing argument: emit message but not exit or
83  // FatalError since Pstream etc are not yet initialised
84 
85  Info<< nl
86  << "Error: option '-" << optName
87  << "' requires an argument" << nl << nl;
88 
89  //NO: UPstream::exit(1); // works for serial and parallel
90  }
91  }
92  }
93 
94  if (index > 0)
95  {
96  for (int i=index+2; i<argc; i++)
97  {
98  argv[i-2] = argv[i];
99  }
100  argc -= 2;
101  }
102 }
103 
104 
107 (
108  const word& type,
109  int& argc,
110  char**& argv
111 )
112 {
113  DebugInFunction << "Constructing fileOperationInitialise" << endl;
114 
115  auto* ctorPtr = wordConstructorTable(type);
116 
117  if (!ctorPtr)
118  {
120  (
121  "fileOperationInitialise",
122  type,
123  *wordConstructorTablePtr_
124  ) << abort(FatalError);
125  }
126 
127  return autoPtr<fileOperationInitialise>(ctorPtr(argc, argv));
128 }
129 
130 
131 // ************************************************************************* //
error FatalError
Error stream (stdout output on all processes), with additional &#39;FOAM FATAL ERROR&#39; header text and sta...
constexpr char nl
The newline &#39;\n&#39; character (0x0a)
Definition: Ostream.H:50
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:531
#define FatalErrorInLookup(lookupTag, lookupName, lookupTable)
Report an error message using Foam::FatalError.
Definition: error.H:605
Macros for easy insertion into run-time selection tables.
static autoPtr< fileOperationInitialise > New(const word &type, int &argc, char **&argv)
Select initialisation type.
Functions used by OpenFOAM that are specific to POSIX compliant operating systems and need to be repl...
fileName::Type type(const fileName &name, const bool followLink=true)
Return the file type: DIRECTORY or FILE, normally following symbolic links.
Definition: POSIX.C:799
A class for handling words, derived from Foam::string.
Definition: word.H:63
#define DebugInFunction
Report an information message using Foam::Info.
errorManip< error > abort(error &err)
Definition: errorManip.H:139
fileOperationInitialise(int &argc, char **&argv)
Construct from components.
defineRunTimeSelectionTable(fileOperationInitialise, word)
messageStream Info
Information stream (stdout output on master, null elsewhere)
Pointer management similar to std::unique_ptr, with some additional methods and type checking...
Definition: HashPtrTable.H:48
defineTypeNameAndDebug(collatedFileOperation, 0)
bool setEnv(const word &name, const std::string &value, const bool overwrite)
Set an environment variable, return true on success.
Definition: POSIX.C:356
Namespace for OpenFOAM.