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

Description
    Struct for keeping processor, element (cell, face, point) index.

SourceFiles
    remoteI.H

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

#ifndef remote_H
#define remote_H

#include "Istream.H"
#include "Ostream.H"

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

namespace Foam
{

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

/*---------------------------------------------------------------------------*\
                          Class remote Declaration
\*---------------------------------------------------------------------------*/

class remote
{
public:

    //- Component type
    typedef remote cmptType;


    // Public Data

        //- Processor index
        label proci;

        //- Element index
        label elementi;


    // Constructors

        //- Construct null
        inline remote();

        //- Construct from components
        inline remote(const label, const label);

        //- Construct from element index. Pstream will be used to determine the
        //  processor index.
        inline remote(const label);

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


    // Public Classes

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

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


    // Friend Operators

        //- Equality comparison
        friend bool operator==(const remote& a, const remote& b);

        //- Inequality comparison
        friend bool operator!=(const remote& a, const remote& b);


    // IOstream Operators

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

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


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

} // End namespace Foam

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

#include "remoteI.H"

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

#endif

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