steadyStateFaDdtScheme.C
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-2017 Wikki 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
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 
28 #include "steadyStateFaDdtScheme.H"
29 #include "facDiv.H"
30 #include "faMatrices.H"
31 
32 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
33 
34 namespace Foam
35 {
36 
37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
38 
39 namespace fa
40 {
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 template<class Type>
45 tmp<GeometricField<Type, faPatchField, areaMesh>>
46 steadyStateFaDdtScheme<Type>::facDdt
47 (
48  const dimensioned<Type> dt
49 )
50 {
51  return GeometricField<Type, faPatchField, areaMesh>::New
52  (
53  "ddt("+dt.name()+')',
54  IOobject::REGISTER,
55  mesh(),
56  Foam::zero{},
57  dt.dimensions()/dimTime
58  );
59 }
60 
61 
62 template<class Type>
63 tmp<GeometricField<Type, faPatchField, areaMesh>>
64 steadyStateFaDdtScheme<Type>::facDdt0
65 (
66  const dimensioned<Type> dt
67 )
68 {
69  return GeometricField<Type, faPatchField, areaMesh>::New
70  (
71  "ddt("+dt.name()+')',
72  IOobject::REGISTER,
73  mesh(),
74  Foam::zero{},
75  dt.dimensions()/dimTime
76  );
77 }
78 
79 
80 template<class Type>
81 tmp<GeometricField<Type, faPatchField, areaMesh>>
82 steadyStateFaDdtScheme<Type>::facDdt
83 (
84  const GeometricField<Type, faPatchField, areaMesh>& vf
85 )
86 {
87  return GeometricField<Type, faPatchField, areaMesh>::New
88  (
89  "ddt("+vf.name()+')',
90  IOobject::REGISTER,
91  mesh(),
92  Foam::zero{},
93  vf.dimensions()/dimTime
94  );
95 }
96 
97 
98 template<class Type>
99 tmp<GeometricField<Type, faPatchField, areaMesh>>
100 steadyStateFaDdtScheme<Type>::facDdt0
101 (
102  const GeometricField<Type, faPatchField, areaMesh>& vf
103 )
104 {
105  return GeometricField<Type, faPatchField, areaMesh>::New
106  (
107  "ddt0("+vf.name()+')',
108  IOobject::REGISTER,
109  mesh(),
110  Foam::zero{},
111  vf.dimensions()/dimTime
112  );
113 }
114 
115 
116 template<class Type>
117 tmp<GeometricField<Type, faPatchField, areaMesh>>
118 steadyStateFaDdtScheme<Type>::facDdt
119 (
120  const dimensionedScalar& rho,
121  const GeometricField<Type, faPatchField, areaMesh>& vf
122 )
123 {
124  return GeometricField<Type, faPatchField, areaMesh>::New
125  (
126  "ddt("+rho.name()+','+vf.name()+')',
127  IOobject::REGISTER,
128  mesh(),
129  Foam::zero{},
130  rho.dimensions()*vf.dimensions()/dimTime
131  );
132 }
133 
134 template<class Type>
135 tmp<GeometricField<Type, faPatchField, areaMesh>>
136 steadyStateFaDdtScheme<Type>::facDdt0
137 (
138  const dimensionedScalar& rho,
139  const GeometricField<Type, faPatchField, areaMesh>& vf
140 )
141 {
142  return GeometricField<Type, faPatchField, areaMesh>::New
143  (
144  "ddt0("+rho.name()+','+vf.name()+')',
145  IOobject::REGISTER,
146  mesh(),
147  Foam::zero{},
148  rho.dimensions()*vf.dimensions()/dimTime
149  );
150 }
151 
152 
153 template<class Type>
154 tmp<GeometricField<Type, faPatchField, areaMesh>>
155 steadyStateFaDdtScheme<Type>::facDdt
156 (
157  const areaScalarField& rho,
158  const GeometricField<Type, faPatchField, areaMesh>& vf
159 )
160 {
161  return GeometricField<Type, faPatchField, areaMesh>::New
162  (
163  "ddt("+rho.name()+','+vf.name()+')',
164  IOobject::REGISTER,
165  mesh(),
166  Foam::zero{},
167  rho.dimensions()*vf.dimensions()/dimTime
168  );
169 }
170 
171 
172 template<class Type>
173 tmp<GeometricField<Type, faPatchField, areaMesh>>
174 steadyStateFaDdtScheme<Type>::facDdt0
175 (
176  const areaScalarField& rho,
177  const GeometricField<Type, faPatchField, areaMesh>& vf
178 )
179 {
180  return GeometricField<Type, faPatchField, areaMesh>::New
181  (
182  "ddt0("+rho.name()+','+vf.name()+')',
183  IOobject::REGISTER,
184  mesh(),
185  Foam::zero{},
186  rho.dimensions()*vf.dimensions()/dimTime
187  );
188 }
189 
190 template<class Type>
191 tmp<faMatrix<Type>>
192 steadyStateFaDdtScheme<Type>::famDdt
193 (
194  const GeometricField<Type, faPatchField, areaMesh>& vf
195 )
196 {
197  tmp<faMatrix<Type>> tfam
198  (
199  new faMatrix<Type>
200  (
201  vf,
202  vf.dimensions()*dimArea/dimTime
203  )
204  );
205 
206  return tfam;
207 }
208 
209 
210 template<class Type>
211 tmp<faMatrix<Type>>
212 steadyStateFaDdtScheme<Type>::famDdt
213 (
214  const dimensionedScalar& rho,
215  const GeometricField<Type, faPatchField, areaMesh>& vf
216 )
217 {
218  tmp<faMatrix<Type>> tfam
219  (
220  new faMatrix<Type>
221  (
222  vf,
223  rho.dimensions()*vf.dimensions()*dimArea/dimTime
224  )
225  );
226 
227  return tfam;
228 }
229 
230 
231 template<class Type>
232 tmp<faMatrix<Type>>
233 steadyStateFaDdtScheme<Type>::famDdt
234 (
235  const areaScalarField& rho,
236  const GeometricField<Type, faPatchField, areaMesh>& vf
237 )
238 {
239  tmp<faMatrix<Type>> tfam
240  (
241  new faMatrix<Type>
242  (
243  vf,
244  rho.dimensions()*vf.dimensions()*dimArea/dimTime
245  )
246  );
247 
248  return tfam;
249 }
250 
251 
252 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
253 
254 } // End namespace fa
255 
256 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
257 
258 } // End namespace Foam
259 
260 // ************************************************************************* //
Foam::IOobject::name
const word & name() const noexcept
Return the object name.
Definition: IOobjectI.H:195
Foam::GeometricField
Generic GeometricField class.
Definition: pointMVCWeight.H:58
Foam::dimensioned
Generic dimensioned Type class.
Definition: dimensionedScalarFwd.H:33
mesh
dynamicFvMesh & mesh
Definition: createDynamicFvMesh.H:6
Foam::dimensioned::dimensions
const dimensionSet & dimensions() const noexcept
Return const reference to dimensions.
Definition: dimensionedType.H:356
Foam::GeometricField::New
static tmp< GeometricField< Type, PatchField, GeoMesh > > New(const word &name, IOobjectOption::registerOption regOpt, const Mesh &mesh, const dimensionSet &dims, const word &patchFieldType=PatchField< Type >::calculatedType())
Return tmp field (NO_READ, NO_WRITE) from name, mesh, dimensions and patch type. [Takes current timeN...
Definition: GeometricFieldNew.C:77
Foam::fa::steadyStateFaDdtScheme::facDdt0
tmp< GeometricField< Type, faPatchField, areaMesh > > facDdt0(const dimensioned< Type >)
Definition: steadyStateFaDdtScheme.C:58
facDiv.H
Calculate the divergence of the given field.
Foam::dimensioned::name
const word & name() const noexcept
Return const reference to name.
Definition: dimensionedType.H:346
Foam::fa::steadyStateFaDdtScheme::facDdt
tmp< GeometricField< Type, faPatchField, areaMesh > > facDdt(const dimensioned< Type >)
Definition: steadyStateFaDdtScheme.C:40
Foam::faMatrix
A special matrix type and solver, designed for finite area solutions of scalar equations. Face addressing is used to make all matrix assembly and solution loops vectorise.
Definition: faMatricesFwd.H:37
Foam::dimTime
const dimensionSet dimTime(0, 0, 1, 0, 0, 0, 0)
Definition: dimensionSets.H:51
Foam::fa::steadyStateFaDdtScheme::famDdt
tmp< faMatrix< Type > > famDdt(const GeometricField< Type, faPatchField, areaMesh > &)
Definition: steadyStateFaDdtScheme.C:186
Foam::zero
A class representing the concept of 0 (zero) that can be used to avoid manipulating objects known to ...
Definition: zero.H:57
Foam::tmp
A class for managing temporary objects.
Definition: HashPtrTable.H:50
Foam::IOobjectOption::REGISTER
Request registration (bool: true)
Definition: IOobjectOption.H:102
Foam::dimArea
const dimensionSet dimArea(sqr(dimLength))
Definition: dimensionSets.H:57
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:26
Foam::DimensionedField::dimensions
const dimensionSet & dimensions() const noexcept
Return dimensions.
Definition: DimensionedFieldI.H:34