cloudSolutionI.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 \*---------------------------------------------------------------------------*/
25 
27 {
28  return mesh_;
29 }
30 
31 
33 {
34  return dict_;
35 }
36 
37 
39 {
40  return active_;
41 }
42 
43 
45 {
46  return dict_.subDict("sourceTerms");
47 }
48 
49 
51 {
52  return dict_.subDict("interpolationSchemes");
53 }
54 
55 
57 {
58  return dict_.subDict("integrationSchemes");
59 }
60 
61 
63 {
64  return transient_;
65 }
66 
67 
69 {
70  return !transient_;
71 }
72 
73 
75 {
76  return calcFrequency_;
77 }
78 
79 
80 inline Foam::scalar Foam::cloudSolution::maxCo() const
81 {
82  return maxCo_;
83 }
84 
85 
87 {
88  return iter_;
89 }
90 
91 
93 {
94  return ++iter_;
95 }
96 
97 
98 inline Foam::scalar Foam::cloudSolution::trackTime() const
99 {
100  return trackTime_;
101 }
102 
103 
105 {
106  return coupled_;
107 }
108 
109 
111 {
112  return coupled_;
113 }
114 
115 
117 {
118  return cellValueSourceCorrection_;
119 }
120 
121 
122 inline Foam::scalar Foam::cloudSolution::maxTrackTime() const
123 {
124  return maxTrackTime_;
125 }
126 
127 
129 {
130  return resetSourcesOnStartup_;
131 }
132 
133 
134 // ************************************************************************* //
label iter() const
Return const access to the current cloud iteration.
const Switch transient() const
Return const access to the transient flag.
const Switch cellValueSourceCorrection() const
Return const access to the cell value correction flag.
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
label calcFrequency() const
Return const access to the calculation frequency.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
const fvMesh & mesh() const
Return reference to the mesh.
const dictionary & interpolationSchemes() const
Interpolation schemes dictionary.
A simple wrapper around bool so that it can be read as a word: true/false, on/off, yes/no, y/n, t/f, or none/any.
Definition: Switch.H:60
scalar maxCo() const
Return const access to the max particle Courant number.
const dictionary & subDict(const word &) const
Find and return a sub-dictionary.
Definition: dictionary.C:934
scalar trackTime() const
Return the particle track time.
scalar maxTrackTime() const
Return const access to the particle track time.
const Switch active() const
Return the active flag.
const Switch coupled() const
Return const access to the coupled flag.
const dictionary & dict() const
Return const access to the dictionary.
const Switch steadyState() const
Return const access to the steady flag.
label nextIter()
Increment and return iter counter.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
const dictionary & integrationSchemes() const
Integration schemes dictionary.
const dictionary & sourceTermDict() const
Source terms dictionary.
const Switch resetSourcesOnStartup() const
Return const access to the reset sources flag.