File size: 4,537 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
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  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/>.

Class
    Foam::CloudAverageField

Description
    A cloud field that is averaged and then interpolated back to the cloud. Uses
    CloudDerivedField to provide flexible access and caching.

See also
    Foam::CloudDerivedField

SourceFiles
    CloudAverageField.C

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

#ifndef CloudAverageField_H
#define CloudAverageField_H

#include "CloudStateField.H"
#include "CloudDerivedField.H"
#include "LagrangianAverage.H"

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

namespace Foam
{

class fvMesh;

/*---------------------------------------------------------------------------*\
                        Class CloudAverageField Declaration
\*---------------------------------------------------------------------------*/

template<class Type>
class CloudAverageField
:
    public CloudDerivedField<Type>
{
    // Private Data

        //- The cell weight sum
        const tmp<DimensionedField<scalar, fvMesh>> tcellWeightSum_;

        //- Reference to the weight state field
        const CloudStateField<scalar>& weightState_;

        //- Reference to the weight derived field
        const CloudDerivedField<scalar>& weightDerived_;

        //- Reference to the state field
        const CloudStateField<Type>& weightPsiOrPsiState_;

        //- Reference to the derived field
        const CloudDerivedField<Type>& weightPsiOrPsiDerived_;

        //- Averaging engine
        mutable autoPtr<LagrangianAverage<Type>> psiAveragePtr_;

        //- Current state of the average
        mutable enum class psiAverageState
        {
            removed,
            complete,
            cached
        } psiAverageState_;


    // Private Member Functions

        //- Run an operation on the averaging engine
        template<class MethodWeightSum, class MethodNoWeightSum, class ... Args>
        void op
        (
            MethodWeightSum,
            MethodNoWeightSum,
            const LagrangianSubMesh&,
            const Args& ... args
        ) const;

        //- Interpolate and return the result
        tmp<LagrangianSubField<Type>> interpolate
        (
            const LagrangianModelRef&,
            const LagrangianSubMesh&
        ) const;


public:

    // Constructors

        //- Construct from a name, a cell weight sum and a derived field
        CloudAverageField
        (
            const word& name,
            const DimensionedField<scalar, fvMesh>& cellWeightSum,
            const CloudDerivedField<Type>& weightPsi
        );


    // Member Functions

        //- Remove this sub-mesh from the average
        void remove(const LagrangianSubMesh& subMesh);

        //- Add this sub-mesh to the average
        void add(const LagrangianSubMesh& subMesh, const bool cache);

        //- Correct the average with values from the sub-mesh
        void correct(const LagrangianSubMesh& subMesh, const bool cache);

        //- Reset
        void reset();
};

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

} // End namespace Foam

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

#ifdef NoRepository
    #include "CloudAverageField.C"
#endif

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

#endif

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