File size: 11,691 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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  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/>.

Namespace
    Foam::expression

Description
    Specialise expression::Operate for dimensionSet so that non-dimensioned
    types access the dimensionless set and dimensioned types access their
    dimensions.

    !!! This could/should ultimately be put directly into dimensionSet.H

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

#ifndef expressionDimensionSet_H
#define expressionDimensionSet_H

#include "dimensionedType.H"

#include "expressionOperate.H"

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

namespace Foam
{
namespace expression
{

/*---------------------------------------------------------------------------*\
                     Class DimensionsOrUniformExponent Declaration
\*---------------------------------------------------------------------------*/

template<class Exponent>
class DimensionsOrUniformExponent
{
    const dimensionSet& dimensions_;

    const Exponent exponent_;

public:

    DimensionsOrUniformExponent(const Exponent& exponent)
    :
        dimensions_(dimless),
        exponent_(exponent)
    {}

    DimensionsOrUniformExponent(const dimensioned<Exponent>& dt)
    :
        dimensions_(dt.dimensions()),
        exponent_(dt.value())
    {}

    operator const dimensionSet&() const
    {
        return dimensions_;
    }

    friend dimensionSet pow
    (
        const dimensionSet& dimensions,
        const DimensionsOrUniformExponent<Exponent>& doue
    )
    {
        doue.dimensions_ = dimless;
        return pow(dimensions, doue.exponent_);
    }

    friend dimensionSet root
    (
        const dimensionSet& dimensions,
        const DimensionsOrUniformExponent<Exponent>& doue
    )
    {
        doue.dimensions_ = dimless;
        return pow(dimensions, scalar(1)/doue.exponent_);
    }
};

/*---------------------------------------------------------------------------*\
                  Class dimensionsOrVariableExponent Declaration
\*---------------------------------------------------------------------------*/

class dimensionsOrVariableExponent
{
    const dimensionSet dimensions_;

public:

    dimensionsOrVariableExponent(const dimensionSet& dimensions)
    :
        dimensions_(dimensions)
    {}

    operator const dimensionSet&() const
    {
        return dimensions_;
    }

    #define UNARY_DOVE_FUNCTION(Func)                                          \
                                                                               \
        friend dimensionsOrVariableExponent Func                               \
        (                                                                      \
            const dimensionsOrVariableExponent& dove                           \
        )                                                                      \
        {                                                                      \
            return Func(dove.dimensions_);                                     \
        }

    #define BINARY_DOVE_FUNCTION(Func)                                         \
                                                                               \
        friend dimensionsOrVariableExponent Func                               \
        (                                                                      \
            const dimensionsOrVariableExponent& a,                             \
            const dimensionsOrVariableExponent& b                              \
        )                                                                      \
        {                                                                      \
            return Func(a.dimensions_, b.dimensions_);                         \
        }                                                                      \
                                                                               \
        friend dimensionsOrVariableExponent Func                               \
        (                                                                      \
            const dimensionsOrVariableExponent& dove,                          \
            const dimensionSet& dimensions                                     \
        )                                                                      \
        {                                                                      \
            return Func(dove.dimensions_, dimensions);                         \
        }                                                                      \
                                                                               \
        friend dimensionsOrVariableExponent Func                               \
        (                                                                      \
            const dimensionSet& dimensions,                                    \
            const dimensionsOrVariableExponent& dove                           \
        )                                                                      \
        {                                                                      \
            return Func(dimensions, dove.dimensions_);                         \
        }

