OpenFOAM
v2312
The open source CFD toolbox
lagrangianIntermediateDoc.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) 2016 OpenCFD Ltd.
9
-------------------------------------------------------------------------------
10
License
11
This file is part of OpenFOAM.
12
13
OpenFOAM is free software: you can redistribute it and/or modify it under
14
the terms of the GNU General Public License as published by the Free
15
Software Foundation, either version 3 of the License, or (at your option)
16
any later version.
17
18
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT ANY
19
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
20
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
21
details.
22
23
You should have received a copy of the GNU General Public License along with
24
OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
27
28
\defgroup grpLagrangianIntermediate Lagrangian particle models
29
@{
30
This group contains Lagrangian modelling available in the 'intermediate' library
31
@}
32
33
\defgroup grpLagrangianIntermediateClouds Clouds
34
@{
35
\ingroup grpLagrangianIntermediate
36
This group contains Lagrangian clouds
37
@}
38
39
\defgroup grpLagrangianIntermediateParcels Parcels
40
@{
41
\ingroup grpLagrangianIntermediate
42
This group contains Lagrangian parcels
43
@}
44
45
// Submodels
46
\defgroup grpLagrangianIntermediateSubModels Submodels
47
@{
48
\ingroup grpLagrangianIntermediate
49
This group contains Lagrangian parcel submodels
50
@}
51
52
\defgroup grpLagrangianIntermediateKinematicSubModels Kinematic
53
@{
54
\ingroup grpLagrangianIntermediateSubModels
55
This group contains Lagrangian kinematic parcel submodels
56
@}
57
58
\defgroup grpLagrangianIntermediateThermoSubModels Thermodynamic
59
@{
60
\ingroup grpLagrangianIntermediateSubModels
61
This group contains Lagrangian thermo parcel submodels
62
@}
63
64
\defgroup grpLagrangianIntermediateReactingSubModels Reacting
65
@{
66
\ingroup grpLagrangianIntermediateSubModels
67
This group contains Lagrangian reacting parcel submodels
68
@}
69
70
\defgroup grpLagrangianIntermediateReactingMultiphaseSubModels Reacting multiphase
71
@{
72
\ingroup grpLagrangianIntermediateSubModels
73
This group contains Lagrangian reacting multiphase parcel submodels
74
@}
75
76
\defgroup grpLagrangianIntermediateMPPICSubModels MP-PIC
77
@{
78
\ingroup grpLagrangianIntermediateSubModels
79
This group contains Lagrangian MP-PIC parcel submodels
80
@}
81
82
83
// Kinematic parcel sub models
84
\defgroup grpLagrangianIntermediateCollisionSubModels Collision
85
@{
86
\ingroup grpLagrangianIntermediateKinematicSubModels
87
This group contains Lagrangian particle collision submodes
88
@}
89
90
\defgroup grpLagrangianIntermediateDispersionSubModels Dispersion
91
@{
92
\ingroup grpLagrangianIntermediateKinematicSubModels
93
This group contains Lagrangian particle dispersion submodes
94
@}
95
96
\defgroup grpLagrangianIntermediateInjectionSubModels Injection
97
@{
98
\ingroup grpLagrangianIntermediateKinematicSubModels
99
This group contains Lagrangian particle injection submodes
100
@}
101
102
\defgroup grpLagrangianIntermediateForceSubModels Forces
103
@{
104
\ingroup grpLagrangianIntermediateKinematicSubModels
105
This group contains Lagrangian particle force submodels
106
@}
107
108
\defgroup grpLagrangianIntermediatePatchInteractionSubModels Patch interaction
109
@{
110
\ingroup grpLagrangianIntermediateKinematicSubModels
111
This group contains Lagrangian particle patch interaction submodels
112
@}
113
114
\defgroup grpLagrangianIntermediateSurfaceFilmSubModels Surface film
115
@{
116
\ingroup grpLagrangianIntermediateKinematicSubModels
117
This group contains Lagrangian particle patch interaction submodels
118
@}
119
120
121
// Thermo parcel submodels
122
\defgroup grpLagrangianIntermediateHeatTransferSubModels Heat transfer
123
@{
124
\ingroup grpLagrangianIntermediateThermoSubModels
125
This group contains Lagrangian particle heat transfer submodels
126
@}
127
128
129
// Reacting parcel submodels
130
\defgroup grpLagrangianIntermediateCompositionSubModels Composition
131
@{
132
\ingroup grpLagrangianIntermediateReactingSubModels
133
This group contains Lagrangian particle composition submodels
134
@}
135
136
\defgroup grpLagrangianIntermediatePhaseChangeSubModels Phase change
137
@{
138
\ingroup grpLagrangianIntermediateReactingSubModels
139
This group contains Lagrangian particle phase change submodels
140
@}
141
142
// Spray parcel submodels (Spray derived from Reacting)
143
\defgroup grpLagrangianIntermediateAtomizationSubModels Atomization
144
@{
145
\ingroup grpLagrangianIntermediateReactingSubModels
146
This group contains Lagrangian particle atomization submodels
147
@}
148
149
\defgroup grpLagrangianIntermediateBreakupSubModels Breakup
150
@{
151
\ingroup grpLagrangianIntermediateReactingSubModels
152
This group contains Lagrangian particle breakup submodels
153
@}
154
155
156
// Reacting multiphase parcel submodels
157
\defgroup grpLagrangianIntermediateDevolatilisationSubModels Devolatilisation
158
@{
159
\ingroup grpLagrangianIntermediateReactingMultiphaseSubModels
160
This group contains Lagrangian particle devolatilisation submodels
161
@}
162
163
\defgroup grpLagrangianIntermediateSurfaceReactionSubModels Surface reaction
164
@{
165
\ingroup grpLagrangianIntermediateReactingMultiphaseSubModels
166
This group contains Lagrangian particle surface reaction submodels
167
@}
168
169
170
// MP-PIC parcel submodels
171
\defgroup grpLagrangianIntermediateMPPICAveragingMethods Averaging
172
@{
173
\ingroup grpLagrangianIntermediateMPPICSubModels
174
This group contains Lagrangian MP-PIC particle averaging methods
175
@}
176
177
\defgroup grpLagrangianIntermediateMPPICCorrectionLimitingMethods Correction limiting
178
@{
179
\ingroup grpLagrangianIntermediateMPPICSubModels
180
This group contains Lagrangian MP-PIC particle correction limiting methods
181
@}
182
183
\defgroup grpLagrangianIntermediateMPPICDampingSubModels Damping
184
@{
185
\ingroup grpLagrangianIntermediateMPPICSubModels
186
This group contains Lagrangian MP-PIC particle damping submodels
187
@}
188
189
\defgroup grpLagrangianIntermediateMPPICIsotropySubModels Isotropy
190
@{
191
\ingroup grpLagrangianIntermediateMPPICSubModels
192
This group contains Lagrangian MP-PIC particle isotropy submodels
193
@}
194
195
\defgroup grpLagrangianIntermediateMPPICPackingSubModels Packing
196
@{
197
\ingroup grpLagrangianIntermediateMPPICSubModels
198
This group contains Lagrangian MP-PIC particle packing submodels
199
@}
200
201
\defgroup grpLagrangianIntermediateMPPICParticleStressSubModels Particle stress
202
@{
203
\ingroup grpLagrangianIntermediateMPPICSubModels
204
This group contains Lagrangian MP-PIC particle stress submodels
205
@}
206
207
\defgroup grpLagrangianIntermediateMPPICTimeScaleSubModels Time scale
208
@{
209
\ingroup grpLagrangianIntermediateMPPICSubModels
210
This group contains Lagrangian MP-PIC particle time scale submodels
211
@}
212
213
214
// Function objects
215
\defgroup grpLagrangianIntermediateFunctionObjects Function objects
216
@{
217
\ingroup grpLagrangianIntermediateSubModels
218
This group contains Lagrangian function objects
219
@}
220
221
222
\*---------------------------------------------------------------------------*/
src
lagrangian
intermediate
doc
lagrangianIntermediateDoc.H
Generated by
1.8.14