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

Description
    Wrapper for a reference to a dynamic Lagrangian field. It provides
    convenient access consistent with that of the derived fields so that
    expressions involving both kinds of field are readable. It also ensures
    that old-time fields are maintained for a sub-mesh for the duration of the
    inner correction iterations.

See also
    Foam::CloudStateField
    Foam::CloudDerivedField

SourceFiles
    CloudStateFieldRef.C

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

#ifndef CloudStateFieldRef_H
#define CloudStateFieldRef_H

#include "LagrangianModelRef.H"
#include "LagrangianFields.H"

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

namespace Foam
{

/*---------------------------------------------------------------------------*\
                       Class CloudStateFieldRef Declaration
\*---------------------------------------------------------------------------*/

template<class Type>
class CloudStateFieldRef
{
private:

    // Private Data

        //- The field reference
        LagrangianDynamicField<Type>& ref_;

        //- The cached Lagrangian sub-all-field
        mutable autoPtr<LagrangianSubSubField<Type>> psiAllPtr_;

        //- The cached Lagrangian sub-field
        mutable autoPtr<LagrangianSubSubField<Type>> psiSubSubPtr_;

        //- The index of the sub-mesh
        mutable uint64_t psiSubSubMeshIndex_;


public:

    // Constructors

        //- Construct from a field reference
        CloudStateFieldRef(LagrangianDynamicField<Type>&);


    // Member Functions

        //- Access the field's name
        const word& name() const;

        //- Access the field's mesh
        const LagrangianMesh& mesh() const;

        //- Access the field's dimensions
        const dimensionSet& dimensions() const;

        //- Access a part of the field
        const LagrangianSubSubField<Type>& ref(const LagrangianSubMesh&) const;

        //- Access a part of the field
        LagrangianSubSubField<Type>& ref(const LagrangianSubMesh&);


    // Member Operators

        //- Cast to the field
        operator const LagrangianDynamicField<Type>&() const;

        //- Cast to the field
        operator LagrangianDynamicField<Type>&();

        //- Access the entire field
        const LagrangianDynamicField<Type>& operator()
        (
            const LagrangianMesh&
        ) const;

        //- Access a part of the field
        const LagrangianSubSubField<Type>& operator()
        (
            const LagrangianSubMesh& subMesh
        ) const;

        //- Compute and return part of the field associated with a model
        tmp<LagrangianSubSubField<Type>> operator()
        (
            const LagrangianModelRef& model,
            const LagrangianSubMesh& subMesh
        ) const;
};

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

} // End namespace Foam

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

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

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

#endif

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