File size: 5,818 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
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2025-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/>.

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

#include "flowRateNumberLagrangianScalarFieldSource.H"
#include "addToRunTimeSelectionTable.H"

// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //

Foam::flowRateNumberLagrangianScalarFieldSource::
flowRateNumberLagrangianScalarFieldSource
(
    const regIOobject& iIo,
    const dictionary& dict
)
:
    uniformSizeNumberLagrangianScalarFieldSource(iIo, dict),
    volumetricFlowRate_
    (
        dict.found("volumetricFlowRate")
      ? Function1<scalar>::New
        (
            "volumetricFlowRate",
            time().userUnits(),
            dimensions::volumetricFlux,
            dict
        ).ptr()
      : nullptr
    ),
    massFlowRate_
    (
        dict.found("massFlowRate")
      ? Function1<scalar>::New
        (
            "massFlowRate",
            time().userUnits(),
            dimensions::massFlux,
            dict
        ).ptr()
      : nullptr
    )
{
    if (volumetricFlowRate_.valid() == massFlowRate_.valid())
    {
        FatalIOErrorInFunction(dict)
            << "keywords volumetricFlowRate and massFlowRate both "
            << (volumetricFlowRate_.valid() ? "" : "un") << "defined in "
            << "dictionary " << dict.name()
            << exit(FatalIOError);
    }
}


Foam::flowRateNumberLagrangianScalarFieldSource::
flowRateNumberLagrangianScalarFieldSource
(
    const flowRateNumberLagrangianScalarFieldSource& field,
    const regIOobject& iIo
)
:
    uniformSizeNumberLagrangianScalarFieldSource(field, iIo),
    volumetricFlowRate_(field.volumetricFlowRate_, false),
    massFlowRate_(field.massFlowRate_, false)
{}


// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //

Foam::flowRateNumberLagrangianScalarFieldSource::
~flowRateNumberLagrangianScalarFieldSource()
{}


// * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * * //

Foam::dimensionedScalar Foam::flowRateNumberLagrangianScalarFieldSource::Q
(
    const LagrangianInjection& injection,
    const LagrangianSubMesh& subMesh
) const
{
    // Get the range of the time-step
    const scalar t1 = time().value();
    const scalar t0 = t1 - time().deltaTValue();

    if (volumetricFlowRate_.valid())
    {
        // Evaluate the volumetric flow rate directly
        return
            dimensionedScalar
            (
                dimensions::volumetricFlux,
                volumetricFlowRate_->integral(t0, t1)
            );
    }
    else
    {
        // Calculate the necessary sizes
        tmp<LagrangianSubScalarField> size, v, m;
        calcSizes
        (
            injection, subMesh,
            size,
            true, v,
            true, m
        );

        // Convert the mass flow rate to a volumetric flow rate
        return
            dimensionedScalar
            (
                dimensions::massFlux,
                massFlowRate_->integral(t0, t1)
            )*sum(v/size())/sum(m/size());
    }
}


Foam::tmp<Foam::LagrangianSubScalarField>
Foam::flowRateNumberLagrangianScalarFieldSource::value
(
    const LagrangianInjection& injection,
    const LagrangianSubMesh& subMesh
) const
{
    // Get the range of the time-step
    const scalar t1 = time().value();
    const scalar t0 = t1 - time().deltaTValue();

    // Calculate the necessary sizes
    tmp<LagrangianSubScalarField> size, v, m;
    calcSizes
    (
        injection, subMesh,
        size,
        volumetricFlowRate_.valid(), v,
        massFlowRate_.valid(), m
    );

    // Return the numbers that equalise the sizes on all parcels and recover
    // the specified flow rate
    if (volumetricFlowRate_.valid())
    {
        const dimensionedScalar V
        (
            dimensions::volume,
            volumetricFlowRate_->integral(t0, t1)
        );

        return V/size()/sum(v()/size());
    }
    else
    {
        const dimensionedScalar M
        (
            dimensions::mass,
            massFlowRate_->integral(t0, t1)
        );

        return M/size()/sum(m()/size());
    }
}


void Foam::flowRateNumberLagrangianScalarFieldSource::write(Ostream& os) const
{
    uniformSizeNumberLagrangianScalarFieldSource::write(os);

    if (volumetricFlowRate_.valid())
    {
        writeEntry(os, volumetricFlowRate_());
    }
    else
    {
        writeEntry(os, massFlowRate_());
    }
}


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

namespace Foam
{
    makeLagrangianTypeFieldSource
    (
        LagrangianScalarFieldSource,
        flowRateNumberLagrangianScalarFieldSource
    );
}

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