NoBreakup.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) 2011-2016 OpenFOAM Foundation
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::NoBreakup
28 
29 Group
30  grpLagrangianIntermediateBreakupSubModels
31 
32 Description
33  Dummy breakup model for 'none'
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef NoBreakup_H
38 #define NoBreakup_H
39 
40 #include "BreakupModel.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 /*---------------------------------------------------------------------------*\
47  Class NoBreakup Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 template<class CloudType>
51 class NoBreakup
52 :
53  public BreakupModel<CloudType>
54 {
55 public:
56 
57  //- Runtime type information
58  TypeName("none");
59 
60 
61  // Constructors
62 
63  //- Construct from dictionary
64  NoBreakup(const dictionary&, CloudType&);
65 
66  //- Construct copy
67  NoBreakup(const NoBreakup<CloudType>& bum);
68 
69  //- Construct and return a clone
70  virtual autoPtr<BreakupModel<CloudType>> clone() const
71  {
73  (
74  new NoBreakup<CloudType>(*this)
75  );
76  }
77 
78 
79  //- Destructor
80  virtual ~NoBreakup();
81 
82 
83  // Member Functions
84 
85  //- Flag to indicate whether model activates break-up model
86  virtual bool active() const;
87 
88  //- Update the parcel properties
89  virtual bool update
90  (
91  const scalar dt,
92  const vector& g,
93  scalar& d,
94  scalar& tc,
95  scalar& ms,
96  scalar& nParticle,
97  scalar& KHindex,
98  scalar& y,
99  scalar& yDot,
100  const scalar d0,
101  const scalar rho,
102  const scalar mu,
103  const scalar sigma,
104  const vector& U,
105  const scalar rhoc,
106  const scalar muc,
107  const vector& Urel,
108  const scalar Urmag,
109  const scalar tMom,
110  scalar& dChild,
111  scalar& massChild
112  );
113 };
114 
115 
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117 
118 } // End namespace Foam
119 
120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121 
122 #ifdef NoRepository
123  #include "NoBreakup.C"
124 #endif
125 
126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127 
128 #endif
129 
130 // ************************************************************************* //
Foam::constant::physicoChemical::mu
const dimensionedScalar mu
Atomic mass unit.
Definition: createFieldRefs.H:4
Urel
Urel
Definition: pEqn.H:56
Foam::NoBreakup
Dummy breakup model for 'none'.
Definition: NoBreakup.H:50
Foam::NoBreakup::clone
virtual autoPtr< BreakupModel< CloudType > > clone() const
Construct and return a clone.
Definition: NoBreakup.H:69
rho
rho
Definition: readInitialConditions.H:88
Foam::NoBreakup::~NoBreakup
virtual ~NoBreakup()
Destructor.
Definition: NoBreakup.C:54
Foam::NoBreakup::active
virtual bool active() const
Flag to indicate whether model activates break-up model.
Definition: NoBreakup.C:61
NoBreakup.C
Foam::NoBreakup::update
virtual bool update(const scalar dt, const vector &g, scalar &d, scalar &tc, scalar &ms, scalar &nParticle, scalar &KHindex, scalar &y, scalar &yDot, const scalar d0, const scalar rho, const scalar mu, const scalar sigma, const vector &U, const scalar rhoc, const scalar muc, const vector &Urel, const scalar Urmag, const scalar tMom, scalar &dChild, scalar &massChild)
Update the parcel properties.
Definition: NoBreakup.C:69
Foam::NoBreakup::TypeName
TypeName("none")
Runtime type information.
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
g
const uniformDimensionedVectorField & g
Definition: createFluidFields.H:26
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::BreakupModel
Templated break-up model class.
Definition: SprayCloud.H:50
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
U
U
Definition: pEqn.H:72
BreakupModel.H
Foam::Vector< scalar >
Foam::NoBreakup::NoBreakup
NoBreakup(const dictionary &, CloudType &)
Construct from dictionary.
Definition: NoBreakup.C:34
sigma
dimensionedScalar sigma("sigma", dimMass/sqr(dimTime), transportProperties)
y
scalar y
Definition: LISASMDCalcMethod1.H:14