changeDictionary.C 19.4 KB
Newer Older
mattijs's avatar
mattijs committed
1
2
3
4
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
5
6
    \\  /    A nd           | Copyright (C) 2011-2016 OpenFOAM Foundation
     \\/     M anipulation  | Copyright (C) 2016 OpenCFD Ltd.
mattijs's avatar
mattijs committed
7
8
9
10
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

11
12
13
14
    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.
mattijs's avatar
mattijs committed
15
16
17
18
19
20
21

    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
22
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
mattijs's avatar
mattijs committed
23

henry's avatar
henry committed
24
25
26
Application
    changeDictionary

27
28
29
Group
    grpPreProcessingUtilities

mattijs's avatar
mattijs committed
30
Description
31
32
33
34
    Utility to change dictionary entries, e.g. can be used to change the patch
    type in the field and polyMesh/boundary files.

    Reads dictionaries (fields) and entries to change from a dictionary.
35
    E.g. to make the \em movingWall a \em fixedValue for \em p but all other
36
37
38
    \em Walls a zeroGradient boundary condition, the
    \c system/changeDictionaryDict would contain the following:
    \verbatim
39
    p                           // field to change
mattijs's avatar
mattijs committed
40
    {
41
        boundaryField
mattijs's avatar
mattijs committed
42
        {
43
            ".*Wall"            // entry to change
mattijs's avatar
mattijs committed
44
            {
45
46
47
48
49
50
                type            zeroGradient;
            }
            movingWall          // entry to change
            {
                type            fixedValue;
                value           uniform 123.45;
mattijs's avatar
mattijs committed
51
52
53
            }
        }
    }
54
    \endverbatim
55
    Replacement entries starting with '~' will remove the entry.
mattijs's avatar
mattijs committed
56

mattijs's avatar
mattijs committed
57
Usage
58
    \b changeDictionary [OPTION]
mattijs's avatar
mattijs committed
59

60
61
62
    Options:
      - \par -subDict
        Specify the subDict name of the replacements dictionary.
mattijs's avatar
mattijs committed
63

64
65
66
      - \par -literalRE
        Do not interpret regular expressions or patchGroups; treat them as any
        other keyword.
mattijs's avatar
mattijs committed
67

68
69
      - \par -enableFunctionEntries
        Enable function entries (default: disabled)
70

71
72
      - \par -disablePatchGroups
        Disable the default checking for keys being patchGroups
73

mattijs's avatar
mattijs committed
74
75
76
77
\*---------------------------------------------------------------------------*/

#include "argList.H"
#include "IOobjectList.H"
78
#include "IOPtrList.H"
mattijs's avatar
mattijs committed
79
#include "volFields.H"
mattijs's avatar
mattijs committed
80
#include "stringListOps.H"
81
#include "timeSelector.H"
mattijs's avatar
mattijs committed
82
83
84
85
86

using namespace Foam;

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

87
88
89
90
91
92
namespace Foam
{
    defineTemplateTypeNameAndDebug(IOPtrList<entry>, 0);
}


henry's avatar
henry committed
93
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
mattijs's avatar
mattijs committed
94

95
// Extract groupPatch info from boundary file info
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
HashTable<wordList, word> extractPatchGroups(const dictionary& boundaryDict)
{
    HashTable<wordList, word> groupToPatch;

    forAllConstIter(dictionary, boundaryDict, iter)
    {
        const word& patchName = iter().keyword();
        const dictionary& patchDict = iter().dict();

        wordList groups;
        if (patchDict.readIfPresent("inGroups", groups))
        {
            forAll(groups, i)
            {
                HashTable<wordList, word>::iterator fndGroup = groupToPatch.find
                (
                    groups[i]
                );
                if (fndGroup == groupToPatch.end())
                {
                    groupToPatch.insert(groups[i], wordList(1, patchName));
                }
                else
                {
                    fndGroup().append(patchName);
                }
            }
        }
    }
    return groupToPatch;
}


bool merge
(
131
    const bool addNonExisting,
132
133
134
135
136
    dictionary&,
    const dictionary&,
    const bool,
    const HashTable<wordList, word>&
);
mattijs's avatar
mattijs committed
137
138
139
140
141
142
143
144


