foamHelp.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 | Copyright (C) 2012 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Application
25  foamHelp
26 
27 Description
28  Top level wrapper utility around foam help utilities
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #include "fvCFD.H"
33 #include "helpType.H"
34 
35 using namespace Foam;
36 
37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
38 
39 int main(int argc, char *argv[])
40 {
41  #include "addRegionOption.H"
42  if (argc < 2)
43  {
45  << "No help utility has been supplied" << nl
46  << exit(FatalError);
47  }
48 
49  const word utilityName = argv[1];
50 
52  (
53  helpType::New(utilityName)
54  );
55 
56  utility().init();
57 
58  #include "setRootCase.H"
59  #include "createTime.H"
60  #include "createNamedMesh.H"
61 
62  utility().execute(args, mesh);
63 
64  Info<< "End\n" << endl;
65 }
66 
67 
68 // ************************************************************************* //
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
error FatalError
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:253
static autoPtr< helpType > New(const word &helpTypeName)
Selector.
dynamicFvMesh & mesh
A class for handling words, derived from string.
Definition: word.H:59
static const char nl
Definition: Ostream.H:262
messageStream Info
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:53
Foam::argList args(argc, argv)
Namespace for OpenFOAM.