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

Description
    Class to maintain a field of the CPU load per cell.

    The optionalCpuLoad is a base-class for cpuLoad to simplify the
    implementation of optional CPU time caching.  This is achieved via the
    optionalCpuLoad::New function which returns a optionalCpuLoad with dummy
    functions if loadBalancing is false otherwise it creates or looks-up and
    returns a cpuLoad with the given name.

    Used for loadBalancing.

SourceFiles
    cpuLoad.C

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

#ifndef cpuLoad_H
#define cpuLoad_H

#include "cpuTime.H"
#include "scalarField.H"
#include "polyMesh.H"
#include "DemandDrivenMeshObject.H"

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

namespace Foam
{

/*---------------------------------------------------------------------------*\
                       Class optionalCpuLoad Declaration
\*---------------------------------------------------------------------------*/

class optionalCpuLoad
{
    // Private Data

        //- Dummy optionalCpuLoad
        //  returned by optionalCpuLoad::New if loadBalancing = false
        static optionalCpuLoad optionalCpuLoad_;


public:

    // Constructors

        //- Construct from mesh, name and switch
        optionalCpuLoad()
        {}

        //- Disallow default bitwise copy construction
        optionalCpuLoad(const optionalCpuLoad&) = delete;


    // Selectors


        //- Construct from polyMesh if loadBalancing is true
        //  otherwise return the dummy optionalCpuLoad
        static optionalCpuLoad& New
        (
            const word& name,
            const polyMesh& mesh,
            const bool loadBalancing
        );


    //- Destructor
    virtual ~optionalCpuLoad()
    {}


    // Member Functions

        //- Reset the CPU time (dummy)
        virtual void resetCpuTime()
        {}

        //- Cache the CPU time increment for celli (dummy)
        virtual void cpuTimeIncrement(const label celli)
        {}

        //- Reset the CPU load field (dummy)
        virtual void reset()
        {}


    // Member Operators

        //- Disallow default bitwise assignment
        void operator=(const optionalCpuLoad&) = delete;
};


/*---------------------------------------------------------------------------*\
                          Class cpuLoad Declaration
\*---------------------------------------------------------------------------*/

class cpuLoad
:
    public optionalCpuLoad,
    public DemandDrivenMeshObject<polyMesh, TopoChangeableMeshObject, cpuLoad>,
    public scalarField
{
    // Private Data

        cpuTime cpuTime_;


public:

    // Declare name of the class and its debug switch
    TypeName("cpuLoad");


    // Constructors

        //- Construct from mesh, name and switch
        cpuLoad
        (
            const word& name,
            const polyMesh& mesh
        );

        //- Disallow default bitwise copy construction
        cpuLoad(const cpuLoad&) = delete;


    //- Destructor
    virtual ~cpuLoad();


    // Member Functions

        //- Reset the CPU time
        virtual void resetCpuTime();

        //- Cache the CPU time increment for celli
        virtual void cpuTimeIncrement(const label celli);

        //- Reset the CPU load field
        virtual void reset();


        //- Update for mesh motion
        virtual bool movePoints();

        //- Redistribute or update using the given distribution map
        virtual void distribute(const polyDistributionMap& map);

        //- Update topology using the given map
        virtual void topoChange(const polyTopoChangeMap& map);

        //- Update from another mesh using the given map
        virtual void mapMesh(const polyMeshMap& map);


    // Member Operators

        //- Disallow default bitwise assignment
        void operator=(const cpuLoad&) = delete;
};


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

} // End namespace Foam

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

#endif

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