/*---------------------------------------------------------------------------*\ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org \\ / A nd | Copyright (C) 2011-2022 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 . Application decomposePar Description Automatically decomposes a mesh and fields of a case for parallel execution of OpenFOAM. Usage \b decomposePar [OPTION] Options: - \par -cellDist Write the cell distribution as a labelList, for use with 'manual' decomposition method or as a volScalarField for post-processing. - \par -region \ \n Decompose named region. Does not check for existence of processor*. - \par -allRegions \n Decompose all regions in regionProperties. 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 - \par -time xxx:yyy \n Override controlDict settings and decompose selected times. Does not re-decompose the mesh i.e. does not handle moving mesh or changing mesh cases. - \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. - \par -ifRequired \n Only decompose the geometry if the number of domains has changed from a previous decomposition. No \a processor subdirectories will be removed unless the \a -force option is also specified. This option can be used to avoid redundant geometry decomposition (eg, in scripts), but should be used with caution when the underlying (serial) geometry or the decomposition method etc. have been changed between decompositions. - \par -dict \ Specify alternative dictionary for the decomposition. \*---------------------------------------------------------------------------*/ #include "domainDecomposition.H" #include "decompositionMethod.H" #include "argList.H" #include "timeSelector.H" #include "regionProperties.H" #include "labelIOField.H" #include "labelFieldIOField.H" #include "scalarIOField.H" #include "scalarFieldIOField.H" #include "vectorIOField.H" #include "vectorFieldIOField.H" #include "sphericalTensorIOField.H" #include "sphericalTensorFieldIOField.H" #include "symmTensorIOField.H" #include "symmTensorFieldIOField.H" #include "tensorIOField.H" #include "tensorFieldIOField.H" #include "readFields.H" #include "dimFieldDecomposer.H" #include "fvFieldDecomposer.H" #include "pointFieldDecomposer.H" #include "lagrangianFieldDecomposer.H" using namespace Foam; // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // namespace Foam { void decomposeUniform ( const bool copyUniform, const domainDecomposition& decomposition, const Time& processorDb, const word& regionDir = word::null ) { const Time& runTime = decomposition.mesh().time(); // Any uniform data to copy/link? const fileName uniformDir(regionDir/"uniform"); if (fileHandler().isDir(runTime.timePath()/uniformDir)) { Info<< "Detected additional non-decomposed files in " << runTime.timePath()/uniformDir << endl; const fileName timePath = fileHandler().filePath(processorDb.timePath()); if (copyUniform || decomposition.distributed()) { if (!fileHandler().exists(timePath/uniformDir)) { fileHandler().cp ( runTime.timePath()/uniformDir, timePath/uniformDir ); } } else { // link with relative paths string parentPath = string("..")/".."; if (regionDir != word::null) { parentPath = parentPath/".."; } fileName currentDir(cwd()); chDir(timePath); if (!fileHandler().exists(uniformDir)) { fileHandler().ln ( parentPath/runTime.timeName()/uniformDir, uniformDir ); } chDir(currentDir); } } } void writeDecomposition(const domainDecomposition& decomposition) { const labelList& procIds = decomposition.cellToProc(); // Write the decomposition as labelList for use with 'manual' // decomposition method. labelIOList cellDecomposition ( IOobject ( "cellDecomposition", decomposition.mesh().facesInstance(), decomposition.mesh(), IOobject::NO_READ, IOobject::NO_WRITE, false ), procIds ); cellDecomposition.write(); Info<< nl << "Wrote decomposition to " << cellDecomposition.relativeObjectPath() << " for use in manual decomposition." << endl; // Write as volScalarField for postprocessing. volScalarField::Internal cellDist ( IOobject ( "cellDist", decomposition.mesh().time().timeName(), decomposition.mesh(), IOobject::NO_READ, IOobject::AUTO_WRITE ), decomposition.mesh(), dimless, scalarField(scalarList(procIds)) ); cellDist.write(); Info<< nl << "Wrote decomposition as volScalarField to " << cellDist.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 "addDictOption.H" #include "addRegionOption.H" #include "addAllRegionsOption.H" argList::addBoolOption ( "cellDist", "write cell distribution as a labelList - for use with 'manual' " "decomposition method or as a volScalarField 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" ); argList::addBoolOption ( "ifRequired", "only decompose geometry if the number of domains has changed" ); // Include explicit constant options, have zero from time range timeSelector::addOptions(true, false); #include "setRootCase.H" bool region = args.optionFound("region"); bool writeCellDist = args.optionFound("cellDist"); bool copyZero = args.optionFound("copyZero"); bool copyUniform = args.optionFound("copyUniform"); bool decomposeFieldsOnly = args.optionFound("fields"); bool decomposeGeomOnly = args.optionFound("noFields"); bool decomposeSets = !args.optionFound("noSets"); bool forceOverwrite = args.optionFound("force"); bool ifRequiredDecomposition = args.optionFound("ifRequired"); if (decomposeGeomOnly) { Info<< "Skipping decomposing fields" << nl << endl; if (decomposeFieldsOnly || copyZero) { FatalErrorInFunction << "Cannot combine geometry-only decomposition (-noFields)" << " with field decomposition (-noFields or -copyZero)" << exit(FatalError); } } // Set time from database #include "createTime.H" // Allow override of time instantList times = timeSelector::selectIfPresent(runTime, args); // Get region names const wordList regionNames(selectRegionNames(args, runTime)); // Handle existing decomposition directories { // Determine the processor count from the directories label nProcs = fileHandler().nProcs(runTime.path()); if (forceOverwrite) { if (region) { FatalErrorInFunction << "Cannot force the decomposition of a single region" << exit(FatalError); } Info<< "Removing " << nProcs << " existing processor directories" << endl; // Remove existing processors directory fileNameList dirs ( fileHandler().readDir ( runTime.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); } } } } } else if (nProcs && !region && !decomposeFieldsOnly) { FatalErrorInFunction << "Case is already decomposed with " << nProcs << " domains, use the -force option or manually" << nl << "remove processor directories before decomposing. e.g.," << nl << " rm -rf " << runTime.path().c_str() << "/processor*" << nl << exit(FatalError); } } // Decompose all regions forAll(regionNames, regioni) { const word& regionName = regionNames[regioni]; const word& regionDir = Foam::regionDir(regionName); Info<< "\n\nDecomposing mesh " << regionName << nl << endl; // Determine the existing processor count directly label nProcs = fileHandler().nProcs(runTime.path(), regionDir); // Get requested numberOfSubdomains const label nDomains = decompositionMethod::decomposeParDict(runTime) .lookup