coalCloudList.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) 2012-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 \*---------------------------------------------------------------------------*/
25 
26 #ifndef coalCloudList_H
27 #define coalCloudList_H
28 
29 #include "coalCloud.H"
30 #include "volFieldsFwd.H"
31 #include "fvMatricesFwd.H"
32 
33 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
34 
35 namespace Foam
36 {
37 
38 /*---------------------------------------------------------------------------*\
39  Class coalCloudList Declaration
40 \*---------------------------------------------------------------------------*/
41 
43 :
44  public PtrList<coalCloud>
45 {
46 private:
47 
48  //- Reference to the mesh
49  const fvMesh& mesh_;
50 
51 
52 public:
53 
54  // Constructor
55 
57  (
58  const volScalarField& rho,
59  const volVectorField& U,
60  const dimensionedVector& g,
61  const SLGThermo& slgThermo
62  );
63 
64 
65  // Member Functions
66 
67  // Evolution
68 
69  //- Evolve the cloud collection
70  void evolve();
71 
72 
73  // Source terms
74 
75  //- Return const reference to momentum source
77 
78  //- Return tmp momentum source term
79  inline tmp<fvVectorMatrix> SU(volVectorField& U) const;
80 
81  //- Sensible enthalpy transfer [J/kg]
83 
84  //- Return sensible enthalpy source term [J/kg/m3/s]
85  inline tmp<fvScalarMatrix> Sh(volScalarField& hs) const;
86 
87 
88  //- Return mass source term for specie i - specie eqn
90  (
91  const label i,
92  volScalarField& Yi
93  ) const;
94 
95  //- Return total mass transfer [kg/m3]
97 
98  //- Return tmp total mass source for carrier phase
99  // - fully explicit
100  inline tmp<volScalarField::Internal> Srho() const;
101 
102  //- Return tmp total mass source for carrier phase specie i
103  // - fully explicit
105  (
106  const label i
107  ) const;
108 
109  //- Return total mass source term [kg/m3/s]
110  inline tmp<fvScalarMatrix> Srho(volScalarField& rho) const;
111 };
112 
113 
114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 
116 } // End namespace Foam
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 #include "coalCloudListI.H"
121 
122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
123 
124 #endif
125 
126 // ************************************************************************* //
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
tmp< volVectorField::Internal > UTrans() const
Return const reference to momentum source.
tmp< volScalarField::Internal > hsTrans() const
Sensible enthalpy transfer [J/kg].
SLGThermo slgThermo(mesh, thermo)
void evolve()
Evolve the cloud collection.
Definition: coalCloudList.C:83
tmp< volScalarField::Internal > rhoTrans() const
Return total mass transfer [kg/m3].
tmp< fvScalarMatrix > SYi(const label i, volScalarField &Yi) const
Return mass source term for specie i - specie eqn.
Thermo package for (S)olids (L)iquids and (G)ases Takes reference to thermo package, and provides:
Definition: SLGThermo.H:62
tmp< volScalarField::Internal > Srho() const
Return tmp total mass source for carrier phase.
Forward declarations of fvMatrix specializations.
U
Definition: pEqn.H:72
A templated 1D list of pointers to objects of type <T>, where the size of the array is known and used...
Definition: List.H:63
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
tmp< fvVectorMatrix > SU(volVectorField &U) const
Return tmp momentum source term.
coalCloudList(const volScalarField &rho, const volVectorField &U, const dimensionedVector &g, const SLGThermo &slgThermo)
Definition: coalCloudList.C:31
A class for managing temporary objects.
Definition: PtrList.H:53
const dimensionedVector & g
Namespace for OpenFOAM.
tmp< fvScalarMatrix > Sh(volScalarField &hs) const
Return sensible enthalpy source term [J/kg/m3/s].