mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
ENH: vtkCloud function object (issue #866)
- writes lagrangian data in VTP format during a simulation. In parallel, all data are written from the master.
This commit is contained in:
Mark Olesen
@ -2,4 +2,6 @@ cloudInfo/cloudInfo.C
|
|||||||
icoUncoupledKinematicCloud/icoUncoupledKinematicCloud.C
|
icoUncoupledKinematicCloud/icoUncoupledKinematicCloud.C
|
||||||
dsmcFields/dsmcFields.C
|
dsmcFields/dsmcFields.C
|
||||||
|
|
||||||
|
vtkCloud/vtkCloud.C
|
||||||
|
|
||||||
LIB = $(FOAM_LIBBIN)/liblagrangianFunctionObjects
|
LIB = $(FOAM_LIBBIN)/liblagrangianFunctionObjects
|
||||||
|
|||||||
@ -2,6 +2,8 @@ EXE_INC = \
|
|||||||
-I$(LIB_SRC)/finiteVolume/lnInclude \
|
-I$(LIB_SRC)/finiteVolume/lnInclude \
|
||||||
-I$(LIB_SRC)/transportModels \
|
-I$(LIB_SRC)/transportModels \
|
||||||
-I$(LIB_SRC)/transportModels/incompressible/singlePhaseTransportModel \
|
-I$(LIB_SRC)/transportModels/incompressible/singlePhaseTransportModel \
|
||||||
|
-I$(LIB_SRC)/fileFormats/lnInclude \
|
||||||
|
-I$(LIB_SRC)/conversion/lnInclude \
|
||||||
-I$(LIB_SRC)/meshTools/lnInclude \
|
-I$(LIB_SRC)/meshTools/lnInclude \
|
||||||
-I$(LIB_SRC)/lagrangian/basic/lnInclude \
|
-I$(LIB_SRC)/lagrangian/basic/lnInclude \
|
||||||
-I$(LIB_SRC)/lagrangian/intermediate/lnInclude \
|
-I$(LIB_SRC)/lagrangian/intermediate/lnInclude \
|
||||||
@ -12,6 +14,7 @@ EXE_INC = \
|
|||||||
LIB_LIBS = \
|
LIB_LIBS = \
|
||||||
-lfiniteVolume \
|
-lfiniteVolume \
|
||||||
-lincompressibleTransportModels \
|
-lincompressibleTransportModels \
|
||||||
|
-lconversion \
|
||||||
-lmeshTools \
|
-lmeshTools \
|
||||||
-llagrangian \
|
-llagrangian \
|
||||||
-llagrangianIntermediate \
|
-llagrangianIntermediate \
|
||||||
|
|||||||
489
src/functionObjects/lagrangian/vtkCloud/vtkCloud.C
Normal file
489
src/functionObjects/lagrangian/vtkCloud/vtkCloud.C
Normal file
@ -0,0 +1,489 @@
|
|||||||
|
/*---------------------------------------------------------------------------*\
|
||||||
|
========= |
|
||||||
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||||
|
\\ / O peration |
|
||||||
|
\\ / A nd | Copyright (C) 2018 OpenCFD Ltd.
|
||||||
|
\\/ 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/>.
|
||||||
|
|
||||||
|
\*---------------------------------------------------------------------------*/
|
||||||
|
|
||||||
|
#include "vtkCloud.H"
|
||||||
|
#include "Cloud.H"
|
||||||
|
#include "dictionary.H"
|
||||||
|
#include "fvMesh.H"
|
||||||
|
#include "foamVtkOutputOptions.H"
|
||||||
|
#include "addToRunTimeSelectionTable.H"
|
||||||
|
#include "pointList.H"
|
||||||
|
#include "stringOps.H"
|
||||||
|
#include <fstream>
|
||||||
|
|
||||||
|
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
|
||||||
|
|
||||||
|
namespace Foam
|
||||||
|
{
|
||||||
|
namespace functionObjects
|
||||||
|
{
|
||||||
|
defineTypeNameAndDebug(vtkCloud, 0);
|
||||||
|
addToRunTimeSelectionTable(functionObject, vtkCloud, dictionary);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
|
||||||
|
|
||||||
|
void Foam::functionObjects::vtkCloud::writeVerts
|
||||||
|
(
|
||||||
|
autoPtr<vtk::formatter>& format,
|
||||||
|
const label nParcels
|
||||||
|
) const
|
||||||
|
{
|
||||||
|
if (Pstream::master())
|
||||||
|
{
|
||||||
|
format().tag(vtk::fileTag::VERTS);
|
||||||
|
|
||||||
|
// Same payload throughout
|
||||||
|
const uint64_t payLoad = (nParcels * sizeof(label));
|
||||||
|
|
||||||
|
//
|
||||||
|
// 'connectivity'
|
||||||
|
// = linear mapping onto points
|
||||||
|
//
|
||||||
|
{
|
||||||
|
format().openDataArray<label>(vtk::dataArrayAttr::CONNECTIVITY)
|
||||||
|
.closeTag();
|
||||||
|
|
||||||
|
format().writeSize(payLoad);
|
||||||
|
for (label i=0; i < nParcels; ++i)
|
||||||
|
{
|
||||||
|
format().write(i);
|
||||||
|
}
|
||||||
|
format().flush();
|
||||||
|
|
||||||
|
format().endDataArray();
|
||||||
|
}
|
||||||
|
|
||||||
|
//
|
||||||
|
// 'offsets' (connectivity offsets)
|
||||||
|
// = linear mapping onto points (with 1 offset)
|
||||||
|
//
|
||||||
|
{
|
||||||
|
format().openDataArray<label>(vtk::dataArrayAttr::OFFSETS)
|
||||||
|
.closeTag();
|
||||||
|
|
||||||
|
format().writeSize(payLoad);
|
||||||
|
for (label i=0; i < nParcels; ++i)
|
||||||
|
{
|
||||||
|
format().write(i+1);
|
||||||
|
}
|
||||||
|
format().flush();
|
||||||
|
|
||||||
|
format().endDataArray();
|
||||||
|
}
|
||||||
|
|
||||||
|
format().endTag(vtk::fileTag::VERTS);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
bool Foam::functionObjects::vtkCloud::writeCloud
|
||||||
|
(
|
||||||
|
const fileName& outputName,
|
||||||
|
const word& cloudName
|
||||||
|
)
|
||||||
|
{
|
||||||
|
const auto* objPtr = mesh_.lookupObjectPtr<cloud>(cloudName);
|
||||||
|
if (!objPtr)
|
||||||
|
{
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
objectRegistry obrTmp
|
||||||
|
(
|
||||||
|
IOobject
|
||||||
|
(
|
||||||
|
"vtk::vtkCloud::" + cloudName,
|
||||||
|
mesh_.time().constant(),
|
||||||
|
mesh_,
|
||||||
|
IOobject::NO_READ,
|
||||||
|
IOobject::NO_WRITE,
|
||||||
|
false
|
||||||
|
)
|
||||||
|
);
|
||||||
|
|
||||||
|
objPtr->writeObjects(obrTmp);
|
||||||
|
|
||||||
|
const auto* pointsPtr = obrTmp.lookupObjectPtr<vectorField>("position");
|
||||||
|
|
||||||
|
if (!pointsPtr)
|
||||||
|
{
|
||||||
|
// This should be impossible
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Total number of parcels on all processes
|
||||||
|
label nTotParcels = pointsPtr->size();
|
||||||
|
reduce(nTotParcels, sumOp<label>());
|
||||||
|
|
||||||
|
if (!nTotParcels)
|
||||||
|
{
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
std::ofstream os;
|
||||||
|
autoPtr<vtk::formatter> format;
|
||||||
|
|
||||||
|
// Header
|
||||||
|
if (Pstream::master())
|
||||||
|
{
|
||||||
|
os.open(outputName);
|
||||||
|
format = writeOpts_.newFormatter(os);
|
||||||
|
|
||||||
|
// XML (inline)
|
||||||
|
format()
|
||||||
|
.xmlHeader()
|
||||||
|
.xmlComment
|
||||||
|
(
|
||||||
|
"cloud=" + cloudName
|
||||||
|
+ " time=" + time_.timeName()
|
||||||
|
+ " index=" + Foam::name(time_.timeIndex())
|
||||||
|
)
|
||||||
|
.beginVTKFile(vtk::fileTag::POLY_DATA, "0.1");
|
||||||
|
|
||||||
|
// Begin piece
|
||||||
|
if (useVerts_)
|
||||||
|
{
|
||||||
|
format()
|
||||||
|
.openTag(vtk::fileTag::PIECE)
|
||||||
|
.xmlAttr(vtk::fileAttr::NUMBER_OF_POINTS, nTotParcels)
|
||||||
|
.xmlAttr(vtk::fileAttr::NUMBER_OF_VERTS, nTotParcels)
|
||||||
|
.closeTag();
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
format()
|
||||||
|
.openTag(vtk::fileTag::PIECE)
|
||||||
|
.xmlAttr(vtk::fileAttr::NUMBER_OF_POINTS, nTotParcels)
|
||||||
|
.closeTag();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// Points
|
||||||
|
if (Pstream::master())
|
||||||
|
{
|
||||||
|
const uint64_t payLoad = (nTotParcels * 3 * sizeof(float));
|
||||||
|
|
||||||
|
format().tag(vtk::fileTag::POINTS)
|
||||||
|
.openDataArray<float,3>(vtk::dataArrayAttr::POINTS)
|
||||||
|
.closeTag();
|
||||||
|
|
||||||
|
format().writeSize(payLoad);
|
||||||
|
|
||||||
|
// Master
|
||||||
|
vtk::writeList(format(), *pointsPtr);
|
||||||
|
|
||||||
|
// Slaves - recv
|
||||||
|
for (int slave=1; slave<Pstream::nProcs(); ++slave)
|
||||||
|
{
|
||||||
|
IPstream fromSlave(Pstream::commsTypes::scheduled, slave);
|
||||||
|
pointList points(fromSlave);
|
||||||
|
|
||||||
|
vtk::writeList(format(), points);
|
||||||
|
}
|
||||||
|
|
||||||
|
format().flush();
|
||||||
|
|
||||||
|
format()
|
||||||
|
.endDataArray()
|
||||||
|
.endTag(vtk::fileTag::POINTS);
|
||||||
|
|
||||||
|
if (useVerts_)
|
||||||
|
{
|
||||||
|
writeVerts(format, nTotParcels);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
// Slaves - send
|
||||||
|
|
||||||
|
OPstream toMaster
|
||||||
|
(
|
||||||
|
Pstream::commsTypes::scheduled,
|
||||||
|
Pstream::masterNo()
|
||||||
|
);
|
||||||
|
|
||||||
|
toMaster
|
||||||
|
<< *pointsPtr;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// Prevent any possible conversion of positions as a field
|
||||||
|
obrTmp.filterKeys
|
||||||
|
(
|
||||||
|
[](const word& k)
|
||||||
|
{
|
||||||
|
return k.startsWith("position")
|
||||||
|
|| k.startsWith("coordinate");
|
||||||
|
},
|
||||||
|
true // prune
|
||||||
|
);
|
||||||
|
|
||||||
|
// Restrict to specified fields
|
||||||
|
if (selectFields_.size())
|
||||||
|
{
|
||||||
|
obrTmp.filterKeys(selectFields_);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// Write fields
|
||||||
|
const vtk::fileTag dataType =
|
||||||
|
(
|
||||||
|
useVerts_
|
||||||
|
? vtk::fileTag::CELL_DATA
|
||||||
|
: vtk::fileTag::POINT_DATA
|
||||||
|
);
|
||||||
|
|
||||||
|
if (Pstream::master())
|
||||||
|
{
|
||||||
|
format().tag(dataType);
|
||||||
|
}
|
||||||
|
|
||||||
|
DynamicList<word> written(obrTmp.size());
|
||||||
|
|
||||||
|
written.append(writeFields<label>(format, obrTmp, nTotParcels));
|
||||||
|
written.append(writeFields<scalar>(format, obrTmp, nTotParcels));
|
||||||
|
written.append(writeFields<vector>(format, obrTmp, nTotParcels));
|
||||||
|
|
||||||
|
if (Pstream::master())
|
||||||
|
{
|
||||||
|
format().endTag(dataType);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Footer
|
||||||
|
if (Pstream::master())
|
||||||
|
{
|
||||||
|
// slight cheat. </Piece> too
|
||||||
|
format().endTag(vtk::fileTag::PIECE);
|
||||||
|
|
||||||
|
format().endTag(vtk::fileTag::POLY_DATA)
|
||||||
|
.endVTKFile();
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// Record information into the state (all processors)
|
||||||
|
//
|
||||||
|
// foName
|
||||||
|
// {
|
||||||
|
// cloudName
|
||||||
|
// {
|
||||||
|
// file "<case>/VTK/cloud1_000.vtp";
|
||||||
|
// fields (U T rho);
|
||||||
|
// }
|
||||||
|
// }
|
||||||
|
|
||||||
|
dictionary propsDict;
|
||||||
|
|
||||||
|
// Use case-local filename and "<case>" shortcut for readable output
|
||||||
|
// and possibly relocation of files
|
||||||
|
|
||||||
|
fileName fName(outputName.relative(stringOps::expand("<case>")));
|
||||||
|
if (fName.isAbsolute())
|
||||||
|
{
|
||||||
|
propsDict.add("file", fName);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
propsDict.add("file", "<case>"/fName);
|
||||||
|
}
|
||||||
|
propsDict.add("fields", written);
|
||||||
|
|
||||||
|
setObjectProperty(name(), cloudName, propsDict);
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
|
||||||
|
|
||||||
|
Foam::functionObjects::vtkCloud::vtkCloud
|
||||||
|
(
|
||||||
|
const word& name,
|
||||||
|
const Time& runTime,
|
||||||
|
const dictionary& dict
|
||||||
|
)
|
||||||
|
:
|
||||||
|
fvMeshFunctionObject(name, runTime, dict),
|
||||||
|
writeOpts_(vtk::formatType::INLINE_BASE64),
|
||||||
|
printf_(),
|
||||||
|
useTimeName_(false),
|
||||||
|
useVerts_(false),
|
||||||
|
selectClouds_(),
|
||||||
|
selectFields_(),
|
||||||
|
dirName_("VTK"),
|
||||||
|
series_()
|
||||||
|
{
|
||||||
|
if (postProcess)
|
||||||
|
{
|
||||||
|
// Disable for post-process mode.
|
||||||
|
// Emit as FatalError for the try/catch in the caller.
|
||||||
|
FatalError
|
||||||
|
<< type() << " disabled in post-process mode"
|
||||||
|
<< exit(FatalError);
|
||||||
|
}
|
||||||
|
|
||||||
|
read(dict);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
|
||||||
|
|
||||||
|
bool Foam::functionObjects::vtkCloud::read(const dictionary& dict)
|
||||||
|
{
|
||||||
|
fvMeshFunctionObject::read(dict);
|
||||||
|
|
||||||
|
//
|
||||||
|
// writer options - default is xml base64. Legacy is not desired.
|
||||||
|
//
|
||||||
|
writeOpts_ = vtk::formatType::INLINE_BASE64;
|
||||||
|
|
||||||
|
writeOpts_.ascii
|
||||||
|
(
|
||||||
|
dict.found("format")
|
||||||
|
&& (IOstream::formatEnum(dict.lookup("format")) == IOstream::ASCII)
|
||||||
|
);
|
||||||
|
|
||||||
|
writeOpts_.append(false); // No append supported
|
||||||
|
writeOpts_.legacy(false); // No legacy supported
|
||||||
|
|
||||||
|
writeOpts_.precision
|
||||||
|
(
|
||||||
|
dict.lookupOrDefault
|
||||||
|
(
|
||||||
|
"writePrecision",
|
||||||
|
IOstream::defaultPrecision()
|
||||||
|
)
|
||||||
|
);
|
||||||
|
|
||||||
|
// Info<< type() << " " << name() << " output-format: "
|
||||||
|
// << writeOpts_.description() << nl;
|
||||||
|
|
||||||
|
int padWidth = dict.lookupOrDefault<int>("width", 8);
|
||||||
|
|
||||||
|
// Appropriate printf format - Enforce min/max sanity limits
|
||||||
|
if (padWidth < 1 || padWidth > 31)
|
||||||
|
{
|
||||||
|
printf_.clear();
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
printf_ = "%0" + std::to_string(padWidth) + "d";
|
||||||
|
}
|
||||||
|
|
||||||
|
useTimeName_ = dict.lookupOrDefault<bool>("timeName", false);
|
||||||
|
|
||||||
|
useVerts_ = dict.lookupOrDefault<bool>("cellData", false);
|
||||||
|
|
||||||
|
|
||||||
|
//
|
||||||
|
// other options
|
||||||
|
//
|
||||||
|
dict.readIfPresent("directory", dirName_);
|
||||||
|
|
||||||
|
selectClouds_.clear();
|
||||||
|
dict.readIfPresent("clouds", selectClouds_);
|
||||||
|
|
||||||
|
if (selectClouds_.empty())
|
||||||
|
{
|
||||||
|
selectClouds_.resize(1);
|
||||||
|
selectClouds_.first() =
|
||||||
|
dict.lookupOrDefault<word>("cloud", cloud::defaultName);
|
||||||
|
}
|
||||||
|
|
||||||
|
selectFields_.clear();
|
||||||
|
dict.readIfPresent("fields", selectFields_);
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
bool Foam::functionObjects::vtkCloud::execute()
|
||||||
|
{
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
bool Foam::functionObjects::vtkCloud::write()
|
||||||
|
{
|
||||||
|
const wordList cloudNames(mesh_.sortedNames<cloud>(selectClouds_));
|
||||||
|
|
||||||
|
if (cloudNames.empty())
|
||||||
|
{
|
||||||
|
return true; // skip - not available
|
||||||
|
}
|
||||||
|
|
||||||
|
const word timeDesc =
|
||||||
|
(
|
||||||
|
useTimeName_
|
||||||
|
? time_.timeName()
|
||||||
|
: printf_.empty()
|
||||||
|
? Foam::name(time_.timeIndex())
|
||||||
|
: word::printf(printf_, time_.timeIndex())
|
||||||
|
);
|
||||||
|
|
||||||
|
fileName vtkDir(dirName_);
|
||||||
|
vtkDir.expand();
|
||||||
|
if (!vtkDir.isAbsolute())
|
||||||
|
{
|
||||||
|
vtkDir = stringOps::expand("<case>")/vtkDir;
|
||||||
|
}
|
||||||
|
mkDir(vtkDir);
|
||||||
|
|
||||||
|
Log << name() << " output Time: " << time_.timeName() << nl;
|
||||||
|
|
||||||
|
// Each cloud separately
|
||||||
|
for (const word& cloudName : cloudNames)
|
||||||
|
{
|
||||||
|
const word prefix(cloudName + "_");
|
||||||
|
const word suffix(".vtp"); // No legacy supported
|
||||||
|
|
||||||
|
const fileName outputName(vtkDir/prefix + timeDesc + suffix);
|
||||||
|
|
||||||
|
if (writeCloud(outputName, cloudName))
|
||||||
|
{
|
||||||
|
Log << " cloud : " << outputName << endl;
|
||||||
|
|
||||||
|
if (Pstream::master())
|
||||||
|
{
|
||||||
|
// Add to file-series and emit as JSON
|
||||||
|
// - misbehaves if vtkDir changes during the run,
|
||||||
|
// but that causes other issues too.
|
||||||
|
|
||||||
|
series_(cloudName).append({time_.value(), timeDesc});
|
||||||
|
|
||||||
|
OFstream os(vtkDir/cloudName + ".vtp.series", IOstream::ASCII);
|
||||||
|
|
||||||
|
vtk::writeSeries(os, prefix, suffix, series_[cloudName]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// ************************************************************************* //
|
||||||
226
src/functionObjects/lagrangian/vtkCloud/vtkCloud.H
Normal file
226
src/functionObjects/lagrangian/vtkCloud/vtkCloud.H
Normal file
@ -0,0 +1,226 @@
|
|||||||
|
/*---------------------------------------------------------------------------*\
|
||||||
|
========= |
|
||||||
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||||
|
\\ / O peration |
|
||||||
|
\\ / A nd | Copyright (C) 2018 OpenCFD Ltd.
|
||||||
|
\\/ 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/>.
|
||||||
|
|
||||||
|
Class
|
||||||
|
Foam::functionObjects::vtkCloud
|
||||||
|
|
||||||
|
Group
|
||||||
|
grpUtilitiesFunctionObjects
|
||||||
|
|
||||||
|
Description
|
||||||
|
This functionObject writes cloud(s) in VTK format.
|
||||||
|
|
||||||
|
Example of function object specification:
|
||||||
|
\verbatim
|
||||||
|
cloudWrite1
|
||||||
|
{
|
||||||
|
type vtkCloud;
|
||||||
|
libs ("liblagrangianFunctionObjects.so");
|
||||||
|
writeControl writeTime;
|
||||||
|
writeInterval 1;
|
||||||
|
format binary;
|
||||||
|
|
||||||
|
cloud myCloud;
|
||||||
|
width 12;
|
||||||
|
fields (T U rho);
|
||||||
|
}
|
||||||
|
\endverbatim
|
||||||
|
|
||||||
|
Usage
|
||||||
|
\table
|
||||||
|
Property | Description | Required | Default
|
||||||
|
type | Type name: vtkCloud | yes |
|
||||||
|
writeControl | Output control | recommended | timeStep
|
||||||
|
cloud | | no | defaultCloud
|
||||||
|
clouds | wordRe list of clouds | no |
|
||||||
|
fields | wordRe list of fields | no |
|
||||||
|
cellData | Emit cellData instead of pointData | no | false
|
||||||
|
directory | The output directory name | no | VTK
|
||||||
|
width | Padding width for file name | no | 8
|
||||||
|
timeName | Use time-name instead of time-index | no | false
|
||||||
|
format | ascii or binary format | no | binary
|
||||||
|
writePrecision | write precision in ascii | no | same as IOstream
|
||||||
|
\endtable
|
||||||
|
|
||||||
|
The output filename and fields are added to the cloud's \c OutputProperties
|
||||||
|
dictionary. For the previous example specification:
|
||||||
|
|
||||||
|
\verbatim
|
||||||
|
cloudWrite1
|
||||||
|
{
|
||||||
|
myCloud
|
||||||
|
{
|
||||||
|
file "<case>/VTK/myCloud_00001.vtp";
|
||||||
|
fields (T U rho);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
\endverbatim
|
||||||
|
|
||||||
|
See also
|
||||||
|
Foam::functionObjects::ensightWrite
|
||||||
|
Foam::functionObjects::vtkWrite
|
||||||
|
Foam::functionObjects::fvMeshFunctionObject
|
||||||
|
Foam::functionObjects::timeControl
|
||||||
|
|
||||||
|
SourceFiles
|
||||||
|
vtkCloud.C
|
||||||
|
vtkCloudTemplates.C
|
||||||
|
|
||||||
|
\*---------------------------------------------------------------------------*/
|
||||||
|
|
||||||
|
#ifndef functionObjects_vtkCloud_H
|
||||||
|
#define functionObjects_vtkCloud_H
|
||||||
|
|
||||||
|
#include "fvMeshFunctionObject.H"
|
||||||
|
#include "foamVtkOutputOptions.H"
|
||||||
|
#include "wordRes.H"
|
||||||
|
#include "instant.H"
|
||||||
|
#include "DynamicList.H"
|
||||||
|
#include "HashTable.H"
|
||||||
|
|
||||||
|
|
||||||
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||||
|
|
||||||
|
namespace Foam
|
||||||
|
{
|
||||||
|
namespace functionObjects
|
||||||
|
{
|
||||||
|
|
||||||
|
/*---------------------------------------------------------------------------*\
|
||||||
|
Class vtkCloud Declaration
|
||||||
|
\*---------------------------------------------------------------------------*/
|
||||||
|
|
||||||
|
class vtkCloud
|
||||||
|
:
|
||||||
|
public fvMeshFunctionObject
|
||||||
|
{
|
||||||
|
// Private data
|
||||||
|
|
||||||
|
//- Writer options
|
||||||
|
vtk::outputOptions writeOpts_;
|
||||||
|
|
||||||
|
//- The printf format for zero-padding names
|
||||||
|
string printf_;
|
||||||
|
|
||||||
|
//- Use time-name instead of time-index
|
||||||
|
bool useTimeName_;
|
||||||
|
|
||||||
|
//- Write lagrangian as cell data (verts) instead of point data
|
||||||
|
bool useVerts_;
|
||||||
|
|
||||||
|
//- Requested names of clouds to process
|
||||||
|
wordRes selectClouds_;
|
||||||
|
|
||||||
|
//- Subset of cloud fields to process
|
||||||
|
wordRes selectFields_;
|
||||||
|
|
||||||
|
//- Output directory name
|
||||||
|
fileName dirName_;
|
||||||
|
|
||||||
|
//- Per cloud output for file series
|
||||||
|
HashTable<DynamicList<instant>> series_;
|
||||||
|
|
||||||
|
|
||||||
|
// Private Member Functions
|
||||||
|
|
||||||
|
//- Write a cloud to disk, and record on the cloud OutputProperties
|
||||||
|
bool writeCloud
|
||||||
|
(
|
||||||
|
const fileName& outputName,
|
||||||
|
const word& cloudName
|
||||||
|
);
|
||||||
|
|
||||||
|
//- Write VERTS connectivity
|
||||||
|
void writeVerts
|
||||||
|
(
|
||||||
|
autoPtr<vtk::formatter>& format,
|
||||||
|
const label nParcels
|
||||||
|
) const;
|
||||||
|
|
||||||
|
//- Write fields of IOField<Type>
|
||||||
|
template<class Type>
|
||||||
|
wordList writeFields
|
||||||
|
(
|
||||||
|
autoPtr<vtk::formatter>& format,
|
||||||
|
const objectRegistry& obrTmp,
|
||||||
|
const label nTotParcels
|
||||||
|
) const;
|
||||||
|
|
||||||
|
|
||||||
|
//- No copy construct
|
||||||
|
vtkCloud(const vtkCloud&) = delete;
|
||||||
|
|
||||||
|
//- No copy assignment
|
||||||
|
void operator=(const vtkCloud&) = delete;
|
||||||
|
|
||||||
|
|
||||||
|
public:
|
||||||
|
|
||||||
|
//- Runtime type information
|
||||||
|
TypeName("vtkCloud");
|
||||||
|
|
||||||
|
|
||||||
|
// Constructors
|
||||||
|
|
||||||
|
//- Construct from Time and dictionary
|
||||||
|
vtkCloud
|
||||||
|
(
|
||||||
|
const word& name,
|
||||||
|
const Time& runTime,
|
||||||
|
const dictionary& dict
|
||||||
|
);
|
||||||
|
|
||||||
|
|
||||||
|
//- Destructor
|
||||||
|
virtual ~vtkCloud() = default;
|
||||||
|
|
||||||
|
|
||||||
|
// Member Functions
|
||||||
|
|
||||||
|
//- Read the vtkCloud specification
|
||||||
|
virtual bool read(const dictionary& dict);
|
||||||
|
|
||||||
|
//- Execute, currently does nothing
|
||||||
|
virtual bool execute();
|
||||||
|
|
||||||
|
//- Write fields
|
||||||
|
virtual bool write();
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||||
|
|
||||||
|
} // End namespace functionObjects
|
||||||
|
} // End namespace Foam
|
||||||
|
|
||||||
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||||
|
|
||||||
|
#ifdef NoRepository
|
||||||
|
#include "vtkCloudTemplates.C"
|
||||||
|
#endif
|
||||||
|
|
||||||
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
||||||
|
// ************************************************************************* //
|
||||||
155
src/functionObjects/lagrangian/vtkCloud/vtkCloudTemplates.C
Normal file
155
src/functionObjects/lagrangian/vtkCloud/vtkCloudTemplates.C
Normal file
@ -0,0 +1,155 @@
|
|||||||
|
/*---------------------------------------------------------------------------*\
|
||||||
|
========= |
|
||||||
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||||
|
\\ / O peration |
|
||||||
|
\\ / A nd | Copyright (C) 2018 OpenCFD Ltd.
|
||||||
|
\\/ 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/>.
|
||||||
|
|
||||||
|
\*---------------------------------------------------------------------------*/
|
||||||
|
|
||||||
|
#include "IOField.H"
|
||||||
|
|
||||||
|
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
|
||||||
|
|
||||||
|
template<class Type>
|
||||||
|
Foam::wordList Foam::functionObjects::vtkCloud::writeFields
|
||||||
|
(
|
||||||
|
autoPtr<vtk::formatter>& format,
|
||||||
|
const objectRegistry& obrTmp,
|
||||||
|
const label nTotParcels
|
||||||
|
) const
|
||||||
|
{
|
||||||
|
const int nCmpt(pTraits<Type>::nComponents);
|
||||||
|
|
||||||
|
const bool useIntField =
|
||||||
|
std::is_integral<typename pTraits<Type>::cmptType>();
|
||||||
|
|
||||||
|
// Fields are not always on all processors (eg, multi-component parcels).
|
||||||
|
// Thus need to resolve names between all processors.
|
||||||
|
|
||||||
|
wordList fieldNames(obrTmp.names<IOField<Type>>());
|
||||||
|
Pstream::combineGather(fieldNames, ListOps::uniqueEqOp<word>());
|
||||||
|
Pstream::combineScatter(fieldNames);
|
||||||
|
|
||||||
|
// Sort to get identical order of fields on all processors
|
||||||
|
Foam::sort(fieldNames);
|
||||||
|
|
||||||
|
for (const word& fieldName : fieldNames)
|
||||||
|
{
|
||||||
|
const auto* fldPtr = obrTmp.lookupObjectPtr<IOField<Type>>(fieldName);
|
||||||
|
|
||||||
|
if (Pstream::master())
|
||||||
|
{
|
||||||
|
if (useIntField)
|
||||||
|
{
|
||||||
|
const uint64_t payLoad(nTotParcels * nCmpt * sizeof(label));
|
||||||
|
|
||||||
|
format().openDataArray<label, nCmpt>(fieldName)
|
||||||
|
.closeTag();
|
||||||
|
|
||||||
|
format().writeSize(payLoad);
|
||||||
|
|
||||||
|
if (fldPtr)
|
||||||
|
{
|
||||||
|
// Data on master
|
||||||
|
const auto& fld = *fldPtr;
|
||||||
|
|
||||||
|
// Ensure consistent output width
|
||||||
|
for (const Type& val : fld)
|
||||||
|
{
|
||||||
|
for (int cmpt=0; cmpt < nCmpt; ++cmpt)
|
||||||
|
{
|
||||||
|
format().write(label(component(val, cmpt)));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Slaves - recv
|
||||||
|
for (int slave=1; slave<Pstream::nProcs(); ++slave)
|
||||||
|
{
|
||||||
|
IPstream fromSlave(Pstream::commsTypes::scheduled, slave);
|
||||||
|
Field<Type> recv(fromSlave);
|
||||||
|
|
||||||
|
for (const Type& val : recv)
|
||||||
|
{
|
||||||
|
for (int cmpt=0; cmpt < nCmpt; ++cmpt)
|
||||||
|
{
|
||||||
|
format().write(label(component(val, cmpt)));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
const uint64_t payLoad(nTotParcels * nCmpt * sizeof(float));
|
||||||
|
|
||||||
|
format().openDataArray<float, nCmpt>(fieldName)
|
||||||
|
.closeTag();
|
||||||
|
|
||||||
|
format().writeSize(payLoad);
|
||||||
|
|
||||||
|
if (fldPtr)
|
||||||
|
{
|
||||||
|
// Data on master
|
||||||
|
vtk::writeList(format(), *fldPtr);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Slaves - recv
|
||||||
|
for (int slave=1; slave<Pstream::nProcs(); ++slave)
|
||||||
|
{
|
||||||
|
IPstream fromSlave(Pstream::commsTypes::scheduled, slave);
|
||||||
|
Field<Type> recv(fromSlave);
|
||||||
|
|
||||||
|
vtk::writeList(format(), recv);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
format().flush();
|
||||||
|
|
||||||
|
format()
|
||||||
|
.endDataArray();
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
// Slaves - send
|
||||||
|
|
||||||
|
OPstream toMaster
|
||||||
|
(
|
||||||
|
Pstream::commsTypes::scheduled,
|
||||||
|
Pstream::masterNo()
|
||||||
|
);
|
||||||
|
|
||||||
|
if (fldPtr)
|
||||||
|
{
|
||||||
|
toMaster
|
||||||
|
<< *fldPtr;
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
toMaster
|
||||||
|
<< Field<Type>();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return fieldNames;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// ************************************************************************* //
|
||||||
@ -51,5 +51,10 @@ maxCo 1.0;
|
|||||||
|
|
||||||
maxDeltaT 1;
|
maxDeltaT 1;
|
||||||
|
|
||||||
|
functions
|
||||||
|
{
|
||||||
|
#include "vtkCloud"
|
||||||
|
#include "runTimePostProcessing"
|
||||||
|
}
|
||||||
|
|
||||||
// ************************************************************************* //
|
// ************************************************************************* //
|
||||||
|
|||||||
@ -0,0 +1,108 @@
|
|||||||
|
// -*- C++ -*-
|
||||||
|
|
||||||
|
postPro1
|
||||||
|
{
|
||||||
|
type runTimePostProcessing;
|
||||||
|
libs ("librunTimePostProcessing.so");
|
||||||
|
writeControl writeTime;
|
||||||
|
output
|
||||||
|
{
|
||||||
|
name image;
|
||||||
|
width 1200;
|
||||||
|
height 800;
|
||||||
|
}
|
||||||
|
|
||||||
|
camera
|
||||||
|
{
|
||||||
|
// If camera is moving, optionally provide start and end times
|
||||||
|
// startPosition 0.2;
|
||||||
|
// endPosition 0.75;
|
||||||
|
|
||||||
|
// Total number of frames to generate
|
||||||
|
nFrameTotal 1;
|
||||||
|
|
||||||
|
parallelProjection yes;
|
||||||
|
|
||||||
|
focalPoint (0.251 0.415 0.05);
|
||||||
|
position (0.251 0.415 2.218);
|
||||||
|
up (0 1 0);
|
||||||
|
zoom 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Default colours
|
||||||
|
// - If select to colourBy colour, these values are used unless
|
||||||
|
// they are locally overridden
|
||||||
|
colours
|
||||||
|
{
|
||||||
|
background (0.5 0.5 0.5);
|
||||||
|
background2 (0.7 0.7 0.7);
|
||||||
|
text (1 1 1);
|
||||||
|
edge (1 0 0);
|
||||||
|
surface (0.5 0.5 0.5);
|
||||||
|
line (1 0 0);
|
||||||
|
point (0.5 0.5 0.5);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Points (cloud) data
|
||||||
|
points
|
||||||
|
{
|
||||||
|
cloud1
|
||||||
|
{
|
||||||
|
type functionObjectCloud;
|
||||||
|
functionObject cloudWrite1;
|
||||||
|
cloud coalCloud1;
|
||||||
|
colourMap blueWhiteRed;
|
||||||
|
representation sphere;
|
||||||
|
maxGlyphLength 0.05;
|
||||||
|
visible yes;
|
||||||
|
featureEdges no;
|
||||||
|
colourBy field;
|
||||||
|
colourField T;
|
||||||
|
field T;
|
||||||
|
range (290 410);
|
||||||
|
opacity 1;
|
||||||
|
scalarBar
|
||||||
|
{
|
||||||
|
visible yes;
|
||||||
|
vertical yes;
|
||||||
|
position (0.8 0.1);
|
||||||
|
fontSize 12;
|
||||||
|
title "Temperature [K]";
|
||||||
|
labelFormat "%.0f";
|
||||||
|
numberOfLabels 8;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Future...
|
||||||
|
surfaces
|
||||||
|
{
|
||||||
|
container
|
||||||
|
{
|
||||||
|
type patches;
|
||||||
|
patches (".*");
|
||||||
|
renderMode phong;
|
||||||
|
representation surface;
|
||||||
|
edgeColour (0 0 0);
|
||||||
|
visible yes;
|
||||||
|
featureEdges yes;
|
||||||
|
opacity 0.25;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
*/
|
||||||
|
|
||||||
|
// Text data
|
||||||
|
text
|
||||||
|
{
|
||||||
|
text1
|
||||||
|
{
|
||||||
|
visible yes;
|
||||||
|
string "simplifiedSiwek";
|
||||||
|
position (0.1 0.05);
|
||||||
|
size 24;
|
||||||
|
bold no;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ************************************************************************* //
|
||||||
@ -0,0 +1,31 @@
|
|||||||
|
// -*- C++ -*-
|
||||||
|
// Minimal example of using the vtkCloud function object.
|
||||||
|
cloudWrite1
|
||||||
|
{
|
||||||
|
type vtkCloud;
|
||||||
|
libs ("liblagrangianFunctionObjects.so");
|
||||||
|
log true;
|
||||||
|
|
||||||
|
// Cloud name
|
||||||
|
// cloud coalCloud1;
|
||||||
|
clouds ( ".*" );
|
||||||
|
|
||||||
|
// Fields to output (words or regex)
|
||||||
|
fields ( U T d "Y.*" );
|
||||||
|
|
||||||
|
//- Output format (ascii | binary) - Default=binary
|
||||||
|
// format binary;
|
||||||
|
|
||||||
|
// format ascii;
|
||||||
|
// writePrecision 12;
|
||||||
|
|
||||||
|
//- Output directory name - Default="VTK"
|
||||||
|
// directory "VTK";
|
||||||
|
|
||||||
|
//- Write more frequent than fields
|
||||||
|
writeControl adjustableRunTime;
|
||||||
|
writeInterval 0.001;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// ************************************************************************* //
|
||||||
Reference in New Issue
Block a user