722 lines
18 KiB
C
722 lines
18 KiB
C
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2012-2014 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 <http://www.gnu.org/licenses/>.
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#include "ParticleCollector.H"
|
|
#include "Pstream.H"
|
|
#include "surfaceWriter.H"
|
|
#include "unitConversion.H"
|
|
#include "Random.H"
|
|
#include "triangle.H"
|
|
#include "cloud.H"
|
|
|
|
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
|
|
|
|
template<class CloudType>
|
|
void Foam::ParticleCollector<CloudType>::makeLogFile
|
|
(
|
|
const faceList& faces,
|
|
const Field<point>& points,
|
|
const Field<scalar>& area
|
|
)
|
|
{
|
|
// Create the output file if not already created
|
|
if (log_)
|
|
{
|
|
if (debug)
|
|
{
|
|
Info<< "Creating output file" << endl;
|
|
}
|
|
|
|
if (Pstream::master())
|
|
{
|
|
// Create directory if does not exist
|
|
mkDir(this->outputTimeDir());
|
|
|
|
// Open new file at start up
|
|
outputFilePtr_.reset
|
|
(
|
|
new OFstream(this->outputTimeDir()/(type() + ".dat"))
|
|
);
|
|
|
|
outputFilePtr_()
|
|
<< "# Source : " << type() << nl
|
|
<< "# Bins : " << faces.size() << nl
|
|
<< "# Total area : " << sum(area) << nl;
|
|
|
|
outputFilePtr_()
|
|
<< "# Geometry :" << nl
|
|
<< '#'
|
|
<< tab << "Bin"
|
|
<< tab << "(Centre_x Centre_y Centre_z)"
|
|
<< tab << "Area"
|
|
<< nl;
|
|
|
|
forAll(faces, i)
|
|
{
|
|
outputFilePtr_()
|
|
<< '#'
|
|
<< tab << i
|
|
<< tab << faces[i].centre(points)
|
|
<< tab << area[i]
|
|
<< nl;
|
|
}
|
|
|
|
outputFilePtr_()
|
|
<< '#' << nl
|
|
<< "# Output format:" << nl;
|
|
|
|
forAll(faces, i)
|
|
{
|
|
word id = Foam::name(i);
|
|
word binId = "bin_" + id;
|
|
|
|
outputFilePtr_()
|
|
<< '#'
|
|
<< tab << "Time"
|
|
<< tab << binId
|
|
<< tab << "mass[" << id << "]"
|
|
<< tab << "massFlowRate[" << id << "]"
|
|
<< endl;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
template<class CloudType>
|
|
void Foam::ParticleCollector<CloudType>::initPolygons
|
|
(
|
|
const List<Field<point> >& polygons
|
|
)
|
|
{
|
|
mode_ = mtPolygon;
|
|
|
|
label nPoints = 0;
|
|
forAll(polygons, polyI)
|
|
{
|
|
label np = polygons[polyI].size();
|
|
if (np < 3)
|
|
{
|
|
FatalIOErrorIn
|
|
(
|
|
"Foam::ParticleCollector<CloudType>::initPolygons()",
|
|
this->coeffDict()
|
|
)
|
|
<< "polygons must consist of at least 3 points"
|
|
<< exit(FatalIOError);
|
|
}
|
|
|
|
nPoints += np;
|
|
}
|
|
|
|
label pointOffset = 0;
|
|
points_.setSize(nPoints);
|
|
faces_.setSize(polygons.size());
|
|
faceTris_.setSize(polygons.size());
|
|
area_.setSize(polygons.size());
|
|
forAll(faces_, faceI)
|
|
{
|
|
const Field<point>& polyPoints = polygons[faceI];
|
|
face f(identity(polyPoints.size()) + pointOffset);
|
|
UIndirectList<point>(points_, f) = polyPoints;
|
|
area_[faceI] = f.mag(points_);
|
|
|
|
DynamicList<face> tris;
|
|
f.triangles(points_, tris);
|
|
faceTris_[faceI].transfer(tris);
|
|
|
|
faces_[faceI].transfer(f);
|
|
|
|
pointOffset += polyPoints.size();
|
|
}
|
|
}
|
|
|
|
|
|
template<class CloudType>
|
|
void Foam::ParticleCollector<CloudType>::initConcentricCircles()
|
|
{
|
|
mode_ = mtConcentricCircle;
|
|
|
|
vector origin(this->coeffDict().lookup("origin"));
|
|
|
|
radius_ = this->coeffDict().lookup("radius");
|
|
nSector_ = readLabel(this->coeffDict().lookup("nSector"));
|
|
|
|
label nS = nSector_;
|
|
|
|
vector refDir;
|
|
if (nSector_ > 1)
|
|
{
|
|
refDir = this->coeffDict().lookup("refDir");
|
|
refDir -= normal_[0]*(normal_[0] & refDir);
|
|
refDir /= mag(refDir);
|
|
}
|
|
else
|
|
{
|
|
// set 4 quadrants for single sector cases
|
|
nS = 4;
|
|
|
|
vector tangent = vector::zero;
|
|
scalar magTangent = 0.0;
|
|
|
|
Random rnd(1234);
|
|
while (magTangent < SMALL)
|
|
{
|
|
vector v = rnd.vector01();
|
|
|
|
tangent = v - (v & normal_[0])*normal_[0];
|
|
magTangent = mag(tangent);
|
|
}
|
|
|
|
refDir = tangent/magTangent;
|
|
}
|
|
|
|
scalar dTheta = 5.0;
|
|
scalar dThetaSector = 360.0/scalar(nS);
|
|
label intervalPerSector = max(1, ceil(dThetaSector/dTheta));
|
|
dTheta = dThetaSector/scalar(intervalPerSector);
|
|
|
|
label nPointPerSector = intervalPerSector + 1;
|
|
|
|
label nPointPerRadius = nS*(nPointPerSector - 1);
|
|
label nPoint = radius_.size()*nPointPerRadius;
|
|
label nFace = radius_.size()*nS;
|
|
|
|
// add origin
|
|
nPoint++;
|
|
|
|
points_.setSize(nPoint);
|
|
faces_.setSize(nFace);
|
|
area_.setSize(nFace);
|
|
|
|
coordSys_ = cylindricalCS("coordSys", origin, normal_[0], refDir, false);
|
|
|
|
List<label> ptIDs(identity(nPointPerRadius));
|
|
|
|
points_[0] = origin;
|
|
|
|
// points
|
|
forAll(radius_, radI)
|
|
{
|
|
label pointOffset = radI*nPointPerRadius + 1;
|
|
|
|
for (label i = 0; i < nPointPerRadius; i++)
|
|
{
|
|
label pI = i + pointOffset;
|
|
point pCyl(radius_[radI], degToRad(i*dTheta), 0.0);
|
|
points_[pI] = coordSys_.globalPosition(pCyl);
|
|
}
|
|
}
|
|
|
|
// faces
|
|
DynamicList<label> facePts(2*nPointPerSector);
|
|
forAll(radius_, radI)
|
|
{
|
|
if (radI == 0)
|
|
{
|
|
for (label secI = 0; secI < nS; secI++)
|
|
{
|
|
facePts.clear();
|
|
|
|
// append origin point
|
|
facePts.append(0);
|
|
|
|
for (label ptI = 0; ptI < nPointPerSector; ptI++)
|
|
{
|
|
label i = ptI + secI*(nPointPerSector - 1);
|
|
label id = ptIDs.fcIndex(i - 1) + 1;
|
|
facePts.append(id);
|
|
}
|
|
|
|
label faceI = secI + radI*nS;
|
|
|
|
faces_[faceI] = face(facePts);
|
|
area_[faceI] = faces_[faceI].mag(points_);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
for (label secI = 0; secI < nS; secI++)
|
|
{
|
|
facePts.clear();
|
|
|
|
label offset = (radI - 1)*nPointPerRadius + 1;
|
|
|
|
for (label ptI = 0; ptI < nPointPerSector; ptI++)
|
|
{
|
|
label i = ptI + secI*(nPointPerSector - 1);
|
|
label id = offset + ptIDs.fcIndex(i - 1);
|
|
facePts.append(id);
|
|
}
|
|
for (label ptI = nPointPerSector-1; ptI >= 0; ptI--)
|
|
{
|
|
label i = ptI + secI*(nPointPerSector - 1);
|
|
label id = offset + nPointPerRadius + ptIDs.fcIndex(i - 1);
|
|
facePts.append(id);
|
|
}
|
|
|
|
label faceI = secI + radI*nS;
|
|
|
|
faces_[faceI] = face(facePts);
|
|
area_[faceI] = faces_[faceI].mag(points_);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
template<class CloudType>
|
|
void Foam::ParticleCollector<CloudType>::collectParcelPolygon
|
|
(
|
|
const point& p1,
|
|
const point& p2
|
|
) const
|
|
{
|
|
label dummyNearType = -1;
|
|
label dummyNearLabel = -1;
|
|
|
|
forAll(faces_, faceI)
|
|
{
|
|
const label facePoint0 = faces_[faceI][0];
|
|
|
|
const point& pf = points_[facePoint0];
|
|
|
|
const scalar d1 = normal_[faceI] & (p1 - pf);
|
|
const scalar d2 = normal_[faceI] & (p2 - pf);
|
|
|
|
if (sign(d1) == sign(d2))
|
|
{
|
|
// did not cross polygon plane
|
|
continue;
|
|
}
|
|
|
|
// intersection point
|
|
const point pIntersect = p1 + (d1/(d1 - d2))*(p2 - p1);
|
|
|
|
const List<face>& tris = faceTris_[faceI];
|
|
|
|
// identify if point is within poly bounds
|
|
forAll(tris, triI)
|
|
{
|
|
const face& tri = tris[triI];
|
|
triPointRef t
|
|
(
|
|
points_[tri[0]],
|
|
points_[tri[1]],
|
|
points_[tri[2]]
|
|
);
|
|
|
|
if (t.classify(pIntersect, dummyNearType, dummyNearLabel))
|
|
{
|
|
hitFaceIDs_.append(faceI);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
template<class CloudType>
|
|
void Foam::ParticleCollector<CloudType>::collectParcelConcentricCircles
|
|
(
|
|
const point& p1,
|
|
const point& p2
|
|
) const
|
|
{
|
|
label secI = -1;
|
|
|
|
const scalar d1 = normal_[0] & (p1 - coordSys_.origin());
|
|
const scalar d2 = normal_[0] & (p2 - coordSys_.origin());
|
|
|
|
if (sign(d1) == sign(d2))
|
|
{
|
|
// did not cross plane
|
|
return;
|
|
}
|
|
|
|
// intersection point in cylindrical co-ordinate system
|
|
const point pCyl = coordSys_.localPosition(p1 + (d1/(d1 - d2))*(p2 - p1));
|
|
|
|
scalar r = pCyl[0];
|
|
|
|
if (r < radius_.last())
|
|
{
|
|
label radI = 0;
|
|
while (r > radius_[radI])
|
|
{
|
|
radI++;
|
|
}
|
|
|
|
if (nSector_ == 1)
|
|
{
|
|
secI = 4*radI;
|
|
}
|
|
else
|
|
{
|
|
scalar theta = pCyl[1] + constant::mathematical::pi;
|
|
|
|
secI =
|
|
nSector_*radI
|
|
+ floor
|
|
(
|
|
scalar(nSector_)*theta/constant::mathematical::twoPi
|
|
);
|
|
}
|
|
}
|
|
|
|
hitFaceIDs_.append(secI);
|
|
}
|
|
|
|
|
|
template<class CloudType>
|
|
void Foam::ParticleCollector<CloudType>::write()
|
|
{
|
|
const fvMesh& mesh = this->owner().mesh();
|
|
const Time& time = mesh.time();
|
|
scalar timeNew = time.value();
|
|
scalar timeElapsed = timeNew - timeOld_;
|
|
|
|
totalTime_ += timeElapsed;
|
|
|
|
const scalar alpha = (totalTime_ - timeElapsed)/totalTime_;
|
|
const scalar beta = timeElapsed/totalTime_;
|
|
|
|
forAll(faces_, faceI)
|
|
{
|
|
massFlowRate_[faceI] =
|
|
alpha*massFlowRate_[faceI] + beta*mass_[faceI]/timeElapsed;
|
|
massTotal_[faceI] += mass_[faceI];
|
|
}
|
|
|
|
const label procI = Pstream::myProcNo();
|
|
|
|
Info<< type() << " output:" << nl;
|
|
|
|
Field<scalar> faceMassTotal(mass_.size(), 0.0);
|
|
this->getModelProperty("massTotal", faceMassTotal);
|
|
|
|
Field<scalar> faceMassFlowRate(massFlowRate_.size(), 0.0);
|
|
this->getModelProperty("massFlowRate", faceMassFlowRate);
|
|
|
|
|
|
scalar sumTotalMass = 0.0;
|
|
scalar sumAverageMFR = 0.0;
|
|
forAll(faces_, faceI)
|
|
{
|
|
scalarList allProcMass(Pstream::nProcs());
|
|
allProcMass[procI] = massTotal_[faceI];
|
|
Pstream::gatherList(allProcMass);
|
|
faceMassTotal[faceI] += sum(allProcMass);
|
|
|
|
scalarList allProcMassFlowRate(Pstream::nProcs());
|
|
allProcMassFlowRate[procI] = massFlowRate_[faceI];
|
|
Pstream::gatherList(allProcMassFlowRate);
|
|
faceMassFlowRate[faceI] += sum(allProcMassFlowRate);
|
|
|
|
sumTotalMass += faceMassTotal[faceI];
|
|
sumAverageMFR += faceMassFlowRate[faceI];
|
|
|
|
if (outputFilePtr_.valid())
|
|
{
|
|
outputFilePtr_()
|
|
<< time.timeName()
|
|
<< tab << faceI
|
|
<< tab << faceMassTotal[faceI]
|
|
<< tab << faceMassFlowRate[faceI]
|
|
<< endl;
|
|
}
|
|
}
|
|
|
|
Info<< " sum(total mass) = " << sumTotalMass << nl
|
|
<< " sum(average mass flow rate) = " << sumAverageMFR << nl
|
|
<< endl;
|
|
|
|
|
|
if (surfaceFormat_ != "none")
|
|
{
|
|
if (Pstream::master())
|
|
{
|
|
autoPtr<surfaceWriter> writer(surfaceWriter::New(surfaceFormat_));
|
|
|
|
writer->write
|
|
(
|
|
this->outputTimeDir(),
|
|
"collector",
|
|
points_,
|
|
faces_,
|
|
"massTotal",
|
|
faceMassTotal,
|
|
false
|
|
);
|
|
|
|
writer->write
|
|
(
|
|
this->outputTimeDir(),
|
|
"collector",
|
|
points_,
|
|
faces_,
|
|
"massFlowRate",
|
|
faceMassFlowRate,
|
|
false
|
|
);
|
|
}
|
|
}
|
|
|
|
|
|
if (resetOnWrite_)
|
|
{
|
|
Field<scalar> dummy(faceMassTotal.size(), 0.0);
|
|
this->setModelProperty("massTotal", dummy);
|
|
this->setModelProperty("massFlowRate", dummy);
|
|
|
|
timeOld_ = timeNew;
|
|
totalTime_ = 0.0;
|
|
}
|
|
else
|
|
{
|
|
this->setModelProperty("massTotal", faceMassTotal);
|
|
this->setModelProperty("massFlowRate", faceMassFlowRate);
|
|
}
|
|
|
|
forAll(faces_, faceI)
|
|
{
|
|
mass_[faceI] = 0.0;
|
|
massTotal_[faceI] = 0.0;
|
|
massFlowRate_[faceI] = 0.0;
|
|
}
|
|
}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
|
|
|
|
template<class CloudType>
|
|
Foam::ParticleCollector<CloudType>::ParticleCollector
|
|
(
|
|
const dictionary& dict,
|
|
CloudType& owner,
|
|
const word& modelName
|
|
)
|
|
:
|
|
CloudFunctionObject<CloudType>(dict, owner, modelName, typeName),
|
|
mode_(mtUnknown),
|
|
parcelType_(this->coeffDict().lookupOrDefault("parcelType", -1)),
|
|
removeCollected_(this->coeffDict().lookup("removeCollected")),
|
|
points_(),
|
|
faces_(),
|
|
faceTris_(),
|
|
nSector_(0),
|
|
radius_(),
|
|
coordSys_(false),
|
|
normal_(),
|
|
negateParcelsOppositeNormal_
|
|
(
|
|
readBool(this->coeffDict().lookup("negateParcelsOppositeNormal"))
|
|
),
|
|
surfaceFormat_(this->coeffDict().lookup("surfaceFormat")),
|
|
resetOnWrite_(this->coeffDict().lookup("resetOnWrite")),
|
|
totalTime_(0.0),
|
|
mass_(),
|
|
massTotal_(),
|
|
massFlowRate_(),
|
|
log_(this->coeffDict().lookup("log")),
|
|
outputFilePtr_(),
|
|
timeOld_(owner.mesh().time().value()),
|
|
hitFaceIDs_()
|
|
{
|
|
normal_ /= mag(normal_);
|
|
|
|
word mode(this->coeffDict().lookup("mode"));
|
|
if (mode == "polygon")
|
|
{
|
|
List<Field<point> > polygons(this->coeffDict().lookup("polygons"));
|
|
|
|
initPolygons(polygons);
|
|
|
|
vector n0(this->coeffDict().lookup("normal"));
|
|
normal_ = vectorField(faces_.size(), n0);
|
|
}
|
|
else if (mode == "polygonWithNormal")
|
|
{
|
|
List<Tuple2<Field<point>, vector> > polygonAndNormal
|
|
(
|
|
this->coeffDict().lookup("polygons")
|
|
);
|
|
|
|
List<Field<point> > polygons(polygonAndNormal.size());
|
|
normal_.setSize(polygonAndNormal.size());
|
|
|
|
forAll(polygons, polyI)
|
|
{
|
|
polygons[polyI] = polygonAndNormal[polyI].first();
|
|
normal_[polyI] = polygonAndNormal[polyI].second();
|
|
normal_[polyI] /= mag(normal_[polyI]) + ROOTVSMALL;
|
|
}
|
|
|
|
initPolygons(polygons);
|
|
}
|
|
else if (mode == "concentricCircle")
|
|
{
|
|
vector n0(this->coeffDict().lookup("normal"));
|
|
normal_ = vectorField(1, n0);
|
|
|
|
initConcentricCircles();
|
|
}
|
|
else
|
|
{
|
|
FatalIOErrorIn
|
|
(
|
|
"Foam::ParticleCollector<CloudType>::ParticleCollector"
|
|
"("
|
|
"const dictionary&,"
|
|
"CloudType&, "
|
|
"const word&"
|
|
")",
|
|
this->coeffDict()
|
|
)
|
|
<< "Unknown mode " << mode << ". Available options are "
|
|
<< "polygon, polygonWithNormal and concentricCircle"
|
|
<< exit(FatalIOError);
|
|
}
|
|
|
|
mass_.setSize(faces_.size(), 0.0);
|
|
massTotal_.setSize(faces_.size(), 0.0);
|
|
massFlowRate_.setSize(faces_.size(), 0.0);
|
|
|
|
makeLogFile(faces_, points_, area_);
|
|
}
|
|
|
|
|
|
template<class CloudType>
|
|
Foam::ParticleCollector<CloudType>::ParticleCollector
|
|
(
|
|
const ParticleCollector<CloudType>& pc
|
|
)
|
|
:
|
|
CloudFunctionObject<CloudType>(pc),
|
|
mode_(pc.mode_),
|
|
parcelType_(pc.parcelType_),
|
|
removeCollected_(pc.removeCollected_),
|
|
points_(pc.points_),
|
|
faces_(pc.faces_),
|
|
faceTris_(pc.faceTris_),
|
|
nSector_(pc.nSector_),
|
|
radius_(pc.radius_),
|
|
coordSys_(pc.coordSys_),
|
|
normal_(pc.normal_),
|
|
negateParcelsOppositeNormal_(pc.negateParcelsOppositeNormal_),
|
|
surfaceFormat_(pc.surfaceFormat_),
|
|
resetOnWrite_(pc.resetOnWrite_),
|
|
totalTime_(pc.totalTime_),
|
|
mass_(pc.mass_),
|
|
massTotal_(pc.massTotal_),
|
|
massFlowRate_(pc.massFlowRate_),
|
|
log_(pc.log_),
|
|
outputFilePtr_(),
|
|
timeOld_(0.0),
|
|
hitFaceIDs_()
|
|
{}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
|
|
|
|
template<class CloudType>
|
|
Foam::ParticleCollector<CloudType>::~ParticleCollector()
|
|
{}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
|
|
|
|
template<class CloudType>
|
|
void Foam::ParticleCollector<CloudType>::postMove
|
|
(
|
|
const parcelType& p,
|
|
const label cellI,
|
|
const scalar dt,
|
|
const point& position0,
|
|
bool& keepParticle
|
|
)
|
|
{
|
|
if ((parcelType_ != -1) && (parcelType_ != p.typeId()))
|
|
{
|
|
return;
|
|
}
|
|
|
|
// slightly extend end position to avoid falling within tracking tolerances
|
|
const point position1 = position0 + 1.0001*(p.position() - position0);
|
|
|
|
hitFaceIDs_.clear();
|
|
|
|
switch (mode_)
|
|
{
|
|
case mtPolygon:
|
|
{
|
|
collectParcelPolygon(position0, position1);
|
|
break;
|
|
}
|
|
case mtConcentricCircle:
|
|
{
|
|
collectParcelConcentricCircles(position0, position1);
|
|
break;
|
|
}
|
|
default:
|
|
{
|
|
}
|
|
}
|
|
|
|
|
|
forAll(hitFaceIDs_, i)
|
|
{
|
|
label faceI = hitFaceIDs_[i];
|
|
scalar m = p.nParticle()*p.mass();
|
|
|
|
if (negateParcelsOppositeNormal_)
|
|
{
|
|
vector Uhat = p.U();
|
|
Uhat /= mag(Uhat) + ROOTVSMALL;
|
|
if ((Uhat & normal_[faceI]) < 0)
|
|
{
|
|
m *= -1.0;
|
|
}
|
|
}
|
|
|
|
// add mass contribution
|
|
mass_[faceI] += m;
|
|
|
|
if (nSector_ == 1)
|
|
{
|
|
mass_[faceI + 1] += m;
|
|
mass_[faceI + 2] += m;
|
|
mass_[faceI + 3] += m;
|
|
}
|
|
|
|
if (removeCollected_)
|
|
{
|
|
keepParticle = false;
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
// ************************************************************************* //
|