genericFaPatchField.C 21.6 KB
Newer Older
1
2
3
4
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
5
    \\  /    A nd           | Copyright (C) 2019 OpenCFD Ltd.
6
     \\/     M anipulation  |
OpenFOAM bot's avatar
OpenFOAM bot committed
7
8
-------------------------------------------------------------------------------
                            | Copyright (C) 2011-2016 OpenFOAM Foundation
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
-------------------------------------------------------------------------------
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/>.

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

#include "genericFaPatchField.H"
#include "faPatchFieldMapper.H"

// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //

template<class Type>
Foam::genericFaPatchField<Type>::genericFaPatchField
(
    const faPatch& p,
    const DimensionedField<Type, areaMesh>& iF
)
:
    calculatedFaPatchField<Type>(p, iF)
{
    FatalErrorInFunction
        << "Trying to construct an genericFaPatchField on patch "
        << this->patch().name()
        << " of field " << this->internalField().name()
        << abort(FatalError);
}


template<class Type>
Foam::genericFaPatchField<Type>::genericFaPatchField
(
    const faPatch& p,
    const DimensionedField<Type, areaMesh>& iF,
    const dictionary& dict
)
:
    calculatedFaPatchField<Type>(p, iF, dict),
59
    actualTypeName_(dict.get<word>("type")),
