openfoam/applications/utilities/surface/surfaceMeshInfo/surfaceMeshInfo.C
Mark Olesen b060378dca ENH: improve consistency of fileName handling windows/non-windows (#2057)
- wrap command-line retrieval of fileName with an implicit validate.

  Instead of this:
      fileName input(args[1]);
      fileName other(args["someopt"]);

  Now use this:
      auto input = args.get<fileName>(1);
      auto other = args.get<fileName>("someopt");

  which adds a fileName::validate on the inputs

  Because of how it is implemented, it will automatically also apply
  to argList getOrDefault<fileName>, readIfPresent<fileName> etc.

- adjust fileName::validate and clean to handle backslash conversion.
  This makes it easier to ensure that path names arising from MS-Windows
  are consistently handled internally.

- dictionarySearch: now check for initial '/' directly instead of
  relying on fileName isAbsolute(), which now does more things

BREAKING: remove fileName::clean() const method

- relying on const/non-const to control the behaviour (inplace change
  or return a copy) is too fragile and the const version was
  almost never used.

  Replace:
      fileName sanitized = constPath.clean();

  With:
      fileName sanitized(constPath);
      sanitized.clean());

STYLE: test empty() instead of comparing with fileName::null
2021-04-19 16:33:42 +00:00

187 lines
4.8 KiB
C

/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | www.openfoam.com
\\/ M anipulation |
-------------------------------------------------------------------------------
Copyright (C) 2011-2016 OpenFOAM Foundation
Copyright (C) 2016-2021 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
surfaceMeshInfo
Group
grpSurfaceUtilities
Description
Miscellaneous information about surface meshes.
To simplify parsing of the output, the normal banner information
is suppressed.
Usage
\b surfaceMeshInfo surfaceFile [OPTION]
Options:
- \par -areas
Report area for each face.
- \par -scale \<scale\>
Specify a scaling factor when reading files.
- \par -xml
Write output in XML format.
Note
The filename extensions are used to determine the file format type.
The XML-like output can be useful for extraction with other tools,
but either output format can be easily extracted with a simple sed
command:
\verbatim
surfaceMeshInfo surfaceFile -areas | \
sed -ne '/areas/,/:/{ /:/!p }'
surfaceMeshInfo surfaceFile -areas -xml | \
sed -ne '/<areas/,/</{ /</!p }'
\endverbatim
\*---------------------------------------------------------------------------*/
#include "argList.H"
#include "profiling.H"
#include "Time.H"
#include "UnsortedMeshedSurfaces.H"
using namespace Foam;
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
int main(int argc, char *argv[])
{
argList::addNote
(
"Information about surface meshes"
);
argList::noBanner();
argList::noParallel();
argList::addArgument("surface", "The input surface file");
argList::addOption
(
"scale",
"factor",
"Input geometry scaling factor"
);
argList::addBoolOption
(
"areas",
"Display area of each face"
);
argList::addBoolOption
(
"xml",
"Write output in XML format"
);
profiling::disable(); // Disable profiling (and its output)
argList args(argc, argv);
Time runTime(args.rootPath(), args.caseName());
const auto importName = args.get<fileName>(1);
// check that reading is supported
if (!UnsortedMeshedSurface<face>::canRead(importName, true))
{
return 1;
}
const bool writeXML = args.found("xml");
const bool writeAreas = args.found("areas");
// use UnsortedMeshedSurface, not MeshedSurface to maintain ordering
UnsortedMeshedSurface<face> surf(importName);
const scalar scaling = args.getOrDefault<scalar>("scale", -1);
if (scaling > 0)
{
DetailInfo << " -scale " << scaling << nl;
surf.scalePoints(scaling);
}
scalar areaTotal = 0;
if (writeXML)
{
Info<<"<?xml version='1.0' encoding='utf-8'?>" << nl
<<"<surfaceMeshInfo>" << nl
<< "<npoints>" << surf.nPoints() << "</npoints>" << nl
<< "<nfaces>" << surf.size() << "</nfaces>" << nl;
if (writeAreas)
{
Info<<"<areas size='" << surf.size() << "'>" << nl;
}
}
else
{
Info<< "nPoints : " << surf.nPoints() << nl
<< "nFaces : " << surf.size() << nl;
if (writeAreas)
{
Info<< "areas : " << nl;
}
}
forAll(surf, facei)
{
const scalar fArea(surf[facei].mag(surf.points()));
areaTotal += fArea;
if (writeAreas)
{
Info<< fArea << nl;
}
}
if (writeXML)
{
if (writeAreas)
{
Info<<"</areas>" << nl;
}
Info<< "<area>" << areaTotal << "</area>" << nl
<< "</surfaceMeshInfo>" << nl;
}
else
{
Info<< "area : " << areaTotal << nl;
}
return 0;
}
// ************************************************************************* //