// Add thisEntry to dictionary thisDict.
bool addEntry
(
    dictionary& thisDict,
    entry& thisEntry,
    const entry& mergeEntry,
145
146
    const bool literalRE,
    const HashTable<wordList, word>& shortcuts
mattijs's avatar
mattijs committed
147
148
149
150
151
152
153
154
155
156
157
158
)
{
    bool changed = false;

    // Recursively merge sub-dictionaries
    // TODO: merge without copying
    if (thisEntry.isDict() && mergeEntry.isDict())
    {
        if
        (
            merge
            (
159
                true,
mattijs's avatar
mattijs committed
160
161
                const_cast<dictionary&>(thisEntry.dict()),
                mergeEntry.dict(),
162
163
                literalRE,
                shortcuts
mattijs's avatar
mattijs committed
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
            )
        )
        {
            changed = true;
        }
    }
    else
    {
        // Should use in-place modification instead of adding
        thisDict.add(mergeEntry.clone(thisDict).ptr(), true);
        changed = true;
    }

    return changed;
}


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

// List of indices into thisKeys
labelList findMatches
(
    const HashTable<wordList, word>& shortcuts,
    const wordList& shortcutNames,
    const wordList& thisKeys,
    const keyType& key
)
{
    labelList matches;

    if (key.isPattern())
    {
        // Wildcard match
        matches = findStrings(key, thisKeys);

    }
    else if (shortcuts.size())
    {
        // See if patchGroups expand to valid thisKeys
        labelList indices = findStrings(key, shortcutNames);
        forAll(indices, i)
        {
            const word& name = shortcutNames[indices[i]];
            const wordList& keys = shortcuts[name];
            forAll(keys, j)
            {
                label index = findIndex(thisKeys, keys[j]);
                if (index != -1)
                {
                    matches.append(index);
                }
            }
        }
    }
    return matches;
}