    // These are all the functions and operators defined for dimensionSet
    BINARY_DOVE_FUNCTION(max)
    BINARY_DOVE_FUNCTION(min)
    BINARY_DOVE_FUNCTION(cmptMultiply)
    BINARY_DOVE_FUNCTION(cmptDivide)
    UNARY_DOVE_FUNCTION(cmptMag)
    //UNARY_DOVE_FUNCTION(component) // Would need a different implementation
    //UNARY_DOVE_FUNCTION(pow) // Different implementation below
    UNARY_DOVE_FUNCTION(sqr)
    UNARY_DOVE_FUNCTION(innerSqr)
    UNARY_DOVE_FUNCTION(pow3)
    UNARY_DOVE_FUNCTION(pow4)
    UNARY_DOVE_FUNCTION(pow5)
    UNARY_DOVE_FUNCTION(pow6)
    UNARY_DOVE_FUNCTION(sqrt)
    UNARY_DOVE_FUNCTION(pow025)
    UNARY_DOVE_FUNCTION(cbrt)
    UNARY_DOVE_FUNCTION(magSqr)
    UNARY_DOVE_FUNCTION(mag)
    UNARY_DOVE_FUNCTION(sign)
    UNARY_DOVE_FUNCTION(pos)
    UNARY_DOVE_FUNCTION(pos0)
    UNARY_DOVE_FUNCTION(neg)
    UNARY_DOVE_FUNCTION(neg0)
    UNARY_DOVE_FUNCTION(posPart)
    UNARY_DOVE_FUNCTION(negPart)
    UNARY_DOVE_FUNCTION(exp)
    UNARY_DOVE_FUNCTION(log)
    UNARY_DOVE_FUNCTION(log10)
    UNARY_DOVE_FUNCTION(sin)
    UNARY_DOVE_FUNCTION(cos)
    UNARY_DOVE_FUNCTION(tan)
    UNARY_DOVE_FUNCTION(asin)
    UNARY_DOVE_FUNCTION(acos)
    UNARY_DOVE_FUNCTION(atan)
    UNARY_DOVE_FUNCTION(sinh)
    UNARY_DOVE_FUNCTION(cosh)
    UNARY_DOVE_FUNCTION(tanh)
    UNARY_DOVE_FUNCTION(asinh)
    UNARY_DOVE_FUNCTION(acosh)
    UNARY_DOVE_FUNCTION(atanh)
    UNARY_DOVE_FUNCTION(erf)
    UNARY_DOVE_FUNCTION(erfc)
    UNARY_DOVE_FUNCTION(lgamma)
    UNARY_DOVE_FUNCTION(j0)
    UNARY_DOVE_FUNCTION(j1)
    UNARY_DOVE_FUNCTION(y0)
    UNARY_DOVE_FUNCTION(y1)
    BINARY_DOVE_FUNCTION(atan2)
    BINARY_DOVE_FUNCTION(jn)
    BINARY_DOVE_FUNCTION(yn)
    UNARY_DOVE_FUNCTION(T)
    UNARY_DOVE_FUNCTION(tr)
    UNARY_DOVE_FUNCTION(sph)
    UNARY_DOVE_FUNCTION(diag)
    UNARY_DOVE_FUNCTION(symm)
    UNARY_DOVE_FUNCTION(twoSymm)
    UNARY_DOVE_FUNCTION(dev)
    UNARY_DOVE_FUNCTION(dev2)
    UNARY_DOVE_FUNCTION(skew)
    UNARY_DOVE_FUNCTION(hdual)
    UNARY_DOVE_FUNCTION(eigenValues)
    UNARY_DOVE_FUNCTION(eigenVectors)
    UNARY_DOVE_FUNCTION(det)
    UNARY_DOVE_FUNCTION(cof)
    UNARY_DOVE_FUNCTION(inv)
    UNARY_DOVE_FUNCTION(normalised)
    UNARY_DOVE_FUNCTION(perpendicular)
    UNARY_DOVE_FUNCTION(operator-)
    BINARY_DOVE_FUNCTION(operator+)
    BINARY_DOVE_FUNCTION(operator-)
    BINARY_DOVE_FUNCTION(operator*)
    BINARY_DOVE_FUNCTION(operator/)
    BINARY_DOVE_FUNCTION(operator&)
    BINARY_DOVE_FUNCTION(operator^)
    BINARY_DOVE_FUNCTION(operator&&)

    #undef UNARY_DOVE_FUNCTION
    #undef BINARY_DOVE_FUNCTION

    friend const dimensionSet& pow
    (
        const dimensionSet& dimensions,
        const dimensionsOrVariableExponent& dove
    )
    {
        dimensions = dimless;
        dove.dimensions_ = dimless;
        return dimless;
    }
};

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

template<class Type>
struct Operate
<
    Type,
    Arguments<dimensionSet>,
    EnableIfNotExpressionable<Type>
>
{
    using type = const dimensionSet&;

    static type access(const Type& t, const dimensionSet&)
    {
        return dimless;
    }
};

template<>
struct Operate
<
    int32_t,
    Arguments<dimensionSet>,
    EnableIfNotExpressionable<int32_t>
>
{
    using type = DimensionsOrUniformExponent<int32_t>;

    static type access(const int32_t l, const dimensionSet&)
    {
        return type(l);
    }
};

template<>
struct Operate
<
    int64_t,
    Arguments<dimensionSet>,
    EnableIfNotExpressionable<int64_t>
>
{
    using type = DimensionsOrUniformExponent<int64_t>;

    static type access(const int64_t l, const dimensionSet&)
    {
        return type(l);
    }
};

template<>
struct Operate
<
    float,
    Arguments<dimensionSet>,
    EnableIfNotExpressionable<float>
>
{
    using type = DimensionsOrUniformExponent<float>;

    static type access(const float s, const dimensionSet&)
    {
        return type(s);
    }
};

template<>
struct Operate
<
    double,
    Arguments<dimensionSet>,
    EnableIfNotExpressionable<double>
>
{
    using type = DimensionsOrUniformExponent<double>;

    static type access(const double s, const dimensionSet&)
    {
        return type(s);
    }
};

template<>
struct Operate
<
    long double,
    Arguments<dimensionSet>,
    EnableIfNotExpressionable<double>
>
{
    using type = DimensionsOrUniformExponent<long double>;

    static type access(const long double s, const dimensionSet&)
    {
        return type(s);
    }
};

template<class Type>
struct Operate
<
    dimensioned<Type>,
    Arguments<dimensionSet>,
    EnableIfNotExpressionable<dimensioned<Type>>
>
{
    using type = const dimensionSet&;

    static type access(const dimensioned<Type>& dt, const dimensionSet&)
    {
        return dt.dimensions();
    }
};

template<>
struct Operate
<
    dimensionedScalar,
    Arguments<dimensionSet>,
    EnableIfNotExpressionable<dimensionedScalar>
>
{
    using type = DimensionsOrUniformExponent<scalar>;

    static type access(const dimensionedScalar& ds, const dimensionSet&)
    {
        return type(ds);
    }
};

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

} // End namespace Foam
} // End namespace expression

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

#endif

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