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 | Copyright (C) 2011-2015 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 
104 inline Foam::scalar Foam::cloudSolution::deltaTMax() const
105 {
106  return deltaTMax_;
107 }
108 
109 
111 {
112  return coupled_;
113 }
114 
115 
116 inline const Foam::Switch Foam::cloudSolution::coupled() const
117 {
118  return coupled_;
119 }
120 
121 
123 {
124  return cellValueSourceCorrection_;
125 }
126 
127 
128 inline Foam::scalar Foam::cloudSolution::maxTrackTime() const
129 {
130  return maxTrackTime_;
131 }
132 
133 
135 {
136  return resetSourcesOnStartup_;
137 }
138 
139 
140 // ************************************************************************* //
Foam::cloudSolution::maxTrackTime
scalar maxTrackTime() const
Return const access to the particle track time.
Definition: cloudSolutionI.H:128
Foam::cloudSolution::active
const Switch active() const
Return the active flag.
Definition: cloudSolutionI.H:38
Foam::Switch
A simple wrapper around bool so that it can be read as a word: true/false, on/off,...
Definition: Switch.H:60
Foam::cloudSolution::deltaTMax
scalar deltaTMax() const
Return the maximum integation time step.
Definition: cloudSolutionI.H:104
Foam::cloudSolution::nextIter
label nextIter()
Increment and return iter counter.
Definition: cloudSolutionI.H:92
Foam::cloudSolution::resetSourcesOnStartup
const Switch resetSourcesOnStartup() const
Return const access to the reset sources flag.
Definition: cloudSolutionI.H:134
Foam::cloudSolution::trackTime
scalar trackTime() const
Return the particle track time.
Definition: cloudSolutionI.H:98
Foam::cloudSolution::coupled
const Switch coupled() const
Return const access to the coupled flag.
Definition: cloudSolutionI.H:110
Foam::cloudSolution::sourceTermDict
const dictionary & sourceTermDict() const
Source terms dictionary.
Definition: cloudSolutionI.H:44
Foam::cloudSolution::integrationSchemes
const dictionary & integrationSchemes() const
Integration schemes dictionary.
Definition: cloudSolutionI.H:56
Foam::cloudSolution::maxCo
scalar maxCo() const
Return const access to the max particle Courant number.
Definition: cloudSolutionI.H:80
Foam::cloudSolution::cellValueSourceCorrection
const Switch cellValueSourceCorrection() const
Return const access to the cell value correction flag.
Definition: cloudSolutionI.H:122
Foam::cloudSolution::transient
const Switch transient() const
Return const access to the transient flag.
Definition: cloudSolutionI.H:62
Foam::label
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
Foam::cloudSolution::dict
const dictionary & dict() const
Return const access to the dictionary.
Definition: cloudSolutionI.H:32
Foam::dictionary
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:137
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
Foam::cloudSolution::mesh
const fvMesh & mesh() const
Return reference to the mesh.
Definition: cloudSolutionI.H:26
Foam::cloudSolution::calcFrequency
label calcFrequency() const
Return const access to the calculation frequency.
Definition: cloudSolutionI.H:74
Foam::cloudSolution::iter
label iter() const
Return const access to the current cloud iteration.
Definition: cloudSolutionI.H:86
Foam::cloudSolution::mesh_
const fvMesh & mesh_
Reference to the mesh.
Definition: cloudSolution.H:56
Foam::dictionary::subDict
const dictionary & subDict(const word &) const
Find and return a sub-dictionary.
Definition: dictionary.C:631
Foam::cloudSolution::interpolationSchemes
const dictionary & interpolationSchemes() const
Interpolation schemes dictionary.
Definition: cloudSolutionI.H:50
Foam::cloudSolution::steadyState
const Switch steadyState() const
Return const access to the steady flag.
Definition: cloudSolutionI.H:68