mattijs's avatar
mattijs committed
221
// Dictionary merging/editing.
mattijs's avatar
mattijs committed
222
223
// literalRE:
// - true: behave like dictionary::merge, i.e. add regexps just like
mattijs's avatar
mattijs committed
224
225
226
227
//   any other key.
// - false : interpret wildcard as a rule for items to be matched.
bool merge
(
228
    const bool addNonExisting,
mattijs's avatar
mattijs committed
229
230
    dictionary& thisDict,
    const dictionary& mergeDict,
231
232
    const bool literalRE,
    const HashTable<wordList, word>& shortcuts
mattijs's avatar
mattijs committed
233
234
)
{
235
236
    const wordList shortcutNames(shortcuts.toc());

mattijs's avatar
mattijs committed
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
    bool changed = false;

    // Save current (non-wildcard) keys before adding items.
    HashSet<word> thisKeysSet;
    {
        List<keyType> keys = thisDict.keys(false);
        forAll(keys, i)
        {
            thisKeysSet.insert(keys[i]);
        }
    }

    // Pass 1. All literal matches

    forAllConstIter(IDLList<entry>, mergeDict, mergeIter)
    {
        const keyType& key = mergeIter().keyword();

255
256
257
258
259
260
261
262
263
264
265
266
        if (key[0] == '~')
        {
            word eraseKey = key(1, key.size()-1);
            if (thisDict.remove(eraseKey))
            {
                // Mark thisDict entry as having been match for wildcard
                // handling later on.
                thisKeysSet.erase(eraseKey);
            }
            changed = true;
        }
        else if (literalRE || !(key.isPattern() || shortcuts.found(key)))
mattijs's avatar
mattijs committed
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
        {
            entry* entryPtr = thisDict.lookupEntryPtr
            (
                key,
                false,              // recursive
                false               // patternMatch
            );

            if (entryPtr)
            {
                // Mark thisDict entry as having been match for wildcard
                // handling later on.
                thisKeysSet.erase(entryPtr->keyword());

                if
                (
                    addEntry
                    (
                        thisDict,
                       *entryPtr,
                        mergeIter(),
288
289
                        literalRE,
                        shortcuts
mattijs's avatar
mattijs committed
290
291
292
293
294
295
296
297
                    )
                )
                {
                    changed = true;
                }
            }
            else
            {
298
299
300
301
302
303
304
305
306
307
308
309
                if (addNonExisting)
                {
                    // not found - just add
                    thisDict.add(mergeIter().clone(thisDict).ptr());
                    changed = true;
                }
                else
                {
                    IOWarningInFunction(mergeDict)
                        << "Ignoring non-existing entry " << key
                        << endl;
                }
mattijs's avatar
mattijs committed
310
311
312
313
314
            }
        }
    }


315
    // Pass 2. Wildcard or shortcut matches (if any) on any non-match keys.
mattijs's avatar
mattijs committed
316

mattijs's avatar
mattijs committed
317
    if (!literalRE && thisKeysSet.size() > 0)
mattijs's avatar
mattijs committed
318
    {
319
        // Pick up remaining dictionary entries
mattijs's avatar
mattijs committed
320
321
322
323
324
325
        wordList thisKeys(thisKeysSet.toc());

        forAllConstIter(IDLList<entry>, mergeDict, mergeIter)
        {
            const keyType& key = mergeIter().keyword();

326
            if (key[0] == '~')
mattijs's avatar
mattijs committed
327
            {
328
                word eraseKey = key(1, key.size()-1);
mattijs's avatar
mattijs committed
329

330
331
332
333
334
335
336
337
338
339
340
341
342
343
                // List of indices into thisKeys
                labelList matches
                (
                    findMatches
                    (
                        shortcuts,
                        shortcutNames,
                        thisKeys,
                        eraseKey
                    )
                );

                // Remove all matches
                forAll(matches, i)
mattijs's avatar
mattijs committed
344
                {
345
346
                    const word& thisKey = thisKeys[matches[i]];
                    thisKeysSet.erase(thisKey);
347
                }
348
                changed = true;
349
            }
350
            else
351
            {
352
353
                // List of indices into thisKeys
                labelList matches
354
                (
355
356
357
358
359
360
361
                    findMatches
                    (
                        shortcuts,
                        shortcutNames,
                        thisKeys,
                        key
                    )
362
                );
mattijs's avatar
mattijs committed
363

364
365
366
367
368
369
                // Add all matches
                forAll(matches, i)
                {
                    const word& thisKey = thisKeys[matches[i]];

                    entry& thisEntry = const_cast<entry&>
mattijs's avatar
mattijs committed
370
                    (
371
372
373
374
375
376
377
378
379
380
381
382
383
384
                        thisDict.lookupEntry(thisKey, false, false)
                    );

                    if
                    (
                        addEntry
                        (
                            thisDict,
                            thisEntry,
                            mergeIter(),
                            literalRE,
                            HashTable<wordList, word>(0)    // no shortcuts
                                                            // at deeper levels
                        )
mattijs's avatar
mattijs committed
385
                    )
386
387
388
                    {
                        changed = true;
                    }
mattijs's avatar
mattijs committed
389
390
391
392
393
394
395
396
397
                }
            }
        }
    }

    return changed;
}


mattijs's avatar
mattijs committed
398
399
400

