NoComposition.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 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 Class
25  Foam::NoComposition
26 
27 Description
28  Dummy class for 'none' option - will raise an error if any functions are
29  called that require return values.
30 
31 SourceFiles
32  NoComposition.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef NoComposition_H
37 #define NoComposition_H
38 
39 #include "CompositionModel.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class NoComposition Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 template<class CloudType>
51 class NoComposition
52 :
53  public CompositionModel<CloudType>
54 {
55 public:
56 
57  //- Runtime type information
58  TypeName("none");
59 
60 
61  // Constructors
62 
63  //- Construct from dictionary
65 
66  //- Construct copy
68 
69  //- Construct and return a clone
71  {
73  (
74  new NoComposition<CloudType>(*this)
75  );
76  }
77 
78 
79  //- Destructor
80  virtual ~NoComposition();
81 
82 
83  // Member Functions
84 
85  // Access
86 
87  // Mixture properties
88 
89  //- Return the list of mixture mass fractions
90  // If only 1 phase, return component fractions of that phase
91  virtual const scalarField& YMixture0() const;
92 
93  // Indices of gas, liquid and solid phases in phase properties
94  // list
95 
96  //- Gas id
97  virtual label idGas() const;
98 
99  //- Liquid id
100  virtual label idLiquid() const;
101 
102  //- Solid id
103  virtual label idSolid() const;
104 };
105 
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 } // End namespace Foam
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 #ifdef NoRepository
114  #include "NoComposition.C"
115 #endif
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 #endif
120 
121 // ************************************************************************* //
virtual ~NoComposition()
Destructor.
Definition: NoComposition.C:54
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
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual const scalarField & YMixture0() const
Return the list of mixture mass fractions.
Definition: NoComposition.C:61
const dictionary & dict() const
Return const access to the cloud dictionary.
Definition: subModelBase.C:110
const CloudType & owner() const
Return const access to the owner cloud.
virtual label idSolid() const
Solid id.
Definition: NoComposition.C:82
virtual autoPtr< CompositionModel< CloudType > > clone() const
Construct and return a clone.
Definition: NoComposition.H:69
Dummy class for &#39;none&#39; option - will raise an error if any functions are called that require return v...
Definition: NoComposition.H:50
virtual label idLiquid() const
Liquid id.
Definition: NoComposition.C:75
TypeName("none")
Runtime type information.
virtual label idGas() const
Gas id.
Definition: NoComposition.C:68
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
Templated reacting parcel composition model class Consists of carrier species (via thermo package)...
Definition: ReactingCloud.H:52
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:69
NoComposition(const dictionary &dict, CloudType &owner)
Construct from dictionary.
Definition: NoComposition.C:32
Namespace for OpenFOAM.