File size: 8,276 Bytes
5a600cf
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2021-2026 OpenFOAM Foundation
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.

    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

Class
    Foam::fv::phaseChange

Description
    Base class for phase change models

SourceFiles
    phaseChange.C

\*---------------------------------------------------------------------------*/

#ifndef phaseChange_H
#define phaseChange_H

#include "hashedWordList.H"
#include "massTransfer.H"
#include "ThermoRefPair.H"

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

namespace Foam
{

class basicThermo;
class fluidThermo;
class multicomponentThermo;
class fluidMulticomponentThermo;

namespace fv
{

/*---------------------------------------------------------------------------*\
                          Class phaseChange Declaration
\*---------------------------------------------------------------------------*/

class phaseChange
:
    public massTransfer
{
private:

    // Private Data

        //- The thermo references
        const ThermoRefPair<basicThermo> thermos_;

        //- Names of the energy fields
        const Pair<word> heNames_;

        //- The names of the transferring species
        hashedWordList species_;

        //- The indices of the transferring species in the two phases, or -1 if
        //  the phase is not multicomponent
        List<labelPair> specieis_;

        //- Whether or not to linearise the energy source
        bool energySemiImplicit_;


    // Private Member Functions

        //- Non-virtual read
        void readCoeffs(const dictionary& dict);


protected:

    // Protected Member Functions

        //- Read the names of the transferring specie
        static wordList readSpecie(const dictionary&, const bool required);

        //- Read the names of the transferring species
        static wordList readSpecies(const dictionary&, const bool required);

        //- Re-read the names of the transferring specie
        void reReadSpecie(const dictionary& dict) const;

        //- Re-read the names of the transferring species
        void reReadSpecies(const dictionary& dict) const;

        //- Set the names of the transferring species
        void setSpecies
        (
            const word& name,
            const word& modelType,
            const wordList& species
        );

        //- Set the names of the transferring species
        void setSpecies(const wordList& species);

        //- Re-set the names of the transferring species
        void reSetSpecies(const wordList& species);

        //- Access the pressure field
        const volScalarField& p() const;

        //- Add a boundary field to the given internal field
        static tmp<volScalarField> vifToVf
        (
            const tmp<DimensionedField<scalar, fvMesh>>& tvif
        );

        //- Remove the boundary field from the given geometric field
        static tmp<DimensionedField<scalar, fvMesh>> vfToVif
        (
            const tmp<volScalarField>& tvf
        );


public:

    //- Runtime type information
    TypeName("phaseChange");


    // Constructors

        //- Construct from explicit source name and mesh
        phaseChange
        (
            const word& name,
            const word& modelType,
            const fvMesh& mesh,
            const dictionary& dict,
            const wordList& species
        );


    // Member Functions

        // Access

            //- Return the thermo references
            inline const ThermoRefPair<basicThermo>& thermos() const;

            //- Return the fluid thermo references
            const ThermoRefPair<fluidThermo>
                fluidThermos(const bool, const bool) const;

            //- Return the multicomponent thermo references
            const ThermoRefPair<multicomponentThermo>
                multicomponentThermos(const bool, const bool) const;

            //- Return the fluid multicomponent thermo references
            const ThermoRefPair<fluidMulticomponentThermo>
                fluidMulticomponentThermos(const bool, const bool) const;

            //- Return the names of the energy fields
            inline const Pair<word>& heNames() const;

            //- Return the names of the transferring species. Empty if neither
            //  thermo is multicomponent.
            inline const hashedWordList& species() const;

            //- Return the indices of the transferring specie in the two
            //  phases, or -1 if the phase is not multicomponent
            const labelPair& specieis(const label mDoti = -1) const;


        // Evaluation

            //- Return the temperature at which the phases are considered to be
            //  changing. By default this is considered to be the temperature
            //  of the "source" phase (i.e., the phase for which mDot is
            //  negative), but this can be overridden to account for heat
            //  transfer modelling or similar.
            virtual tmp<DimensionedField<scalar, fvMesh>> Tchange() const;

            //- Return the fraction of the latent heat that is transferred into
            //  the second phase. By default this is weighted by the phase
            //  thermal conductivities, but this can be overridden to account
            //  for heat transfer modelling or similar.
            virtual tmp<DimensionedField<scalar, fvMesh>> Lfraction() const;

            //- Return the latent heat
            tmp<DimensionedField<scalar, fvMesh>> L
            (
                const label mDoti = -1
            ) const;

            //- Return the latent heat for a given changing temperature
            tmp<DimensionedField<scalar, fvMesh>> L
            (
                const volInternalScalarField& Tchange,
                const label mDoti = -1
            ) const;

            //- Return the latent heat for a patch and a given changing
            //  temperature
            tmp<scalarField> L
            (
                const label patchi,
                const scalarField& Tchange,
                const label mDoti = -1
            ) const;


        // Sources

            //- Return the total phase change rate
            virtual tmp<DimensionedField<scalar, fvMesh>> mDot() const;

            //- Return the mass transfer rate of a specie
            virtual tmp<DimensionedField<scalar, fvMesh>> mDot
            (
                const label mDoti
            ) const;

            //- Override the energy equation to add the phase change heat, or
            //  the species equations to add the relevant mass sources
            void addSup
            (
                const volScalarField& alpha,
                const volScalarField& rho,
                const volScalarField& heOrYi,
                fvMatrix<scalar>& eqn
            ) const;


        //- Read source dictionary
        virtual bool read(const dictionary& dict);
};


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

} // End namespace fv
} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#include "phaseChangeI.H"

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif

// ************************************************************************* //