cloudSolutionI.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-2015 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
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\*---------------------------------------------------------------------------*/
27
29{
30 return mesh_;
31}
32
33
35{
36 return dict_;
37}
38
39
41{
42 return active_;
43}
44
45
47{
48 return dict_.subDict("sourceTerms");
49}
50
51
53{
54 return dict_.subDict("interpolationSchemes");
55}
56
57
59{
60 return dict_.subDict("integrationSchemes");
61}
62
63
65{
66 return transient_;
67}
68
69
71{
72 return !transient_;
73}
74
75
76inline Foam::label Foam::cloudSolution::calcFrequency() const
77{
78 return calcFrequency_;
79}
80
81
82inline Foam::scalar Foam::cloudSolution::maxCo() const
83{
84 return maxCo_;
85}
86
87
88inline Foam::label Foam::cloudSolution::iter() const
89{
90 return iter_;
91}
92
93
95{
96 return ++iter_;
97}
98
99
100inline Foam::scalar Foam::cloudSolution::trackTime() const
101{
102 return trackTime_;
103}
104
105
106inline Foam::scalar Foam::cloudSolution::deltaTMax() const
107{
108 return deltaTMax_;
109}
110
111
113{
114 return coupled_;
115}
116
117
119{
120 return coupled_;
121}
122
123
125{
126 return cellValueSourceCorrection_;
127}
128
129
130inline Foam::scalar Foam::cloudSolution::maxTrackTime() const
131{
132 return maxTrackTime_;
133}
134
135
137{
138 return resetSourcesOnStartup_;
139}
140
141
142// ************************************************************************* //
A simple wrapper around bool so that it can be read as a word: true/false, on/off,...
Definition: Switch.H:78
scalar maxTrackTime() const
Return const access to the particle track time.
const Switch steadyState() const
Return const access to the steady flag.
const Switch resetSourcesOnStartup() const
Return const access to the reset sources flag.
scalar trackTime() const
Return the particle track time.
label nextIter()
Increment and return iter counter.
scalar maxCo() const
Return const access to the max particle Courant number.
const Switch transient() const
Return const access to the transient flag.
const Switch cellValueSourceCorrection() const
Return const access to the cell value correction flag.
const dictionary & interpolationSchemes() const
Interpolation schemes dictionary.
const dictionary & sourceTermDict() const
Source terms dictionary.
const dictionary & dict() const
Return const access to the dictionary.
const dictionary & integrationSchemes() const
Integration schemes dictionary.
const fvMesh & mesh() const
Return reference to the mesh.
scalar deltaTMax() const
Return the maximum integration time step.
const Switch coupled() const
Return const access to the coupled flag.
label calcFrequency() const
Return const access to the calculation frequency.
const Switch active() const
Return the active flag.
label iter() const
Return const access to the current cloud iteration.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
const dictionary & subDict(const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
Find and return a sub-dictionary.
Definition: dictionary.C:460
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:91