File size: 27,247 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 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 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 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 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 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 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-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/>.
Application
decomposePar
Description
Automatically decomposes a mesh and fields of a case for parallel
execution of OpenFOAM.
Usage
\b decomposePar [OPTION]
Options:
- \par -cellProc
Write cell processor indices as a volInternalScalarField for
post-processing.
- \par -region \<regionName\> \n
Decompose named region. Does not check for existence of processor*.
- \par -allRegions \n
Decompose all regions in regionSolvers. Does not check for
existence of processor*.
- \par -copyZero \n
Copy \a 0 directory to processor* rather than decompose the fields.
- \par -copyUniform \n
Copy any \a uniform directories too.
- \par -constant
Decompose mesh and fields in the constant directory.
- \par -time xxx:yyy \n
Override controlDict settings and decompose selected times.
- \par -fields \n
Use existing geometry decomposition and convert fields only.
- \par -noSets \n
Skip decomposing cellSets, faceSets, pointSets.
- \par -force \n
Remove any existing \a processor subdirectories before decomposing the
geometry.
\*---------------------------------------------------------------------------*/
#include "argList.H"
#include "timeSelector.H"
#include "IOobjectList.H"
#include "processorRunTimes.H"
#include "multiDomainDecomposition.H"
#include "decompositionMethod.H"
#include "fvFieldDecomposer.H"
#include "pointFieldDecomposer.H"
#include "lagrangianFieldDecomposer.H"
#include "LagrangianFieldDecomposer.H"
#include "delayedNewLine.H"
using namespace Foam;
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
bool haveUniform
(
const processorRunTimes& runTimes,
const word& regionDir = word::null
)
{
return
fileHandler().isDir
(
runTimes.completeTime().timePath()/regionDir/"uniform"
);
}
void decomposeUniform
(
const bool copyUniform,
const processorRunTimes& runTimes,
const word& regionDir = word::null
)
{
const fileName uniformDir(regionDir/"uniform");
forAll(runTimes.procTimes(), proci)
{
const fileName procTimePath =
fileHandler().filePath(runTimes.procTimes()[proci].timePath());
if (!fileHandler().isDir(procTimePath))
{
fileHandler().mkDir(procTimePath);
}
if (copyUniform)
{
if (!fileHandler().exists(procTimePath/uniformDir))
{
fileHandler().cp
(
runTimes.completeTime().timePath()/uniformDir,
procTimePath/uniformDir
);
}
}
else
{
// Link with relative paths
string parentPath = string("..")/"..";
if (regionDir != word::null)
{
parentPath = parentPath/"..";
}
fileName currentDir(cwd());
chDir(procTimePath);
if (!fileHandler().exists(uniformDir))
{
fileHandler().ln
(
parentPath/runTimes.completeTime().name()/uniformDir,
uniformDir
);
}
chDir(currentDir);
}
}
}
void writeDecomposition(const domainDecomposition& meshes)
{
// Write as volInternalScalarField for postprocessing.
volInternalScalarField cellProc
(
IOobject
(
"cellProc",
meshes.completeMesh().time().name(),
meshes.completeMesh(),
IOobject::NO_READ,
IOobject::AUTO_WRITE
),
meshes.completeMesh(),
dimless,
scalarField(scalarList(meshes.cellProc()))
);
cellProc.write();
Info<< "Wrote decomposition as volInternalScalarField to "
<< cellProc.name() << " for use in postprocessing"
<< endl;
}
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
int main(int argc, char *argv[])
{
argList::addNote
(
"decompose a mesh and fields of a case for parallel execution"
);
argList::noParallel();
#include "addMeshOption.H"
#include "addRegionOption.H"
#include "addAllRegionsOption.H"
argList::addBoolOption
(
"cellProc",
"write cell processor indices as a volInternalScalarField for "
"post-processing"
);
argList::addBoolOption
(
"copyZero",
"Copy \a 0 directory to processor* rather than decompose the fields"
);
argList::addBoolOption
(
"copyUniform",
"copy any uniform/ directories too"
);
argList::addBoolOption
(
"fields",
"use existing geometry decomposition and convert fields only"
);
argList::addBoolOption
(
"noFields",
"opposite of -fields; only decompose geometry"
);
argList::addBoolOption
(
"noSets",
"skip decomposing cellSets, faceSets, pointSets"
);
argList::addBoolOption
(
"force",
"remove existing processor*/ subdirs before decomposing the geometry"
);
// Include explicit constant option, execute from zero by default
timeSelector::addOptions(true, false);
#include "setRootCase.H"
#include "setMeshPath.H"
const bool region = args.optionFound("region");
const bool writeCellProc = args.optionFound("cellProc");
const bool copyZero = args.optionFound("copyZero");
const bool copyUniform = args.optionFound("copyUniform");
const bool decomposeFieldsOnly = args.optionFound("fields");
const bool decomposeGeomOnly = args.optionFound("noFields");
const bool decomposeSets = !args.optionFound("noSets");
const bool forceOverwrite = args.optionFound("force");
if (decomposeGeomOnly)
{
Info<< nl << "Skipping decomposing fields" << endl;
if (decomposeFieldsOnly || copyZero)
{
FatalErrorInFunction
<< "Cannot combine geometry-only decomposition (-noFields)"
<< " with field decomposition (-fields or -copyZero)"
<< exit(FatalError);
}
}
// Set time from database
Info<< nl << "Create time" << endl;
processorRunTimes runTimes(Foam::Time::controlDictName, args);
const Time& runTime = runTimes.completeTime();
// Allow override of time
const instantList times = runTimes.selectComplete(args);
#include "setRegionNames.H"
// Remove existing processor directories if requested
if (forceOverwrite)
{
if (region)
{
FatalErrorInFunction
<< "Cannot force the decomposition of a single region"
<< exit(FatalError);
}
const label nProcs0 =
fileHandler().nProcs(runTimes.completeTime().path());
Info<< nl << "Removing " << nProcs0
<< " existing processor directories" << endl;
// Remove existing processor directories
const fileNameList dirs
(
fileHandler().readDir
(
runTimes.completeTime().path(),
fileType::directory
)
);
forAllReverse(dirs, diri)
{
const fileName& d = dirs[diri];
// Starts with 'processors'
if (d.find("processors") == 0)
{
if (fileHandler().exists(d))
{
fileHandler().rmDir(d);
}
}
// Starts with 'processor'
if (d.find("processor") == 0)
{
// Check that integer after processor
fileName num(d.substr(9));
label proci = -1;
if (Foam::read(num.c_str(), proci))
{
if (fileHandler().exists(d))
{
fileHandler().rmDir(d);
}
}
}
}
// Flush file handler to clear any detected processor directories
fileHandler().flush();
}
// Check the specified number of processes is consistent with any existing
// processor directories
{
const label nProcs0 =
fileHandler().nProcs(runTimes.completeTime().path());
if (nProcs0 && nProcs0 != runTimes.nProcs())
{
FatalErrorInFunction
<< "Case is already decomposed with " << nProcs0
<< " domains, use the -force option or manually" << nl
<< "remove processor directories before decomposing. e.g.,"
<< nl
<< " rm -rf " << runTimes.completeTime().path().c_str()
<< "/processor*"
<< nl
<< exit(FatalError);
}
}
// Get the decomposition dictionary
const dictionary decomposeParDict =
decompositionMethod::decomposeParDict(runTimes.completeTime());
// Check existing decomposition
forAll(regionNames, regioni)
{
const word& regionName = regionNames[regioni];
const word regionDir =
regionName == polyMesh::defaultRegion ? word::null : regionName;
// Determine the existing processor count directly
const label nProcs =
fileHandler().nProcs(runTimes.completeTime().path(), regionDir);
// Get requested numberOfSubdomains
const label nDomains =
decomposeParDict.lookup<label>("numberOfSubdomains");
// Give file handler a chance to determine the output directory
const_cast<fileOperation&>(fileHandler()).setNProcs(nDomains);
// Sanity check number of processors in a previously decomposed case
if (decomposeFieldsOnly && nProcs != nDomains)
{
FatalErrorInFunction
<< "Specified -fields, but the case was decomposed with "
<< nProcs << " domains" << nl << "instead of " << nDomains
<< " domains as specified in decomposeParDict" << nl
<< exit(FatalError);
}
}
// Create meshes
multiDomainDecomposition regionMeshes(runTimes, meshPath, regionNames);
if
(
!(decomposeFieldsOnly && copyZero)
&& regionMeshes.readDecompose(decomposeSets)
)
{
if (writeCellProc)
{
forAll(regionNames, regioni)
{
Info<< endl;
writeDecomposition(regionMeshes[regioni]());
fileHandler().flush();
}
}
}
// Get flag to determine whether or not to distribute uniform data
const bool distributed =
decomposeParDict.lookupOrDefault<bool>("distributed", false);
// Loop over all times
forAll(times, timei)
{
// Set the time
runTimes.setTime(times[timei], timei);
Info<< nl << "Time = " << runTimes.completeTime().userTimeName()
<< endl;
// Update the meshes, if necessary
const fvMesh::readUpdateState stat =
!(decomposeFieldsOnly && copyZero)
? regionMeshes.readUpdateDecompose()
: fvMesh::UNCHANGED;
// Write the mesh out (if anything has changed), if necessary
if (!decomposeFieldsOnly)
{
regionMeshes.writeProcs(decomposeSets);
}
// Write the decomposition, if necessary
forAll(regionNames, regioni)
{
if (writeCellProc && stat >= fvMesh::TOPO_CHANGE)
{
Info<< endl;
writeDecomposition(regionMeshes[regioni]());
fileHandler().flush();
}
}
// If only decomposing geometry then there is no more to do
if (decomposeGeomOnly)
{
continue;
}
// If copying from zero then just copy everything from the <time>
// directory to the processor*/<time> directories without altering them
if (copyZero)
{
const fileName completeTimePath =
runTimes.completeTime().timePath();
Info<< endl;
fileName prevProcTimePath;
for (label proci = 0; proci < runTimes.nProcs(); proci++)
{
const Time& procRunTime = runTimes.procTimes()[proci];
if (fileHandler().isDir(completeTimePath))
{
const fileName procTimePath
(
fileHandler().objectPath
(
IOobject(word::null, fileName::null, procRunTime)
)
);
if (procTimePath != prevProcTimePath)
{
Info<< "Processor " << proci
<< ": copying " << completeTimePath << nl
<< " to " << procTimePath << endl;
fileHandler().cp(completeTimePath, procTimePath);
prevProcTimePath = procTimePath;
}
}
}
continue;
}
// Otherwise we are doing full region-by-region decomposition of all
// the available fields
forAll(regionNames, regioni)
{
const word& regionName = regionNames[regioni];
const word regionDir =
regionName == polyMesh::defaultRegion ? word::null : regionName;
Info<< endl;
const delayedNewLine dnl;
const RegionRef<domainDecomposition> meshes =
regionMeshes[regioni];
// Search for objects at this time
IOobjectList objects
(
meshes().completeMesh(),
runTimes.completeTime().name()
);
{
Info<< dnl << "Decomposing FV fields" << endl;
if (fvFieldDecomposer::decomposes(objects))
{
fvFieldDecomposer fvDecomposer
(
meshes().completeMesh(),
meshes().procMeshes(),
meshes().procFaceAddressing(),
meshes().procCellAddressing(),
meshes().procFaceAddressingBf()
);
#define DO_FV_VOL_INTERNAL_FIELDS_TYPE(Type, nullArg) \
fvDecomposer.decomposeVolInternalFields<Type> \
(objects);
FOR_ALL_FIELD_TYPES(DO_FV_VOL_INTERNAL_FIELDS_TYPE)
#undef DO_FV_VOL_INTERNAL_FIELDS_TYPE
#define DO_FV_VOL_FIELDS_TYPE(Type, nullArg) \
fvDecomposer.decomposeVolFields<Type> \
(objects);
FOR_ALL_FIELD_TYPES(DO_FV_VOL_FIELDS_TYPE)
#undef DO_FV_VOL_FIELDS_TYPE
#define DO_FV_SURFACE_FIELDS_TYPE(Type, nullArg) \
fvDecomposer.decomposeFvSurfaceFields<Type> \
(objects);
FOR_ALL_FIELD_TYPES(DO_FV_SURFACE_FIELDS_TYPE)
#undef DO_FV_SURFACE_FIELDS_TYPE
}
else
{
Info<< dnl << " (no FV fields)" << endl;
}
}
{
Info<< dnl << "Decomposing point fields" << endl;
if (pointFieldDecomposer::decomposes(objects))
{
pointFieldDecomposer pointDecomposer
(
pointMesh::New(meshes().completeMesh()),
meshes().procMeshes(),
meshes().procPointAddressing()
);
#define DO_POINT_FIELDS_TYPE(Type, nullArg) \
pointDecomposer.decomposeFields<Type> \
(objects);
FOR_ALL_FIELD_TYPES(DO_POINT_FIELDS_TYPE)
#undef DO_POINT_FIELDS_TYPE
}
else
{
Info<< dnl << " (no point fields)" << endl;
}
}
{
// Find cloud directories
fileNameList cloudDirs
(
fileHandler().readDir
(
runTimes.completeTime().timePath()
/regionDir
/lagrangian::cloud::prefix,
fileType::directory
)
);
// Add objects in any found cloud directories
HashTable<IOobjectList> cloudsObjects;
forAll(cloudDirs, i)
{
// Do local scan for valid cloud objects
IOobjectList cloudObjs
(
meshes().completeMesh(),
runTimes.completeTime().name(),
lagrangian::cloud::prefix/cloudDirs[i],
IOobject::MUST_READ,
IOobject::NO_WRITE,
false
);
// If "positions" is present, then add to the table
if (cloudObjs.lookup(word("positions")))
{
cloudsObjects.insert(cloudDirs[i], cloudObjs);
}
}
// Decompose the objects found above
if (cloudsObjects.size())
{
forAllConstIter
(
HashTable<IOobjectList>,
cloudsObjects,
iter
)
{
const word cloudName =
string::validate<word>(iter.key());
const IOobjectList& cloudObjects = iter();
Info<< dnl << "Decomposing lagrangian fields for "
<< "cloud " << cloudName << endl;
if
(
lagrangianFieldDecomposer::decomposes
(
cloudObjects
)
)
{
const lagrangianFieldDecomposer
lagrangianDecomposer
(
meshes().completeMesh(),
meshes().procMeshes(),
meshes().procFaceAddressing(),
meshes().procCellAddressing(),
cloudName
);
lagrangianDecomposer.decomposePositions();
#define DO_CLOUD_FIELDS_TYPE(Type, nullArg) \
lagrangianDecomposer.decomposeFields<Type> \
(cloudObjects);
DO_CLOUD_FIELDS_TYPE(label, )
FOR_ALL_FIELD_TYPES(DO_CLOUD_FIELDS_TYPE)
#undef DO_CLOUD_FIELDS_TYPE
}
else
{
Info<< dnl << " (no lagrangian fields)"
<< endl;
}
}
}
}
{
// Find Lagrangian directories
fileNameList LagrangianDirs
(
fileHandler().readDir
(
runTimes.completeTime().timePath()
/regionDir
/LagrangianMesh::prefix,
fileType::directory
)
);
// Add objects in any found Lagrangian directories
HashTable<IOobjectList> LagrangianObjects;
forAll(LagrangianDirs, i)
{
// Do local scan for valid Lagrangian objects
IOobjectList objects
(
meshes().completeMesh(),
runTimes.completeTime().name(),
LagrangianMesh::prefix/LagrangianDirs[i],
IOobject::MUST_READ,
IOobject::NO_WRITE,
false
);
// If coordinates or fields are present then add
// this set of objects to the table
if
(
objects.found(LagrangianMesh::coordinatesName)
|| LagrangianFieldDecomposer::decomposes
(
objects
)
)
{
LagrangianObjects.insert
(
LagrangianDirs[i],
objects
);
}
}
// Decompose the objects found above
if (LagrangianObjects.size())
{
forAllConstIter
(
HashTable<IOobjectList>,
LagrangianObjects,
iter
)
{
const word LagrangianName =
string::validate<word>(iter.key());
Info<< dnl << "Decomposing Lagrangian fields "
<< "for " << LagrangianName << endl;
const LagrangianFieldDecomposer
LagrangianDecomposer
(
meshes().completeMesh(),
meshes().procMeshes(),
meshes().procFaceAddressing(),
meshes().procCellAddressing(),
LagrangianName
);
LagrangianDecomposer.decomposePositions();
if
(
LagrangianFieldDecomposer::decomposes
(
iter()
)
)
{
#define DO_LAGRANGIAN_FIELDS_TYPE( \
Type, GeoField) \
LagrangianDecomposer \
.decomposeFields<GeoField<Type>> \
(iter());
DO_LAGRANGIAN_FIELDS_TYPE
(
label,
LagrangianField
)
FOR_ALL_FIELD_TYPES
(
DO_LAGRANGIAN_FIELDS_TYPE,
LagrangianField
)
DO_LAGRANGIAN_FIELDS_TYPE
(
label,
LagrangianInternalField
)
FOR_ALL_FIELD_TYPES
(
DO_LAGRANGIAN_FIELDS_TYPE,
LagrangianInternalField
)
#undef DO_LAGRANGIAN_FIELDS_TYPE
// --> Note we don't have to explicitly
// decompose the dynamic variants of these
// fields as they are IO compatible with the
// non-dynamic fields
}
else
{
Info<< dnl << " (no lagrangian fields)"
<< endl;
}
}
}
}
}
// Distribute the uniform directory
if (haveUniform(runTimes))
{
Info<< nl << "Distributing uniform files" << endl;
decomposeUniform
(
copyUniform || distributed,
runTimes
);
}
if (regionNames == wordList(1, polyMesh::defaultRegion)) continue;
// Distribute the region uniform directories
forAll(regionNames, regioni)
{
const word& regionName = regionNames[regioni];
const word regionDir =
regionName == polyMesh::defaultRegion ? word::null : regionName;
if (haveUniform(runTimes, regionDir))
{
Info<< nl;
const RegionRef<domainDecomposition> meshes =
regionMeshes[regioni];
Info<< "Distributing uniform files" << endl;
decomposeUniform
(
copyUniform || distributed,
runTimes,
regionDir
);
}
}
}
Info<< "End" << nl << endl;
return 0;
}
// ************************************************************************* //
|