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

Description
    Struct for keeping processor, element (cell, face, point) and a piece of
    data. Used for finding minimum values across multiple processes.

SourceFiles
    RemoteDataI.H

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

#ifndef RemoteData_H
#define RemoteData_H

#include "remote.H"

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

namespace Foam
{

// Forward declaration of friend functions and operators
template<class Type>
class RemoteData;
template<class Type>
inline bool operator==(const RemoteData<Type>&, const RemoteData<Type>&);
template<class Type>
inline bool operator!=(const RemoteData<Type>&, const RemoteData<Type>&);
template<class Type>
inline Istream& operator>>(Istream&, RemoteData<Type>&);
template<class Type>
inline Ostream& operator<<(Ostream&, const RemoteData<Type>&);

/*---------------------------------------------------------------------------*\
                          Class RemoteData Declaration
\*---------------------------------------------------------------------------*/

template<class Type>
class RemoteData
:
    public remote
{
public:

    //- Component type
    typedef RemoteData<Type> cmptType;


    // Public Data

        //- Data
        Type data;


    // Constructors

        //- Construct null
        inline RemoteData();

        //- Construct from components
        inline RemoteData(const label, const label, const Type&);

        //- Construct from element index and data. Pstream will be used to
        //  determine the processor index.
        inline RemoteData(const label, const Type&);

        //- Construct from stream
        inline RemoteData(Istream& is);


    // Public Classes

        //- Operator to take the first valid process
        struct firstProcOp
        {
            inline RemoteData<Type> operator()
            (
                const RemoteData<Type>& a,
                const RemoteData<Type>& b
            ) const;
        };

        //- Operator to take the first valid process
        struct firstProcEqOp
        {
            inline void operator()
            (
                RemoteData<Type>& a,
                const RemoteData<Type>& b
            ) const;
        };

        //- Operator to take smallest valid value
        struct smallestEqOp
        {
            inline void operator()
            (
                RemoteData<Type>& a,
                const RemoteData<Type>& b
            ) const;
        };

        //- Operator to take greatest valid value
        struct greatestEqOp
        {
            inline void operator()
            (
                RemoteData<Type>& a,
                const RemoteData<Type>& b
            ) const;
        };

        //- Operator to take smallest first valid value
        struct smallestFirstEqOp
        {
            inline void operator()
            (
                RemoteData<Type>& a,
                const RemoteData<Type>& b
            ) const;
        };

        //- Operator to take greatest first valid value
        struct greatestFirstEqOp
        {
            inline void operator()
            (
                RemoteData<Type>& a,
                const RemoteData<Type>& b
            ) const;
        };


    // Friend Operators

        //- Equality comparison
        friend bool operator== <Type>
        (
            const RemoteData<Type>& a,
            const RemoteData<Type>& b
        );

        //- Inequality comparison
        friend bool operator!= <Type>
        (
            const RemoteData<Type>& a,
            const RemoteData<Type>& b
        );


    // IOstream Operators

        //- Write to stream
        friend Ostream& operator<< <Type>
        (
            Ostream& os,
            const RemoteData<Type>& p
        );

        //- Read from stream
        friend Istream& operator>> <Type>
        (
            Istream& is,
            RemoteData<Type>& p
        );
};


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

} // End namespace Foam

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

#include "RemoteDataI.H"

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

#endif

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