OpenFOAM: API Guide
v2112
The open source CFD toolbox
forceList.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) 2011-2017 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::regionModels::surfaceFilmModels::forceList
28
29
Description
30
List container for film sources
31
32
SourceFiles
33
forceList.C
34
35
\*---------------------------------------------------------------------------*/
36
37
#ifndef forceList_H
38
#define forceList_H
39
40
#include "
PtrList.H
"
41
#include "force.H"
42
43
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44
45
namespace
Foam
46
{
47
namespace
regionModels
48
{
49
namespace
surfaceFilmModels
50
{
51
52
/*---------------------------------------------------------------------------*\
53
Class forceList Declaration
54
\*---------------------------------------------------------------------------*/
55
56
class
forceList
57
:
58
public
PtrList
<force>
59
{
60
public
:
61
62
// Constructors
63
64
//- Construct null
65
forceList
(
surfaceFilmRegionModel
& film);
66
67
//- Construct from type name, dictionary and surface film model
68
forceList
69
(
70
surfaceFilmRegionModel
& film,
71
const
dictionary
&
dict
72
);
73
74
75
//- Destructor
76
virtual
~forceList
();
77
78
79
// Member functions
80
81
//- Return (net) force system
82
tmp<fvVectorMatrix>
correct
(
volVectorField
&
U
);
83
};
84
85
86
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
87
88
}
// End namespace surfaceFilmModels
89
}
// End namespace regionModels
90
}
// End namespace Foam
91
92
93
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94
95
#endif
96
97
// ************************************************************************* //
Foam::tmp
A class for managing temporary objects.
Definition:
PtrList.H:61
Foam::regionModels::surfaceFilmModels::forceList::forceList
forceList(surfaceFilmRegionModel &film)
Construct null.
Definition:
forceList.C:41
Foam::regionModels::surfaceFilmModels::forceList::correct
tmp< fvVectorMatrix > correct(volVectorField &U)
Return (net) force system.
Definition:
forceList.C:80
Foam::regionModels::surfaceFilmModels::surfaceFilmRegionModel
Base class for surface film models.
Definition:
surfaceFilmRegionModel.H:55
Foam::PtrList
A list of pointers to objects of type <T>, with allocation/deallocation management of the pointers....
Definition:
List.H:59
dict
dictionary dict
Definition:
searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition:
dictionary.H:123
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.C:33
U
U
Definition:
pEqn.H:72
Foam::regionModels::surfaceFilmModels::forceList::~forceList
virtual ~forceList()
Destructor.
Definition:
forceList.C:75
PtrList.H
Foam::GeometricField< vector, fvPatchField, volMesh >
Foam::regionModels::surfaceFilmModels::forceList
List container for film sources.
Definition:
forceList.H:55
src
regionModels
surfaceFilmModels
submodels
kinematic
force
forceList
forceList.H
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.