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

Description
    IOContainer with global data (so optionally read from master)

SourceFiles
    GlobalIOList.C

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

#ifndef GlobalIOList_H
#define GlobalIOList_H

#include "regIOobject.H"
#include "List.H"

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

namespace Foam
{

/*---------------------------------------------------------------------------*\
                     Class GlobalIOListBase Declaration
\*---------------------------------------------------------------------------*/

template
<
    template<class> class Container,
    template<class> class IOContainer,
    class Type
>
class GlobalIOListBase
:
    public regIOobject,
    public Container<Type>
{

public:

    // Constructors

        //- Construct from IOobject
        GlobalIOListBase(const IOobject&);

        //- Construct from IOobject and size (does not set values)
        GlobalIOListBase(const IOobject&, const label size);

        //- Construct from IOobject and a Container
        GlobalIOListBase(const IOobject&, const Container<Type>&);

        //- Move construct by transferring the Container contents
        GlobalIOListBase(const IOobject&, Container<Type>&&);

        //- Copy constructor
        GlobalIOListBase(const GlobalIOListBase<Container, IOContainer, Type>&);

        //- Move constructor
        GlobalIOListBase(GlobalIOListBase<Container, IOContainer, Type>&&);


    //- Destructor
    virtual ~GlobalIOListBase();


    // Member Functions

        //- Is object global
        virtual bool global() const
        {
            return true;
        }

        //- ReadData function required for regIOobject read operation
        virtual bool readData(Istream&);

        //- WriteData function required for regIOobject write operation
        virtual bool writeData(Ostream&) const;

    // Member Operators

        //- Inherit assignment operators
        using Container<Type>::operator=;

        //- Assign to another GlobalIOList
        void operator=(const GlobalIOListBase<Container, IOContainer, Type>&);

        //- Move-assign to another GlobalIOList
        void operator=(GlobalIOListBase<Container, IOContainer, Type>&&);
};


/*---------------------------------------------------------------------------*\
                           Class GlobalIOList Declaration
\*---------------------------------------------------------------------------*/

template<class Type>
class GlobalIOList
:
    public GlobalIOListBase<List, GlobalIOList, Type>
{

public:

    //- Runtime type information
    TypeName("List");


    // Constructors

        //- Inherit constructors
        using GlobalIOListBase<List, GlobalIOList, Type>::GlobalIOListBase;


    // Member Operators

        //- Inherit assignment operators
        using GlobalIOListBase<List, GlobalIOList, Type>::operator=;
};


//- Trait for obtaining global status
template<class Type>
struct typeGlobal<GlobalIOList<Type>>
{
    static const bool global = true;
};


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

} // End namespace Foam

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

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

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

#endif

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