a97628121c
- includes restructuring and simplification of low-level ensight part
handling and refactor of backends to improve code reuse.
foamToEnsight
-------------
* new cellZone support.
This was previously only possible via a separate foamToEnsightParts
utility that was not parallelized.
* support for point fields.
* `-nearCellValue` option (as per foamToVTK)
* data indexing now uses values from the time index.
This is consistent with the ensightWrite function object and
can help with restarts.
* existing ensight directories are removed, unless the -no-overwrite
option is supplied
foamToEnsightParts
------------------
* now redundant and removed.
ensightOutputSurface (new class)
--------------------------------
* a lightweight wrapper for point/face references that is tailored
for the ensightSurfaceWriter. It uses compact face/point information
and is serial only, since this is the format requirements from the
surfaceWriter class.
ensightMesh (revised class)
---------------------------
* now only holds a polyMesh reference, which removes its dependency
on finiteVolume and allows it to be relocated under fileFormats
instead of conversion.
Removed classes: ensightParts, ensighPartFaces, ensightPartCells
- these were used by foamToEnsightParts, but not needed anymore.
531 lines
14 KiB
C
531 lines
14 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-2020 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
|
|
foamToEnsight
|
|
|
|
Group
|
|
grpPostProcessingUtilitie
|
|
|
|
Description
|
|
Translate OpenFOAM data to EnSight format.
|
|
An Ensight part is created for cellZones (unzoned cells are "internalMesh")
|
|
and patches.
|
|
|
|
- Handles volume fields, dimensioned fields, point fields
|
|
- Handles mesh topology changes.
|
|
|
|
Usage
|
|
\b foamToEnsight [OPTION]
|
|
|
|
Options:
|
|
- \par -ascii
|
|
Write Ensight data in ASCII format instead of "C Binary"
|
|
|
|
- \par -fields \<fields\>
|
|
Specify single or multiple fields to write (all by default)
|
|
For example,
|
|
\verbatim
|
|
-fields T
|
|
-fields '(p T U \"alpha.*\")'
|
|
\endverbatim
|
|
The quoting is required to avoid shell expansions and to pass the
|
|
information as a single argument.
|
|
|
|
- \par -nearCellValue
|
|
Use zero-gradient cell values on patches
|
|
|
|
- \par -nodeValues
|
|
Force interpolation of values to nodes
|
|
|
|
- \par -no-boundary
|
|
Suppress output for all boundary patches
|
|
|
|
- \par -no-internal
|
|
Suppress output for internal (volume) mesh
|
|
|
|
- \par -no-cellZones
|
|
Suppress cellZone handling
|
|
|
|
- \par -no-lagrangian
|
|
Suppress writing lagrangian positions and fields.
|
|
|
|
- \par -no-mesh
|
|
Suppress writing the geometry. Can be useful for converting partial
|
|
results for a static geometry.
|
|
|
|
- \par -no-point-data
|
|
Suppress conversion of pointFields. No interpolated PointData.
|
|
|
|
- \par -noZero
|
|
Exclude the often incomplete initial conditions.
|
|
|
|
- \par -index \<start\>
|
|
Use consecutive indexing for \c data/######## files with the
|
|
specified start index.
|
|
Ignore the time index contained in the uniform/time file.
|
|
|
|
- \par -name \<subdir\>
|
|
Define sub-directory name to use for Ensight data (default: "EnSight")
|
|
|
|
- \par -width \<n\>
|
|
Width of Ensight data subdir (default: 8)
|
|
|
|
- \par -cellZones NAME | LIST
|
|
Specify single zone or multiple cell zones (name or regex) to write
|
|
|
|
- \par -faceZones NAME | LIST
|
|
Specify single zone or multiple face zones (name or regex) to write
|
|
|
|
- \par -patches NAME | LIST
|
|
Specify single patch or multiple patches (name or regex) to write
|
|
For example,
|
|
\verbatim
|
|
-patches top
|
|
-patches '( front \".*back\" )'
|
|
\endverbatim
|
|
|
|
- \par -excludePatches NAME | LIST
|
|
Specify single or multiple patches (name or regex) not to convert.
|
|
For example,
|
|
\verbatim
|
|
-excludePatches '( inlet_1 inlet_2 "proc.*" )'
|
|
\endverbatim
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#include "argList.H"
|
|
#include "timeSelector.H"
|
|
#include "IOobjectList.H"
|
|
#include "IOmanip.H"
|
|
#include "OFstream.H"
|
|
#include "PstreamCombineReduceOps.H"
|
|
#include "HashOps.H"
|
|
|
|
#include "fvc.H"
|
|
#include "fvMesh.H"
|
|
#include "fieldTypes.H"
|
|
#include "volFields.H"
|
|
#include "scalarIOField.H"
|
|
#include "vectorIOField.H"
|
|
|
|
// file-format/conversion
|
|
#include "ensightCase.H"
|
|
#include "ensightGeoFile.H"
|
|
#include "ensightMesh.H"
|
|
#include "ensightOutputCloud.H"
|
|
#include "ensightOutputVolField.H"
|
|
|
|
// local files
|
|
#include "readFields.H"
|
|
#include "writeVolFields.H"
|
|
#include "writeDimFields.H"
|
|
#include "writePointFields.H"
|
|
|
|
#include "memInfo.H"
|
|
|
|
#undef foamToEnsight_useTimeIndex
|
|
|
|
using namespace Foam;
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
int main(int argc, char *argv[])
|
|
{
|
|
argList::addNote
|
|
(
|
|
"Translate OpenFOAM data to Ensight format with individual parts"
|
|
" for cellZones, unzoned cells and patches"
|
|
);
|
|
timeSelector::addOptions();
|
|
|
|
// Less frequently used - reduce some clutter
|
|
argList::setAdvanced("decomposeParDict");
|
|
argList::setAdvanced("noFunctionObjects");
|
|
|
|
#include "addRegionOption.H"
|
|
|
|
argList::addBoolOption
|
|
(
|
|
"ascii",
|
|
"Write in ASCII format instead of 'C Binary'"
|
|
);
|
|
argList::addOption
|
|
(
|
|
"index",
|
|
"start",
|
|
"Starting index for consecutive number of Ensight data/ files."
|
|
" Ignore the time index contained in the uniform/time file."
|
|
, true // mark as an advanced option
|
|
);
|
|
argList::addOption
|
|
(
|
|
"name",
|
|
"subdir",
|
|
"Sub-directory name for Ensight output (default: 'EnSight')"
|
|
);
|
|
argList::addBoolOption
|
|
(
|
|
"no-overwrite",
|
|
"Suppress removal of existing EnSight output directory"
|
|
);
|
|
argList::addOption
|
|
(
|
|
"width",
|
|
"n",
|
|
"Width of Ensight data subdir"
|
|
);
|
|
argList::addBoolOption
|
|
(
|
|
"nearCellValue",
|
|
"Use zero-gradient cell values on patches"
|
|
, true // mark as an advanced option
|
|
);
|
|
argList::addBoolOption
|
|
(
|
|
"nodeValues",
|
|
"Force interpolation of values to nodes"
|
|
, true // mark as an advanced option
|
|
);
|
|
argList::addBoolOption
|
|
(
|
|
"no-boundary", // noPatches
|
|
"Suppress writing any patches"
|
|
);
|
|
argList::addOptionCompat("no-boundary", {"noPatches", 1806});
|
|
|
|
argList::addBoolOption
|
|
(
|
|
"no-internal",
|
|
"Suppress writing the internal mesh"
|
|
);
|
|
argList::addBoolOption
|
|
(
|
|
"no-cellZones",
|
|
"Suppress writing any cellZones"
|
|
);
|
|
argList::addBoolOption
|
|
(
|
|
"no-lagrangian", // noLagrangian
|
|
"Suppress writing lagrangian positions and fields"
|
|
);
|
|
argList::addOptionCompat("no-lagrangian", {"noLagrangian", 1806});
|
|
|
|
argList::addBoolOption
|
|
(
|
|
"no-point-data",
|
|
"Suppress conversion of pointFields and disables -nodeValues"
|
|
);
|
|
argList::addBoolOption
|
|
(
|
|
"no-mesh", // noMesh
|
|
"Suppress writing the geometry."
|
|
" Can be useful for converting partial results for a static geometry"
|
|
, true // mark as an advanced option
|
|
);
|
|
|
|
// Future?
|
|
// argList::addBoolOption
|
|
// (
|
|
// "one-boundary", // allPatches
|
|
// "Combine all patches into a single part"
|
|
// );
|
|
|
|
argList::addOption
|
|
(
|
|
"patches",
|
|
"wordRes",
|
|
"Specify single patch or multiple patches to write\n"
|
|
"Eg, 'inlet' or '(outlet \"inlet.*\")'"
|
|
);
|
|
argList::addOption
|
|
(
|
|
"excludePatches",
|
|
"wordRes",
|
|
"Specify single patch or multiple patches to exclude from writing."
|
|
" Eg, 'outlet' or '( inlet \".*Wall\" )'"
|
|
, true // mark as an advanced option
|
|
);
|
|
argList::addOption
|
|
(
|
|
"faceZones",
|
|
"wordRes",
|
|
"Specify single or multiple faceZones to write\n"
|
|
"Eg, 'cells' or '( slice \"mfp-.*\" )'."
|
|
);
|
|
argList::addOption
|
|
(
|
|
"fields",
|
|
"wordRes",
|
|
"Specify single or multiple fields to write (all by default)\n"
|
|
"Eg, 'T' or '( \"U.*\" )'"
|
|
);
|
|
argList::addOption
|
|
(
|
|
"cellZones",
|
|
"wordRes",
|
|
"Specify single or multiple cellZones to write\n"
|
|
"Eg, 'cells' or '( slice \"mfp-.*\" )'."
|
|
);
|
|
argList::addOptionCompat("cellZone", {"cellZones", 1912});
|
|
|
|
|
|
#include "setRootCase.H"
|
|
|
|
// Default to binary output, unless otherwise specified
|
|
const IOstream::streamFormat format =
|
|
(
|
|
args.found("ascii")
|
|
? IOstream::ASCII
|
|
: IOstream::BINARY
|
|
);
|
|
|
|
cpuTime timer;
|
|
memInfo mem;
|
|
Info<< "Initial memory " << mem.update().size() << " kB" << endl;
|
|
|
|
#include "createTime.H"
|
|
|
|
instantList timeDirs = timeSelector::select0(runTime, args);
|
|
|
|
#include "createNamedMesh.H"
|
|
|
|
fileName regionPrefix; // Mesh instance (region0 gets filtered out)
|
|
if (regionName != polyMesh::defaultRegion)
|
|
{
|
|
regionPrefix = regionName;
|
|
}
|
|
|
|
|
|
//
|
|
// Configuration
|
|
//
|
|
const bool doBoundary = !args.found("no-boundary");
|
|
const bool doInternal = !args.found("no-internal");
|
|
const bool doCellZones = !args.found("no-cellZones");
|
|
const bool doLagrangian = !args.found("no-lagrangian");
|
|
const bool doPointValues = !args.found("no-point-data");
|
|
const bool nearCellValue = args.found("nearCellValue") && doBoundary;
|
|
|
|
// Control for numbering iterations
|
|
label indexingNumber(0);
|
|
const bool doConsecutive = args.readIfPresent("index", indexingNumber);
|
|
|
|
|
|
// Write the geometry, unless otherwise specified
|
|
bool doGeometry = !args.found("no-mesh");
|
|
|
|
if (nearCellValue)
|
|
{
|
|
Info<< "Using neighbouring cell value instead of patch value"
|
|
<< nl << endl;
|
|
}
|
|
if (!doPointValues)
|
|
{
|
|
Info<< "Point fields and interpolated point data"
|
|
<< " disabled with the '-no-point-data' option"
|
|
<< nl;
|
|
}
|
|
|
|
//
|
|
// General (case) output options
|
|
//
|
|
ensightCase::options caseOpts(format);
|
|
|
|
// Forced point interpolation?
|
|
caseOpts.nodeValues(doPointValues && args.found("nodeValues"));
|
|
caseOpts.width(args.get<label>("width", 8));
|
|
caseOpts.overwrite(!args.found("no-overwrite")); // Remove existing?
|
|
|
|
// Can also have separate directory for lagrangian
|
|
// caseOpts.separateCloud(true);
|
|
|
|
// Define sub-directory name to use for EnSight data.
|
|
// The path to the ensight directory is at case level only
|
|
// - For parallel cases, data only written from master
|
|
fileName outputDir = args.get<word>("name", "EnSight");
|
|
if (!outputDir.isAbsolute())
|
|
{
|
|
outputDir = args.globalPath()/outputDir;
|
|
}
|
|
|
|
ensightMesh::options writeOpts;
|
|
writeOpts.useBoundaryMesh(doBoundary);
|
|
writeOpts.useInternalMesh(doInternal);
|
|
writeOpts.useCellZones(doCellZones);
|
|
|
|
if (args.found("patches"))
|
|
{
|
|
writeOpts.patchSelection(args.getList<wordRe>("patches"));
|
|
}
|
|
if (args.found("excludePatches"))
|
|
{
|
|
writeOpts.patchExclude(args.getList<wordRe>("excludePatches"));
|
|
}
|
|
|
|
if (args.found("faceZones"))
|
|
{
|
|
writeOpts.faceZoneSelection(args.getList<wordRe>("faceZones"));
|
|
}
|
|
if (args.found("cellZones"))
|
|
{
|
|
writeOpts.cellZoneSelection(args.getList<wordRe>("cellZones"));
|
|
}
|
|
|
|
// Report the setup
|
|
writeOpts.print(Info);
|
|
|
|
|
|
//
|
|
// Output configuration (field related)
|
|
//
|
|
|
|
wordRes fieldPatterns;
|
|
args.readListIfPresent<wordRe>("fields", fieldPatterns);
|
|
|
|
// New ensight case file, initialize header etc.
|
|
ensightCase ensCase(outputDir, args.globalCaseName(), caseOpts);
|
|
|
|
// Construct ensight mesh
|
|
ensightMesh ensMesh(mesh, writeOpts);
|
|
|
|
if (Pstream::master())
|
|
{
|
|
Info<< "Converting " << timeDirs.size() << " time steps" << nl;
|
|
ensCase.printInfo(Info) << endl;
|
|
}
|
|
|
|
#include "checkMeshMoving.H"
|
|
#include "findCloudFields.H"
|
|
|
|
// test the pre-check variable if there is a moving mesh
|
|
// time-set for geometries
|
|
// TODO: split off into separate time-set,
|
|
// but need to verify ensight spec
|
|
|
|
Info<< "Startup in "
|
|
<< timer.cpuTimeIncrement() << " s, "
|
|
<< mem.update().size() << " kB" << nl << endl;
|
|
|
|
|
|
// Initially all possible objects that are available at the final time
|
|
wordHashSet testedObjectNames;
|
|
{
|
|
IOobjectList objects(mesh, timeDirs.last().name());
|
|
|
|
if (!fieldPatterns.empty())
|
|
{
|
|
objects.filterObjects(fieldPatterns);
|
|
}
|
|
|
|
// Remove "*_0" restart fields
|
|
objects.prune_0();
|
|
|
|
if (!doPointValues)
|
|
{
|
|
// Prune point fields if disabled
|
|
objects.filterClasses
|
|
(
|
|
[](const word& clsName)
|
|
{
|
|
return fieldTypes::point.found(clsName);
|
|
},
|
|
true // prune
|
|
);
|
|
}
|
|
|
|
wordList objectNames(objects.sortedNames());
|
|
|
|
// Check availability for all times...
|
|
checkData(mesh, timeDirs, objectNames);
|
|
|
|
testedObjectNames = objectNames;
|
|
}
|
|
|
|
if (hasMovingMesh && !doGeometry)
|
|
{
|
|
Info<< "has moving mesh: ignoring '-no-mesh' option" << endl;
|
|
doGeometry = true;
|
|
}
|
|
|
|
forAll(timeDirs, timei)
|
|
{
|
|
runTime.setTime(timeDirs[timei], timei);
|
|
|
|
// Index for the Ensight case
|
|
#include "getTimeIndex.H"
|
|
|
|
ensCase.setTime(timeDirs[timei], timeIndex);
|
|
|
|
Info<< "Time [" << timeIndex << "] = " << runTime.timeName() << nl;
|
|
|
|
polyMesh::readUpdateState meshState = mesh.readUpdate();
|
|
const bool moving = (meshState != polyMesh::UNCHANGED);
|
|
|
|
if (moving)
|
|
{
|
|
ensMesh.expire();
|
|
ensMesh.correct();
|
|
}
|
|
|
|
if (timei == 0 || moving)
|
|
{
|
|
if (doGeometry)
|
|
{
|
|
autoPtr<ensightGeoFile> os = ensCase.newGeometry(hasMovingMesh);
|
|
ensMesh.write(os);
|
|
}
|
|
}
|
|
|
|
// Objects at this time
|
|
IOobjectList objects(mesh, runTime.timeName());
|
|
|
|
// Restrict to objects that are available for all times
|
|
objects.filterObjects(testedObjectNames);
|
|
|
|
// Volume, internal, point fields
|
|
#include "convertVolumeFields.H"
|
|
|
|
// Lagrangian fields
|
|
#include "convertLagrangian.H"
|
|
|
|
Info<< "Wrote in "
|
|
<< timer.cpuTimeIncrement() << " s, "
|
|
<< mem.update().size() << " kB" << nl << nl;
|
|
}
|
|
|
|
ensCase.write();
|
|
|
|
Info<< "\nEnd: "
|
|
<< timer.elapsedCpuTime() << " s, "
|
|
<< mem.update().peak() << " kB (peak)" << nl << endl;
|
|
|
|
return 0;
|
|
}
|
|
|
|
|
|
// ************************************************************************* //
|