OpenFOAM
v2312
The open source CFD toolbox
helpBoundary.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) 2012-2016 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::helpBoundary
28
29
Description
30
This class provides help for boundary conditions (patch fields). When no
31
additional arguments are given, the utility outputs all known boundary
32
conditions.
33
34
Usage:
35
\plaintable
36
\c -browse <patch type> | open documentation for patch in browser
37
\c -field <name> | boundary conditions for a given field
38
\c -constraint | list constraint boundary conditions
39
\c -fixedValue | list \c fixedValue type boundary conditions
40
\endplaintable
41
42
Note
43
To use the \c -fixedValue option, the \c -field option should also be used
44
45
See also
46
Foam::helpType
47
Foam::fvPatchField
48
49
SourceFiles
50
helpBoundary.C
51
helpBoundaryTemplates.C
52
53
\*---------------------------------------------------------------------------*/
54
55
#ifndef helpBoundary_H
56
#define helpBoundary_H
57
58
#include "
helpType.H
"
59
#include "
IOobject.H
"
60
61
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
62
63
namespace
Foam
64
{
65
namespace
helpTypes
66
{
67
68
/*---------------------------------------------------------------------------*\
69
Class helpBoundary Declaration
70
\*---------------------------------------------------------------------------*/
71
72
class
helpBoundary
73
:
74
public
helpType
75
{
76
77
protected
:
78
79
// Protected Member Functions
80
81
//- Return/output the available boundary conditions for fields of Type
82
template
<
class
Type>
83
wordList
fieldConditions
(
const
IOobject
&
io
,
const
bool
write
)
const
;
84
85
//- Output the available fixed boundary conditions for fields of Type
86
template
<
class
Type>
87
void
fixedValueFieldConditions
(
const
IOobject
&
io
)
const
;
88
89
90
public
:
91
92
//- Runtime type information
93
TypeName
(
"helpBoundary"
);
94
95
//- Constructor
96
helpBoundary
();
97
98
//- Destructor
99
virtual
~helpBoundary
();
100
101
102
// Member Functions
103
104
//- Initialise - typically setting static variables,
105
// e.g. command line arguments
106
virtual
void
init
();
107
108
//- Execute the help
109
virtual
void
execute
(
const
argList
&
args
,
const
fvMesh
&
mesh
);
110
};
111
112
113
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114
115
}
// End namespace helpTypes
116
}
// End namespace Foam
117
118
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119
120
#ifdef NoRepository
121
#include "
helpBoundaryTemplates.C
"
122
#endif
123
124
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125
126
#endif
127
128
// ************************************************************************* //
Foam::List< word >
Foam::helpTypes::helpBoundary::helpBoundary
helpBoundary()
Constructor.
helpBoundaryTemplates.C
helpType.H
Foam::vtk::write
void write(vtk::formatter &fmt, const Type &val, const label n=1)
Component-wise write of a value (N times)
Definition:
foamVtkOutputTemplates.C:29
mesh
dynamicFvMesh & mesh
Definition:
createDynamicFvMesh.H:6
Foam::argList
Extract command arguments and options from the supplied argc and argv parameters. ...
Definition:
argList.H:118
IOobject.H
Foam::helpTypes::helpBoundary::fixedValueFieldConditions
void fixedValueFieldConditions(const IOobject &io) const
Output the available fixed boundary conditions for fields of Type.
Foam::helpTypes::helpBoundary::execute
virtual void execute(const argList &args, const fvMesh &mesh)
Execute the help.
Foam::helpTypes::helpBoundary::TypeName
TypeName("helpBoundary")
Runtime type information.
Foam::helpTypes::helpBoundary::fieldConditions
wordList fieldConditions(const IOobject &io, const bool write) const
Return/output the available boundary conditions for fields of Type.
Foam::helpTypes::helpBoundary::~helpBoundary
virtual ~helpBoundary()
Destructor.
Foam::helpTypes::helpBoundary::init
virtual void init()
Initialise - typically setting static variables,.
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition:
fvMesh.H:78
io
IOobject io("surfaceFilmProperties", mesh.time().constant(), mesh, IOobject::READ_IF_PRESENT, IOobject::NO_WRITE, IOobject::NO_REGISTER)
args
Foam::argList args(argc, argv)
Foam::IOobject
Defines the attributes of an object for which implicit objectRegistry management is supported...
Definition:
IOobject.H:172
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.C:26
applications
utilities
miscellaneous
foamHelp
helpTypes
helpBoundary
helpBoundary.H
Generated by
1.8.14