KinematicReynoldsNumber.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) 2021-2023 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
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 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
31 
32 template<class CloudType>
34 (
35  const dictionary& dict,
36  CloudType& owner,
37  const word& modelName
38 )
39 :
40  CloudFunctionObject<CloudType>(dict, owner, modelName, typeName)
41 {}
42 
43 
44 template<class CloudType>
46 (
48 )
49 :
51 {}
52 
53 
54 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
55 
56 template<class CloudType>
58 (
59  const typename parcelType::trackingData& td
60 )
61 {
62  auto& c = this->owner();
63 
64  auto* resultPtr = c.template getObjectPtr<IOField<scalar>>("Re");
65 
66  if (!resultPtr)
67  {
68  resultPtr = new IOField<scalar>
69  (
70  IOobject
71  (
72  "Re",
73  c.time().timeName(),
74  c,
75  IOobject::NO_READ,
76  IOobject::NO_WRITE,
77  IOobject::REGISTER
78  )
79  );
80 
81  resultPtr->store();
82  }
83  auto& Re = *resultPtr;
84 
85  Re.resize(c.size());
86 
87  label parceli = 0;
88  for (const parcelType& p : c)
89  {
90  Re[parceli++] = p.Re(td);
91  }
92 
93  const bool haveParticles = c.size();
94  if (c.time().writeTime() && returnReduceOr(haveParticles))
95  {
96  Re.write(haveParticles);
97  }
98 }
99 
100 
101 // ************************************************************************* //
dictionary dict
void resize(const label len)
Adjust allocated size of list.
Definition: ListI.H:160
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition: dictionary.H:129
const dimensionedScalar re
Classical electron radius: default SI units: [m].
virtual void postEvolve(const typename parcelType::trackingData &td)
Post-evolve hook.
A class for handling words, derived from Foam::string.
Definition: word.H:63
Calculates and writes particle Reynolds number field on the cloud. The normalisation factors are calc...
scalarField Re(const UList< complex > &cmplx)
Extract real component.
Definition: complexField.C:207
const dimensionedScalar c
Speed of light in a vacuum.
KinematicReynoldsNumber(const dictionary &dict, CloudType &owner, const word &modelName)
Construct from dictionary.
volScalarField & p
bool returnReduceOr(const bool value, const label comm=UPstream::worldComm)
Perform logical (or) MPI Allreduce on a copy. Uses UPstream::reduceOr.
Defines the attributes of an object for which implicit objectRegistry management is supported...
Definition: IOobject.H:172
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:67
Templated cloud function object base class.
A primitive field of type <T> with automated input and output.