60
61
    dict_(dict)
{
62
63
    const label patchSize = this->size();

64
65
    if (!dict.found("value"))
    {
66
        FatalIOErrorInFunction(dict)
67
            << nl << "    Cannot find 'value' entry"
68
69
            << " on patch " << this->patch().name()
            << " of field " << this->internalField().name()
70
            << " in file " << this->internalField().objectPath() << nl
71
72
            << "    which is required to set the"
               " values of the generic patch field." << nl
73
74
75
            << "    (Actual type " << actualTypeName_ << ')' << nl << nl
            << "    Please add the 'value' entry to the write function"
               " of the user-defined boundary-condition" << nl
76
77
78
            << exit(FatalIOError);
    }

79
    for (const entry& dEntry : dict_)
80
    {
81
82
        const keyType& key = dEntry.keyword();

83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
        if
        (
            key == "type"
         || key == "value"
         || !dEntry.isStream() || dEntry.stream().empty()
        )
        {
            continue;
        }


        ITstream& is = dEntry.stream();

        // Read first token
        token firstToken(is);

        if
        (
            firstToken.isWord()
         && firstToken.wordToken() == "nonuniform"
        )
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
            token fieldToken(is);

            if (!fieldToken.isCompound())
            {
                if
                (
                    fieldToken.isLabel()
                 && fieldToken.labelToken() == 0
                )
                {
                    scalarFields_.insert(key, autoPtr<scalarField>::New());
                }
                else
                {
                    FatalIOErrorInFunction(dict)
                        << "\n    token following 'nonuniform' "
                           "is not a compound"
                        << "\n    on patch " << this->patch().name()
                        << " of field "
                        << this->internalField().name()
                        << " in file "
                        << this->internalField().objectPath() << nl
                        << exit(FatalIOError);
                }
            }
            else if
131
            (
132
133
                fieldToken.compoundToken().type()
             == token::Compound<List<scalar>>::typeName
134
135
            )
            {
136
                auto fPtr = autoPtr<scalarField>::New();
137

138
139
140
141
142
143
144
                fPtr->transfer
                (
                    dynamicCast<token::Compound<List<scalar>>>
                    (
                        fieldToken.transferCompoundToken(is)
                    )
                );
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
                if (fPtr->size() != patchSize)
                {
                    FatalIOErrorInFunction(dict)
                        << "\n    size of field " << key
                        << " (" << fPtr->size() << ')'
                        << " is not the same size as the patch ("
                        << patchSize << ')'
                        << "\n    on patch " << this->patch().name()
                        << " of field "
                        << this->internalField().name()
                        << " in file "
                        << this->internalField().objectPath() << nl
                        << exit(FatalIOError);
                }

                scalarFields_.insert(key, fPtr);
            }
            else if
            (
                fieldToken.compoundToken().type()
             == token::Compound<List<vector>>::typeName
            )
            {
                auto fPtr = autoPtr<vectorField>::New();

                fPtr->transfer
172
                (
173
174
175
176
177
178
179
                    dynamicCast<token::Compound<List<vector>>>
                    (
                        fieldToken.transferCompoundToken(is)
                    )
                );

                if (fPtr->size() != patchSize)
180
                {
181
182
183
184
185
186
187
188
189
190
191
192
                    FatalIOErrorInFunction(dict)
                        << "\n    size of field " << key
                        << " (" << fPtr->size() << ')'
                        << " is not the same size as the patch ("
                        << patchSize << ')'
                        << "\n    on patch " << this->patch().name()
                        << " of field "
                        << this->internalField().name()
                        << " in file "
                        << this->internalField().objectPath() << nl
                        << exit(FatalIOError);
                }
193

194
195
196
197
198
199
200
201
202
203
204
205
206
                vectorFields_.insert(key, fPtr);
            }
            else if
            (
                fieldToken.compoundToken().type()
             == token::Compound<List<sphericalTensor>>::typeName
            )
            {
                auto fPtr = autoPtr<sphericalTensorField>::New();

                fPtr->transfer
                (
                    dynamicCast<token::Compound<List<sphericalTensor>>>
207
                    (
208
                        fieldToken.transferCompoundToken(is)
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
                if (fPtr->size() != patchSize)
                {
                    FatalIOErrorInFunction(dict)
                        << "\n    size of field " << key
                        << " (" << fPtr->size() << ')'
                        << " is not the same size as the patch ("
                        << patchSize << ')'
                        << "\n    on patch " << this->patch().name()
                        << " of field "
                        << this->internalField().name()
                        << " in file "
                        << this->internalField().objectPath() << nl
                        << exit(FatalIOError);
                }

                sphTensorFields_.insert(key, fPtr);
            }
            else if
            (
                fieldToken.compoundToken().type()
             == token::Compound<List<symmTensor>>::typeName
            )
            {
                auto fPtr = autoPtr<symmTensorField>::New();

                fPtr->transfer
                (
                    dynamicCast<token::Compound<List<symmTensor>>>
240
                    (
241
                        fieldToken.transferCompoundToken(is)
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
                if (fPtr->size() != patchSize)
                {
                    FatalIOErrorInFunction(dict)
                        << "\n    size of field " << key
                        << " (" << fPtr->size() << ')'
                        << " is not the same size as the patch ("
                        << patchSize << ')'
                        << "\n    on patch " << this->patch().name()
                        << " of field "
                        << this->internalField().name()
                        << " in file "
                        << this->internalField().objectPath() << nl
                        << exit(FatalIOError);
                }

                symmTensorFields_.insert(key, fPtr);
            }
            else if
            (
                fieldToken.compoundToken().type()
             == token::Compound<List<tensor>>::typeName
            )
            {
                auto fPtr = autoPtr<tensorField>::New();

                fPtr->transfer
                (
                    dynamicCast<token::Compound<List<tensor>>>
273
                    (
274
                        fieldToken.transferCompoundToken(is)
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
                if (fPtr->size() != patchSize)
                {
                    FatalIOErrorInFunction(dict)
                        << "\n    size of field " << key
                        << " (" << fPtr->size() << ')'
                        << " is not the same size as the patch ("
                        << patchSize << ')'
                        << "\n    on patch " << this->patch().name()
                        << " of field "
                        << this->internalField().name()
                        << " in file "
                        << this->internalField().objectPath() << nl
                        << exit(FatalIOError);
                }

                tensorFields_.insert(key, fPtr);
            }
            else
            {
                FatalIOErrorInFunction(dict)
                    << "\n    compound " << fieldToken.compoundToken()
                    << " not supported"
                    << "\n    on patch " << this->patch().name()
                    << " of field "
                    << this->internalField().name()
                    << " in file "
                    << this->internalField().objectPath() << nl
                    << exit(FatalIOError);
            }
        }
        else if
        (
            firstToken.isWord()
         && firstToken.wordToken() == "uniform"
        )
        {
            token fieldToken(is);

            if (!fieldToken.isPunctuation())
            {
                scalarFields_.insert
                (
                    key,
                    autoPtr<scalarField>::New
322
                    (
323
324
                        patchSize,
                        fieldToken.number()
325
                    )
326
327
328
329
330
331
332
333
334
335
336
337
                );
            }
            else
            {
                // Read as scalarList.
                is.putBack(fieldToken);

                scalarList l(is);

                if (l.size() == vector::nComponents)
                {
                    vector vs(l[0], l[1], l[2]);
338

339
340
341
342
                    vectorFields_.insert
                    (
                        key,
                        autoPtr<vectorField>::New
343
                        (
344
345
346
347
348
349
350
351
352
353
                            patchSize,
                            vs
                        )
                    );
                }
                else if (l.size() == sphericalTensor::nComponents)
                {
                    sphericalTensor vs(l[0]);

                    sphTensorFields_.insert
354
                    (
355
356
357
358
359
360
361
362
363
364
365
                        key,
                        autoPtr<sphericalTensorField>::New
                        (
                            patchSize,
                            vs
                        )
                    );
                }
                else if (l.size() == symmTensor::nComponents)
                {
                    symmTensor vs(l[0], l[1], l[2], l[3], l[4], l[5]);
366

367
368
369
370
                    symmTensorFields_.insert
                    (
                        key,
                        autoPtr<symmTensorField>::New
371
                        (
372
373
374
375
                            patchSize,
                            vs
                        )
                    );
376
                }
377
                else if (l.size() == tensor::nComponents)
378
                {
379
380
381
382
383
384
                    tensor vs
                    (
                        l[0], l[1], l[2],
                        l[3], l[4], l[5],
                        l[6], l[7], l[8]
                    );
385

386
387
388
389
                    tensorFields_.insert
                    (
                        key,
                        autoPtr<tensorField>::New
390
                        (
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
                            patchSize,
                            vs
                        )
                    );
                }
                else
                {
                    FatalIOErrorInFunction(dict)
                        << "\n    unrecognised native type " << l
                        << "\n    on patch " << this->patch().name()
                        << " of field "
                        << this->internalField().name()
                        << " in file "
                        << this->internalField().objectPath() << nl
                        << exit(FatalIOError);
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
                }
            }
        }
    }
}


template<class Type>
Foam::genericFaPatchField<Type>::genericFaPatchField
(
    const genericFaPatchField<Type>& ptf,
    const faPatch& p,
    const DimensionedField<Type, areaMesh>& iF,
    const faPatchFieldMapper& mapper
)
:
    calculatedFaPatchField<Type>(ptf, p, iF, mapper),
    actualTypeName_(ptf.actualTypeName_),
    dict_(ptf.dict_)
{
426
    forAllConstIters(ptf.scalarFields_, iter)
427
428
429
430
    {
        scalarFields_.insert
        (
            iter.key(),
431
            autoPtr<scalarField>::New(*iter(), mapper)
432
433
434
        );
    }

435
    forAllConstIters(ptf.vectorFields_, iter)
436
437
438
439
    {
        vectorFields_.insert
        (
            iter.key(),
440
            autoPtr<vectorField>::New(*iter(), mapper)
441
442
443
        );
    }

444
    forAllConstIters(ptf.sphTensorFields_, iter)
445
    {
446
        sphTensorFields_.insert
447
448
        (
            iter.key(),
449
            autoPtr<sphericalTensorField>::New(*iter(), mapper)
450
451
452
        );
    }

453
    forAllConstIters(ptf.symmTensorFields_, iter)
454
455
456
457
    {
        symmTensorFields_.insert
        (
            iter.key(),
458
            autoPtr<symmTensorField>::New(*iter(), mapper)
459
460
461
        );
    }

462
    forAllConstIters(ptf.tensorFields_, iter)
463
464
465
466
    {
        tensorFields_.insert
        (
            iter.key(),
467
            autoPtr<tensorField>::New(*iter(), mapper)
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
        );
    }
}


template<class Type>
Foam::genericFaPatchField<Type>::genericFaPatchField
(
    const genericFaPatchField<Type>& ptf
)
:
    calculatedFaPatchField<Type>(ptf),
    actualTypeName_(ptf.actualTypeName_),
    dict_(ptf.dict_),
    scalarFields_(ptf.scalarFields_),
    vectorFields_(ptf.vectorFields_),
484
    sphTensorFields_(ptf.sphTensorFields_),
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
    symmTensorFields_(ptf.symmTensorFields_),
    tensorFields_(ptf.tensorFields_)
{}


template<class Type>
Foam::genericFaPatchField<Type>::genericFaPatchField
(
    const genericFaPatchField<Type>& ptf,
    const DimensionedField<Type, areaMesh>& iF
)
:
    calculatedFaPatchField<Type>(ptf, iF),
    actualTypeName_(ptf.actualTypeName_),
    dict_(ptf.dict_),
    scalarFields_(ptf.scalarFields_),
    vectorFields_(ptf.vectorFields_),
502
    sphTensorFields_(ptf.sphTensorFields_),
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
    symmTensorFields_(ptf.symmTensorFields_),
    tensorFields_(ptf.tensorFields_)
{}


// * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //

template<class Type>
void Foam::genericFaPatchField<Type>::autoMap
(
    const faPatchFieldMapper& m
)
{
    calculatedFaPatchField<Type>::autoMap(m);

518
    forAllIters(scalarFields_, iter)
519
    {
520
        iter->autoMap(m);
521
522
    }

523
    forAllIters(vectorFields_, iter)
524
    {
525
        iter->autoMap(m);
526
527
    }

528
    forAllIters(sphTensorFields_, iter)
529
    {
530
        iter->autoMap(m);
531
532
    }

533
    forAllIters(symmTensorFields_, iter)
534
    {
535
        iter->autoMap(m);
536
537
    }

538
    forAllIters(tensorFields_, iter)
539
    {
540
        iter->autoMap(m);
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
    }
}


template<class Type>
void Foam::genericFaPatchField<Type>::rmap
(
    const faPatchField<Type>& ptf,
    const labelList& addr
)
{
    calculatedFaPatchField<Type>::rmap(ptf, addr);

    const genericFaPatchField<Type>& dptf =
        refCast<const genericFaPatchField<Type>>(ptf);

557
    forAllIters(scalarFields_, iter )
558
    {
559
        const auto iter2 = dptf.scalarFields_.cfind(iter.key());
560

561
        if (iter.found())
562
        {
563
            iter->rmap(*iter2(), addr);
564
565
566
        }
    }

567
    forAllIters(vectorFields_, iter)
568
    {
569
        const auto iter2 = dptf.vectorFields_.cfind(iter.key());
570

571
        if (iter.found())
572
        {
573
            iter->rmap(*iter2(), addr);
574
575
576
        }
    }

577
    forAllIters(sphTensorFields_, iter)
578
    {
579
        const auto iter2 = dptf.sphTensorFields_.cfind(iter.key());
580

581
        if (iter.found())
582
        {
583
            iter->rmap(*iter2(), addr);
584
585
586
        }
    }

587
    forAllIters(symmTensorFields_, iter)
588
    {
589
        const auto iter2 = dptf.symmTensorFields_.cfind(iter.key());
590

591
        if (iter.found())
592
        {
593
            iter->rmap(*iter2(), addr);
594
595
596
        }
    }

597
    forAllIters(tensorFields_, iter)
598
    {
599
        const auto iter2 = dptf.tensorFields_.find(iter.key());
600

601
        if (iter.found())
602
        {
603
            iter->rmap(*iter2(), addr);
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
        }
    }
}


template<class Type>
Foam::tmp<Foam::Field<Type>>
Foam::genericFaPatchField<Type>::valueInternalCoeffs
(
    const tmp<scalarField>&
) const
{
    FatalErrorInFunction
        << "cannot be called for a genericFaPatchField"
           " (actual type " << actualTypeName_ << ")"
        << "\n    on patch " << this->patch().name()
        << " of field " << this->internalField().name()
        << " in file " << this->internalField().objectPath()
        << "\n    You are probably trying to solve for a field with a "
           "generic boundary condition."
        << abort(FatalError);

    return *this;
}


template<class Type>
Foam::tmp<Foam::Field<Type>>
Foam::genericFaPatchField<Type>::valueBoundaryCoeffs
(
    const tmp<scalarField>&
) const
{
    FatalErrorInFunction
        << "cannot be called for a genericFaPatchField"
           " (actual type " << actualTypeName_ << ")"
        << "\n    on patch " << this->patch().name()
        << " of field " << this->internalField().name()
        << " in file " << this->internalField().objectPath()
        << "\n    You are probably trying to solve for a field with a "
           "generic boundary condition."
        << abort(FatalError);

    return *this;
}


template<class Type>
Foam::tmp<Foam::Field<Type>>
Foam::genericFaPatchField<Type>::gradientInternalCoeffs() const
{
    FatalErrorInFunction
        << "cannot be called for a genericFaPatchField"
           " (actual type " << actualTypeName_ << ")"
        << "\n    on patch " << this->patch().name()
        << " of field " << this->internalField().name()
        << " in file " << this->internalField().objectPath()
        << "\n    You are probably trying to solve for a field with a "
           "generic boundary condition."
        << abort(FatalError);

    return *this;
}

template<class Type>
Foam::tmp<Foam::Field<Type>>
Foam::genericFaPatchField<Type>::gradientBoundaryCoeffs() const
{
    FatalErrorInFunction
        << "cannot be called for a genericFaPatchField"
           " (actual type " << actualTypeName_ << ")"
        << "\n    on patch " << this->patch().name()
        << " of field " << this->internalField().name()
        << " in file " << this->internalField().objectPath()
        << "\n    You are probably trying to solve for a field with a "
           "generic boundary condition."
        << abort(FatalError);

    return *this;
}


template<class Type>
const Foam::word& Foam::genericFaPatchField<Type>::actualType() const
{
    return actualTypeName_;
}


template<class Type>
void Foam::genericFaPatchField<Type>::write(Ostream& os) const
{
    os.writeEntry("type", actualTypeName_);

698
    for (const entry& dEntry : dict_)
699
    {
700
701
        const keyType& key = dEntry.keyword();

702
        if (key == "type" || key == "value")
703
        {
704
            // NB: "type" written first, "value" written last
705
706
707
708
709
710
711
712
713
714
715
            continue;
        }
        else if
        (
            dEntry.isStream()
         && dEntry.stream().size()
         && dEntry.stream()[0].isWord()
         && dEntry.stream()[0].wordToken() == "nonuniform"
        )
        {
            if (scalarFields_.found(key))
716
            {
717
                scalarFields_.cfind(key)->writeEntry(key, os);
718
            }
719
            else if (vectorFields_.found(key))
720
            {
721
                vectorFields_.cfind(key)->writeEntry(key, os);
722
            }
723
724
            else if (sphTensorFields_.found(key))
            {
725
                sphTensorFields_.cfind(key)->writeEntry(key, os);
726
727
728
            }
            else if (symmTensorFields_.found(key))
            {
729
                symmTensorFields_.cfind(key)->writeEntry(key, os);
730
731
732
            }
            else if (tensorFields_.found(key))
            {
733
                tensorFields_.cfind(key)->writeEntry(key, os);
734
735
736
737
738
            }
        }
        else
        {
            dEntry.write(os);
739
740
741
742
743
744
745
746
        }
    }

    this->writeEntry("value", os);
}


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