WeberNumberReacting.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) 2020 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 Class
27  Foam::WeberNumberReacting
28 
29 Group
30  grpLagrangianIntermediateFunctionObjects
31 
32 Description
33  Creates particle Weber number field on the cloud
34 
35 SourceFiles
36  WeberNumberReacting.C
37 
38 \*---------------------------------------------------------------------------*/
39 
40 #ifndef WeberNumberReacting_H
41 #define WeberNumberReacting_H
42 
43 #include "CloudFunctionObject.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class WeberNumberReacting Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 template<class CloudType>
56 :
57  public CloudFunctionObject<CloudType>
58 {
59  // Private Data
60 
61  // Typedefs
62 
63  //- Convenience typedef for parcel type
64  typedef typename CloudType::parcelType parcelType;
65 
66 
67 public:
68 
69  //- Runtime type information
70  TypeName("WeberNumber");
71 
72 
73  // Constructors
74 
75  //- Construct from dictionary
77  (
78  const dictionary& dict,
80  const word& modelName
81  );
82 
83  //- Construct copy
85 
86  //- Construct and return a clone
88  {
90  (
92  );
93  }
94 
95 
96  //- Destructor
97  virtual ~WeberNumberReacting() = default;
98 
99 
100  // Member Functions
101 
102  //- Post-evolve hook
103  virtual void postEvolve(const typename parcelType::trackingData& td);
104 };
105 
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 } // End namespace Foam
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 #ifdef NoRepository
114  #include "WeberNumberReacting.C"
115 #endif
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 #endif
120 
121 // ************************************************************************* //
Foam::WeberNumberReacting::clone
virtual autoPtr< CloudFunctionObject< CloudType > > clone() const
Construct and return a clone.
Definition: WeberNumberReacting.H:86
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::WeberNumberReacting::~WeberNumberReacting
virtual ~WeberNumberReacting()=default
Destructor.
WeberNumberReacting.C
Foam::WeberNumberReacting::TypeName
TypeName("WeberNumber")
Runtime type information.
Foam::subModelBase::modelName
const word & modelName() const
Return const access to the name of the sub-model.
Definition: subModelBase.C:107
CloudFunctionObject.H
Foam::subModelBase::dict
const dictionary & dict() const
Return const access to the cloud dictionary.
Definition: subModelBase.C:113
Foam::CloudSubModelBase::owner
const CloudType & owner() const
Return const access to the owner cloud.
Definition: CloudSubModelBase.C:106
Foam::DSMCCloud
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:71
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam::WeberNumberReacting
Creates particle Weber number field on the cloud.
Definition: WeberNumberReacting.H:54
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::WeberNumberReacting::WeberNumberReacting
WeberNumberReacting(const dictionary &dict, CloudType &owner, const word &modelName)
Construct from dictionary.
Definition: WeberNumberReacting.C:35
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
Foam::CloudFunctionObject
Templated cloud function object base class.
Definition: CloudFunctionObject.H:62
Foam::DSMCCloud::parcelType
ParcelType parcelType
Type of parcel the cloud was instantiated for.
Definition: DSMCCloud.H:220
Foam::WeberNumberReacting::postEvolve
virtual void postEvolve(const typename parcelType::trackingData &td)
Post-evolve hook.
Definition: WeberNumberReacting.C:59