int main(int argc, char *argv[])
{
401
    #include "addDictOption.H"
402
    argList::addOption
403
404
405
406
407
408
    (
        "subDict",
        "name",
        "specify the subDict name of the replacements dictionary"
    );
    argList::addOption
409
410
411
412
413
    (
        "instance",
        "name",
        "override instance setting (default is the time name)"
    );
414
415
416
417

    // Add explicit time option
    timeSelector::addOptions();

418
419
420
    argList::addBoolOption
    (
        "literalRE",
421
        "treat regular expressions literally (i.e., as a keyword)"
422
    );
423
424
425
426
427
    argList::addBoolOption
    (
        "enableFunctionEntries",
        "enable expansion of dictionary directives - #include, #codeStream etc"
    );
428
429
430
431
432
433
    argList::addBoolOption
    (
        "disablePatchGroups",
        "disable matching keys to patch groups"
    );

434
435
436
437
    #include "addRegionOption.H"

    #include "setRootCase.H"
    #include "createTime.H"
438
439
440
441
442

    // Optionally override controlDict time with -time options
    instantList times = timeSelector::selectIfPresent(runTime, args);
    if (times.size() < 1)
    {
443
        FatalErrorInFunction
444
445
446
            << "No times selected." << exit(FatalError);
    }
    runTime.setTime(times[0], 0);
447
    word instance = args.optionLookupOrDefault("instance", runTime.timeName());
448

449
    #include "createNamedMesh.H"
mattijs's avatar
mattijs committed
450

451
    const bool literalRE = args.optionFound("literalRE");
mattijs's avatar
mattijs committed
452
    if (literalRE)
mattijs's avatar
mattijs committed
453
    {
mattijs's avatar
mattijs committed
454
455
        Info<< "Not interpreting any regular expressions (RE)"
            << " in the changeDictionaryDict." << endl
mattijs's avatar
mattijs committed
456
457
458
459
            << "Instead they are handled as any other entry, i.e. added if"
            << " not present." << endl;
    }

460
461
462
463
464
465
466
    const bool enableEntries = args.optionFound("enableFunctionEntries");
    if (enableEntries)
    {
        Info<< "Allowing dictionary preprocessing ('#include', '#codeStream')."
            << endl;
    }

467
    const int oldFlag = entry::disableFunctionEntries;
468
469
470
471
472
473
    if (!enableEntries)
    {
        // By default disable dictionary expansion for fields
        entry::disableFunctionEntries = 1;
    }

mattijs's avatar
mattijs committed
474

475
476
477
478
479
480
481
482
483
    const bool disablePatchGroups = args.optionFound("disablePatchGroups");
    if (disablePatchGroups)
    {
        Info<< "Not interpreting any keys in the changeDictionary"
            << " as patchGroups"
            << endl;
    }


Mattijs Janssens's avatar
Mattijs Janssens committed
484
485
486
487
488
489
    fileName regionPrefix = "";
    if (regionName != fvMesh::defaultRegion)
    {
        regionPrefix = regionName;
    }

490

491
492
    // Make sure we do not use the master-only reading since we read
    // fields (different per processor) as dictionaries.
493
494
495
    regIOobject::fileModificationChecking = regIOobject::timeStamp;


mattijs's avatar
mattijs committed
496
    // Get the replacement rules from a dictionary
497
498
499
500

    const word dictName("changeDictionaryDict");
    #include "setSystemMeshDictionaryIO.H"
    IOdictionary dict(dictIO);
Henry's avatar
Henry committed
501

502
503
504
505
506
507
508
509
510
511
    const dictionary* replaceDictsPtr = &dict;

    if (args.optionFound("subDict"))
    {
        word subDictName(args.optionLookup("subDict")());
        replaceDictsPtr = &dict.subDict(subDictName);
    }

    const dictionary& replaceDicts = *replaceDictsPtr;

mattijs's avatar
mattijs committed
512
513
514
515
516
    Info<< "Read dictionary " << dict.name()
        << " with replacements for dictionaries "
        << replaceDicts.toc() << endl;


517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545

    // Always read boundary to get patch groups
    // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    Info<< "Reading polyMesh/boundary file to extract patch names"
        << endl;

    // Read PtrList of dictionary as dictionary.
    const word oldTypeName = IOPtrList<entry>::typeName;
    const_cast<word&>(IOPtrList<entry>::typeName) = word::null;
    IOPtrList<entry> dictList
    (
        IOobject
        (
            "boundary",
            runTime.findInstance
            (
                regionPrefix/polyMesh::meshSubDir,
                "boundary",
                IOobject::READ_IF_PRESENT
            ),
            polyMesh::meshSubDir,
            mesh,
            IOobject::READ_IF_PRESENT,
            IOobject::NO_WRITE,
            false
        )
    );
    const_cast<word&>(IOPtrList<entry>::typeName) = oldTypeName;
546

547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
    // Fake type back to what was in field
    const_cast<word&>(dictList.type()) = dictList.headerClassName();

    // Temporary convert to dictionary
    dictionary fieldDict;
    forAll(dictList, i)
    {
        fieldDict.add(dictList[i].keyword(), dictList[i].dict());
    }

    if (dictList.size())
    {
        Info<< "Loaded dictionary " << dictList.name()
            << " with entries " << fieldDict.toc() << endl;
    }

    // Extract any patchGroups information (= shortcut for set of
    // patches)
    HashTable<wordList, word> patchGroups;
    if (!disablePatchGroups)
    {
        patchGroups = extractPatchGroups(fieldDict);
        if (patchGroups.size())
        {
            Info<< "Extracted patch groups:" << endl;
            wordList groups(patchGroups.sortedToc());
            forAll(groups, i)
            {
                Info<< "    group " << groups[i] << " with patches "
                    << patchGroups[groups[i]] << endl;
            }
        }
    }


mattijs's avatar
mattijs committed
582
583
584
585
586
587
588
    // Every replacement is a dictionary name and a keyword in this

    forAllConstIter(dictionary, replaceDicts, fieldIter)
    {
        const word& fieldName = fieldIter().keyword();
        Info<< "Replacing entries in dictionary " << fieldName << endl;

589
590
591
592
593
594
595
596
597
598
599
600
        // Handle 'boundary' specially:
        // - is PtrList of dictionaries
        // - is in polyMesh/
        if (fieldName == "boundary")
        {
            Info<< "Special handling of " << fieldName
                << " as polyMesh/boundary file." << endl;

            // Get the replacement dictionary for the field
            const dictionary& replaceDict = fieldIter().dict();
            Info<< "Merging entries from " << replaceDict.toc() << endl;

601
602
            // Merge the replacements in. Do not add non-existing entries.
            merge(false, fieldDict, replaceDict, literalRE, patchGroups);
603
604
605
606
607
608
609

            Info<< "fieldDict:" << fieldDict << endl;

            // Convert back into dictList
            wordList doneKeys(dictList.size());

            label nEntries = fieldDict.size();
610

611
612
613
            forAll(dictList, i)
            {
                doneKeys[i] = dictList[i].keyword();
mattijs's avatar
mattijs committed
614
615
616
617
618
619
620
621
622
623
                dictList.set
                (
                    i,
                    fieldDict.lookupEntry
                    (
                        doneKeys[i],
                        false,
                        true
                    ).clone()
                );
624
625
                fieldDict.remove(doneKeys[i]);
            }
626

627
628
629
630
631
            // Add remaining entries
            label sz = dictList.size();
            dictList.setSize(nEntries);
            forAllConstIter(dictionary, fieldDict, iter)
            {
632
                dictList.set(sz++, iter().clone());
633
634
            }

635
636
637
638
639
640
641
            Info<< "Writing modified " << fieldName << endl;
            dictList.writeObject
            (
                runTime.writeFormat(),
                runTime.writeFormat(),
                IOstream::UNCOMPRESSED
            );
642
643
644
        }
        else
        {
645
646
            // Read dictionary
            // Note: disable class type checking so we can load field
647
648
649
            Info<< "Loading dictionary " << fieldName << endl;
            const word oldTypeName = IOdictionary::typeName;
            const_cast<word&>(IOdictionary::typeName) = word::null;
650

651
            IOobject fieldHeader
652
            (
653
654
655
656
657
658
                fieldName,
                instance,
                mesh,
                IOobject::MUST_READ_IF_MODIFIED,
                IOobject::NO_WRITE,
                false
659
            );
660

661
662
663
            if (fieldHeader.typeHeaderOk<IOdictionary>(false))
            {
                IOdictionary fieldDict(fieldHeader);
664

665
                const_cast<word&>(IOdictionary::typeName) = oldTypeName;
666

667
668
669
                // Fake type back to what was in field
                const_cast<word&>(fieldDict.type()) =
                    fieldDict.headerClassName();
670

671
672
673
674
675
676
                Info<< "Loaded dictionary " << fieldName
                    << " with entries " << fieldDict.toc() << endl;

                // Get the replacement dictionary for the field
                const dictionary& replaceDict = fieldIter().dict();
                Info<< "Merging entries from " << replaceDict.toc() << endl;
677

678
679
                // Merge the replacements in (allow adding)
                merge(true, fieldDict, replaceDict, literalRE, patchGroups);
680
681
682
683
684
685

                Info<< "Writing modified fieldDict " << fieldName << endl;
                fieldDict.regIOobject::write();
            }
            else
            {
Andrew Heather's avatar
Andrew Heather committed
686
                WarningInFunction
687
688
689
                    << "Requested field to change " << fieldName
                    << " does not exist in " << fieldHeader.path() << endl;
            }
690
        }
mattijs's avatar
mattijs committed
691
692
    }

693
694
    entry::disableFunctionEntries = oldFlag;

695
    Info<< "\nEnd\n" << endl;
mattijs's avatar
mattijs committed
696
697
698
699

    return 0;
}

henry's avatar
henry committed
700

mattijs's avatar
mattijs committed
701
// ************************************************************************* //