OpenFOAM: API Guide
v2112
The open source CFD toolbox
helpSolver.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) 2015 OpenFOAM Foundation
9
-------------------------------------------------------------------------------
10
License
11
This file is part of OpenFOAM.
12
13
OpenFOAM is free software: you can redistribute it and/or modify it
14
under the terms of the GNU General Public License as published by
15
the Free Software Foundation, either version 3 of the License, or
16
(at your option) any later version.
17
18
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21
for more details.
22
23
You should have received a copy of the GNU General Public License
24
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26
Class
27
Foam::helpSolver
28
29
Description
30
This class provides help for solvers. When no additional arguments
31
are given, the utility outputs all known solvers.
32
33
Usage:
34
\plaintable
35
\c -browse <patch type> | open documentation for object in browser
36
\endplaintable
37
38
SeeAlso
39
Foam::helpType
40
41
SourceFiles
42
helpSolver.C
43
44
\*---------------------------------------------------------------------------*/
45
46
#ifndef helpSolver_H
47
#define helpSolver_H
48
49
#include "
helpType.H
"
50
51
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
52
53
namespace
Foam
54
{
55
namespace
helpTypes
56
{
57
58
/*---------------------------------------------------------------------------*\
59
Class helpSolver Declaration
60
\*---------------------------------------------------------------------------*/
61
62
class
helpSolver
63
:
64
public
helpType
65
{
66
67
public
:
68
69
//- Runtime type information
70
TypeName
(
"helpSolver"
);
71
72
//- Constructor
73
helpSolver
();
74
75
//- Destructor
76
virtual
~helpSolver
();
77
78
79
// Member Functions
80
81
//- Initialise - typically setting static variables,
82
// e.g. command line arguments
83
virtual
void
init
();
84
85
//- Execute the help
86
virtual
void
execute
(
const
argList
&
args
,
const
fvMesh
&
mesh
);
87
};
88
89
90
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91
92
}
// End namespace helpTypes
93
}
// End namespace Foam
94
95
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96
97
#endif
98
99
// ************************************************************************* //
helpSolver
This class provides help for solvers. When no additional arguments are given, the utility outputs all...
Foam::argList
Extract command arguments and options from the supplied argc and argv parameters.
Definition:
argList.H:123
Foam::helpTypes::helpSolver::~helpSolver
virtual ~helpSolver()
Destructor.
Foam::helpTypes::helpSolver::helpSolver
helpSolver()
Constructor.
Foam::helpTypes::helpSolver::execute
virtual void execute(const argList &args, const fvMesh &mesh)
Execute the help.
helpType.H
mesh
dynamicFvMesh & mesh
Definition:
createDynamicFvMesh.H:6
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition:
fvMesh.H:85
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.C:33
Foam::helpTypes::helpSolver
Definition:
helpSolver.H:65
args
Foam::argList args(argc, argv)
Foam::helpTypes::helpSolver::TypeName
TypeName("helpSolver")
Runtime type information.
Foam::helpType
Base class for foam help classes.
Definition:
helpType.H:56
Foam::helpTypes::helpSolver::init
virtual void init()
Initialise - typically setting static variables,.
applications
utilities
miscellaneous
foamHelp
helpTypes
helpSolver
helpSolver.H
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.