openfoam/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C
Mark Olesen 345a2a42f1 ENH: simplify method names for reading argList options and arguments
- use succincter method names that more closely resemble dictionary
  and HashTable method names. This improves method name consistency
  between classes and also requires less typing effort:

    args.found(optName)        vs.  args.optionFound(optName)
    args.readIfPresent(..)     vs.  args.optionReadIfPresent(..)
    ...
    args.opt<scalar>(optName)  vs.  args.optionRead<scalar>(optName)
    args.read<scalar>(index)   vs.  args.argRead<scalar>(index)

- the older method names forms have been retained for code compatibility,
  but are now deprecated
2018-01-08 15:35:18 +01:00

136 lines
3.9 KiB
C

/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2013-2015 OpenFOAM Foundation
\\/ M anipulation | Copyright (C) 2016 OpenCFD Ltd.
-------------------------------------------------------------------------------
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
createExternalCoupledPatchGeometry.
Group
grpPreProcessingUtilities
Description
Application to generate the patch geometry (points and faces) for use
with the externalCoupled functionObject.
Usage
\verbatim
createExternalCoupledPatchGeometry \<patchGroup\> [OPTION]
\endverbatim
\param -commsDir \<commsDir\> \n
Specify an alternative communications directory (default is comms
in the case directory)
\param -region \<name\> \n
Specify an alternative mesh region.
\param -regions (\<name1\> \<name2\> .. \<namen\>) \n
Specify alternative mesh regions. The region names will be sorted
alphabetically and a single composite name will be created
\<nameX\>_\<nameY\>.._\<nameZ\>
On execution, the combined patch geometry (points and faces) are output
to the communications directory.
Note:
The addressing is patch-local, i.e. point indices for each patch point
used for face addressing starts at index 0.
See also
functionObjects::externalCoupled
\*---------------------------------------------------------------------------*/
#include "fvCFD.H"
#include "externalCoupled.H"
#include "IOobjectList.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
int main(int argc, char *argv[])
{
#include "addRegionOption.H"
#include "addRegionsOption.H"
argList::addArgument("patchGroup");
argList::addOption
(
"commsDir",
"dir",
"specify alternate communications directory. default is 'comms'"
);
#include "setRootCase.H"
#include "createTime.H"
wordList regionNames(1, fvMesh::defaultRegion);
if (!args.readIfPresent("region", regionNames[0]))
{
args.readIfPresent("regions", regionNames);
}
const wordRe patchGroup(args.read<wordRe>(1));
fileName commsDir(runTime.path()/"comms");
args.readIfPresent("commsDir", commsDir);
// Make sure region names are in canonical order
stableSort(regionNames);
PtrList<const fvMesh> meshes(regionNames.size());
forAll(regionNames, i)
{
Info<< "Create mesh " << regionNames[i] << " for time = "
<< runTime.timeName() << nl << endl;
meshes.set
(
i,
new fvMesh
(
Foam::IOobject
(
regionNames[i],
runTime.timeName(),
runTime,
Foam::IOobject::MUST_READ
)
)
);
}
functionObjects::externalCoupled::writeGeometry
(
UPtrList<const fvMesh>(meshes),
commsDir,
patchGroup
);
Info<< "\nEnd\n" << endl;
return 0;
}
// ************************************************************************* //