580 lines
14 KiB
C++
580 lines
14 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration | Website: https://openfoam.org
|
|
\\ / A nd | Copyright (C) 2011-2021 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 "streamlinesParticle.H"
|
|
#include "streamlinesCloud.H"
|
|
#include "vectorFieldIOField.H"
|
|
#include "scalarFieldIOField.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
typedef IOList<transformer> transformerIOList;
|
|
|
|
defineTemplateTypeNameAndDebugWithName
|
|
(
|
|
transformerIOList,
|
|
"transformerList",
|
|
0
|
|
);
|
|
}
|
|
|
|
|
|
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
|
|
|
|
Foam::vector Foam::streamlinesParticle::interpolateFields
|
|
(
|
|
const trackingData& td,
|
|
const point& position,
|
|
const label celli,
|
|
const label facei
|
|
)
|
|
{
|
|
if (celli == -1)
|
|
{
|
|
FatalErrorInFunction
|
|
<< "Cell:" << celli << abort(FatalError);
|
|
}
|
|
|
|
sampledScalars_.setSize(td.vsInterp_.size());
|
|
forAll(td.vsInterp_, scalarI)
|
|
{
|
|
const scalar s =
|
|
td.vsInterp_[scalarI].interpolate(position, celli, facei);
|
|
|
|
sampledScalars_[scalarI].append
|
|
(
|
|
td.trackOutside_ ? transform_.invTransform(s) : s
|
|
);
|
|
}
|
|
|
|
vector U = vector::uniform(NaN);
|
|
|
|
sampledVectors_.setSize(td.vvInterp_.size());
|
|
forAll(td.vvInterp_, vectorI)
|
|
{
|
|
const vector v =
|
|
td.vvInterp_[vectorI].interpolate(position, celli, facei);
|
|
|
|
if (vectorI == td.UIndex_)
|
|
{
|
|
U = v;
|
|
}
|
|
|
|
sampledVectors_[vectorI].append
|
|
(
|
|
td.trackOutside_ ? transform_.invTransform(v) : v
|
|
);
|
|
}
|
|
|
|
return U;
|
|
}
|
|
|
|
|
|
void Foam::streamlinesParticle::endTrack(trackingData& td)
|
|
{
|
|
{
|
|
td.allPositions_.append(vectorList());
|
|
vectorList& top = td.allPositions_.last();
|
|
top.transfer(sampledPositions_);
|
|
}
|
|
|
|
{
|
|
td.allTimes_.append(scalarList());
|
|
scalarList& top = td.allTimes_.last();
|
|
top.transfer(sampledTimes_);
|
|
}
|
|
|
|
forAll(sampledScalars_, i)
|
|
{
|
|
td.allScalars_[i].append(scalarList());
|
|
scalarList& top = td.allScalars_[i].last();
|
|
top.transfer(sampledScalars_[i]);
|
|
}
|
|
|
|
forAll(sampledVectors_, i)
|
|
{
|
|
td.allVectors_[i].append(vectorList());
|
|
vectorList& top = td.allVectors_[i].last();
|
|
top.transfer(sampledVectors_[i]);
|
|
}
|
|
}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
|
|
|
|
Foam::streamlinesParticle::streamlinesParticle
|
|
(
|
|
const polyMesh& mesh,
|
|
const vector& position,
|
|
const label celli,
|
|
const label lifeTime
|
|
)
|
|
:
|
|
particle(mesh, position, celli),
|
|
lifeTime_(lifeTime),
|
|
transform_(transformer::I),
|
|
age_(0)
|
|
{}
|
|
|
|
|
|
Foam::streamlinesParticle::streamlinesParticle
|
|
(
|
|
const polyMesh& mesh,
|
|
Istream& is,
|
|
bool readFields
|
|
)
|
|
:
|
|
particle(mesh, is, readFields)
|
|
{
|
|
if (readFields)
|
|
{
|
|
List<scalarList> sampledScalars;
|
|
List<vectorList> sampledVectors;
|
|
|
|
is >> lifeTime_ >> transform_ >> age_ >> sampledPositions_
|
|
>> sampledTimes_ >> sampledScalars >> sampledVectors;
|
|
|
|
sampledScalars_.setSize(sampledScalars.size());
|
|
forAll(sampledScalars, i)
|
|
{
|
|
sampledScalars_[i].transfer(sampledScalars[i]);
|
|
}
|
|
sampledVectors_.setSize(sampledVectors.size());
|
|
forAll(sampledVectors, i)
|
|
{
|
|
sampledVectors_[i].transfer(sampledVectors[i]);
|
|
}
|
|
}
|
|
|
|
// Check state of Istream
|
|
is.check
|
|
(
|
|
"streamlinesParticle::streamlinesParticle"
|
|
"(const Cloud<streamlinesParticle>&, Istream&, bool)"
|
|
);
|
|
}
|
|
|
|
|
|
Foam::streamlinesParticle::streamlinesParticle
|
|
(
|
|
const streamlinesParticle& p
|
|
)
|
|
:
|
|
particle(p),
|
|
lifeTime_(p.lifeTime_),
|
|
transform_(p.transform_),
|
|
age_(p.age_),
|
|
sampledPositions_(p.sampledPositions_),
|
|
sampledTimes_(p.sampledTimes_),
|
|
sampledScalars_(p.sampledScalars_),
|
|
sampledVectors_(p.sampledVectors_)
|
|
{}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
|
|
|
|
bool Foam::streamlinesParticle::move
|
|
(
|
|
streamlinesCloud& cloud,
|
|
trackingData& td,
|
|
const scalar
|
|
)
|
|
{
|
|
td.switchProcessor = false;
|
|
td.keepParticle = true;
|
|
|
|
const scalar maxDt = mesh().bounds().mag();
|
|
|
|
while (td.keepParticle && !td.switchProcessor && lifeTime_ > 0)
|
|
{
|
|
scalar dt = maxDt;
|
|
|
|
// Cross cell in steps:
|
|
// - at subiter 0 calculate dt to cross cell in nSubCycle steps
|
|
// - at the last subiter do all of the remaining track
|
|
for (label subIter = 0; subIter < max(1, td.nSubCycle_); subIter++)
|
|
{
|
|
--lifeTime_;
|
|
|
|
// Store current position and sampled velocity.
|
|
sampledPositions_.append
|
|
(
|
|
td.trackOutside_
|
|
? transform_.invTransformPosition(position())
|
|
: position()
|
|
);
|
|
sampledTimes_.append(age_);
|
|
vector U = interpolateFields(td, position(), cell(), face());
|
|
|
|
if (!td.trackForward_)
|
|
{
|
|
U = -U;
|
|
}
|
|
|
|
scalar magU = mag(U);
|
|
|
|
if (magU < small)
|
|
{
|
|
// Stagnant particle. Might as well stop
|
|
lifeTime_ = 0;
|
|
break;
|
|
}
|
|
|
|
U /= magU;
|
|
|
|
if (td.trackLength_ < great)
|
|
{
|
|
// No sub-cycling. Track a set length on each step.
|
|
dt = td.trackLength_;
|
|
}
|
|
else if (subIter == 0)
|
|
{
|
|
// Sub-cycling. Cross the cell in nSubCycle steps.
|
|
particle copy(*this);
|
|
copy.trackToFace(maxDt*U, 1);
|
|
dt *= (copy.stepFraction() - stepFraction())/td.nSubCycle_;
|
|
}
|
|
else if (subIter == td.nSubCycle_ - 1)
|
|
{
|
|
// Sub-cycling. Track the whole cell on the last step.
|
|
dt = maxDt;
|
|
}
|
|
|
|
age_ +=
|
|
(td.trackForward_ ? +1 : -1)
|
|
*dt
|
|
*(1 - trackToAndHitFace(dt*U, 0, cloud, td));
|
|
|
|
if (!td.keepParticle || td.switchProcessor || lifeTime_ == 0)
|
|
{
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (!td.keepParticle || lifeTime_ == 0)
|
|
{
|
|
if (lifeTime_ == 0)
|
|
{
|
|
// Failure exit. Particle stagnated or it's life ran out.
|
|
if (debug)
|
|
{
|
|
Pout<< "streamlinesParticle: Removing stagnant particle:"
|
|
<< position() << " sampled positions:"
|
|
<< sampledPositions_.size() << endl;
|
|
}
|
|
td.keepParticle = false;
|
|
}
|
|
else
|
|
{
|
|
// Normal exit. Store last position and fields
|
|
sampledPositions_.append
|
|
(
|
|
td.trackOutside_
|
|
? transform_.invTransformPosition(position())
|
|
: position()
|
|
);
|
|
sampledTimes_.append(age_);
|
|
interpolateFields(td, position(), cell(), face());
|
|
|
|
if (debug)
|
|
{
|
|
Pout<< "streamlinesParticle: Removing particle:" << position()
|
|
<< " sampled positions:" << sampledPositions_.size()
|
|
<< endl;
|
|
}
|
|
}
|
|
|
|
// End this track
|
|
endTrack(td);
|
|
}
|
|
|
|
return td.keepParticle;
|
|
}
|
|
|
|
|
|
bool Foam::streamlinesParticle::hitPatch(streamlinesCloud&, trackingData&)
|
|
{
|
|
// Disable generic patch interaction
|
|
return false;
|
|
}
|
|
|
|
|
|
void Foam::streamlinesParticle::hitWedgePatch
|
|
(
|
|
streamlinesCloud&,
|
|
trackingData& td
|
|
)
|
|
{
|
|
// Remove particle
|
|
td.keepParticle = false;
|
|
}
|
|
|
|
|
|
void Foam::streamlinesParticle::hitSymmetryPlanePatch
|
|
(
|
|
streamlinesCloud&,
|
|
trackingData& td
|
|
)
|
|
{
|
|
// Remove particle
|
|
td.keepParticle = false;
|
|
}
|
|
|
|
|
|
void Foam::streamlinesParticle::hitSymmetryPatch
|
|
(
|
|
streamlinesCloud&,
|
|
trackingData& td
|
|
)
|
|
{
|
|
// Remove particle
|
|
td.keepParticle = false;
|
|
}
|
|
|
|
|
|
void Foam::streamlinesParticle::hitCyclicPatch
|
|
(
|
|
streamlinesCloud& cloud,
|
|
trackingData& td
|
|
)
|
|
{
|
|
const cyclicPolyPatch& cpp =
|
|
static_cast<const cyclicPolyPatch&>(mesh().boundaryMesh()[patch()]);
|
|
|
|
// End this track
|
|
if (!td.trackOutside_ && cpp.transform().transformsPosition())
|
|
{
|
|
endTrack(td);
|
|
}
|
|
|
|
// Move across the cyclic
|
|
particle::hitCyclicPatch(cloud, td);
|
|
}
|
|
|
|
|
|
void Foam::streamlinesParticle::hitCyclicAMIPatch
|
|
(
|
|
const vector& displacement,
|
|
const scalar fraction,
|
|
streamlinesCloud& cloud,
|
|
trackingData& td
|
|
)
|
|
{
|
|
// End this track
|
|
endTrack(td);
|
|
|
|
// Move across the cyclic
|
|
particle::hitCyclicAMIPatch(displacement, fraction, cloud, td);
|
|
}
|
|
|
|
|
|
void Foam::streamlinesParticle::hitCyclicACMIPatch
|
|
(
|
|
const vector& displacement,
|
|
const scalar fraction,
|
|
streamlinesCloud& cloud,
|
|
trackingData& td
|
|
)
|
|
{
|
|
// End this track
|
|
endTrack(td);
|
|
|
|
// Move across the cyclic
|
|
particle::hitCyclicACMIPatch(displacement, fraction, cloud, td);
|
|
}
|
|
|
|
|
|
void Foam::streamlinesParticle::hitCyclicRepeatAMIPatch
|
|
(
|
|
const vector& displacement,
|
|
const scalar fraction,
|
|
streamlinesCloud& cloud,
|
|
trackingData& td
|
|
)
|
|
{
|
|
// End this track
|
|
endTrack(td);
|
|
|
|
// Move across the cyclic
|
|
particle::hitCyclicRepeatAMIPatch(displacement, fraction, cloud, td);
|
|
}
|
|
|
|
|
|
void Foam::streamlinesParticle::hitProcessorPatch
|
|
(
|
|
streamlinesCloud&,
|
|
trackingData& td
|
|
)
|
|
{
|
|
const processorPolyPatch& ppp =
|
|
static_cast<const processorPolyPatch&>(mesh().boundaryMesh()[patch()]);
|
|
|
|
// End this track
|
|
if (!td.trackOutside_ && ppp.transform().transformsPosition())
|
|
{
|
|
endTrack(td);
|
|
}
|
|
|
|
// Switch processor
|
|
td.switchProcessor = true;
|
|
}
|
|
|
|
|
|
void Foam::streamlinesParticle::hitWallPatch
|
|
(
|
|
streamlinesCloud&,
|
|
trackingData& td
|
|
)
|
|
{
|
|
// Remove particle
|
|
td.keepParticle = false;
|
|
}
|
|
|
|
|
|
void Foam::streamlinesParticle::transformProperties
|
|
(
|
|
const transformer& transform
|
|
)
|
|
{
|
|
transform_ = transform & transform_;
|
|
}
|
|
|
|
|
|
void Foam::streamlinesParticle::readFields(Cloud<streamlinesParticle>& c)
|
|
{
|
|
bool valid = c.size();
|
|
|
|
particle::readFields(c);
|
|
|
|
IOField<label> lifeTime
|
|
(
|
|
c.fieldIOobject("lifeTime", IOobject::MUST_READ),
|
|
valid
|
|
);
|
|
c.checkFieldIOobject(c, lifeTime);
|
|
|
|
transformerIOList transform
|
|
(
|
|
c.fieldIOobject("transform", IOobject::MUST_READ),
|
|
valid
|
|
);
|
|
|
|
vectorFieldIOField sampledPositions
|
|
(
|
|
c.fieldIOobject("sampledPositions", IOobject::MUST_READ),
|
|
valid
|
|
);
|
|
c.checkFieldIOobject(c, sampledPositions);
|
|
|
|
scalarFieldIOField sampledTimes
|
|
(
|
|
c.fieldIOobject("sampledTimes", IOobject::MUST_READ),
|
|
valid
|
|
);
|
|
c.checkFieldIOobject(c, sampledTimes);
|
|
|
|
label i = 0;
|
|
forAllIter(Cloud<streamlinesParticle>, c, iter)
|
|
{
|
|
iter().lifeTime_ = lifeTime[i];
|
|
iter().transform_ = transform[i];
|
|
iter().sampledPositions_.transfer(sampledPositions[i]);
|
|
iter().sampledTimes_.transfer(sampledTimes[i]);
|
|
i++;
|
|
}
|
|
}
|
|
|
|
|
|
void Foam::streamlinesParticle::writeFields(const Cloud<streamlinesParticle>& c)
|
|
{
|
|
particle::writeFields(c);
|
|
|
|
label np = c.size();
|
|
|
|
IOField<label> lifeTime
|
|
(
|
|
c.fieldIOobject("lifeTime", IOobject::NO_READ),
|
|
np
|
|
);
|
|
|
|
transformerIOList transform
|
|
(
|
|
c.fieldIOobject("transform", IOobject::NO_READ),
|
|
np
|
|
);
|
|
|
|
vectorFieldIOField sampledPositions
|
|
(
|
|
c.fieldIOobject("sampledPositions", IOobject::NO_READ),
|
|
np
|
|
);
|
|
|
|
scalarFieldIOField sampledTimes
|
|
(
|
|
c.fieldIOobject("sampledTimes", IOobject::NO_READ),
|
|
np
|
|
);
|
|
|
|
label i = 0;
|
|
forAllConstIter(Cloud<streamlinesParticle>, c, iter)
|
|
{
|
|
lifeTime[i] = iter().lifeTime_;
|
|
transform[i] = iter().transform_;
|
|
sampledPositions[i] = iter().sampledPositions_;
|
|
sampledTimes[i] = iter().sampledTimes_;
|
|
i++;
|
|
}
|
|
|
|
lifeTime.write(np > 0);
|
|
sampledPositions.write(np > 0);
|
|
sampledTimes.write(np > 0);
|
|
}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * IOstream Operators * * * * * * * * * * * * //
|
|
|
|
Foam::Ostream& Foam::operator<<(Ostream& os, const streamlinesParticle& p)
|
|
{
|
|
os << static_cast<const particle&>(p)
|
|
<< token::SPACE << p.lifeTime_
|
|
<< token::SPACE << p.transform_
|
|
<< token::SPACE << p.age_
|
|
<< token::SPACE << p.sampledPositions_
|
|
<< token::SPACE << p.sampledTimes_
|
|
<< token::SPACE << p.sampledScalars_
|
|
<< token::SPACE << p.sampledVectors_;
|
|
|
|
// Check state of Ostream
|
|
os.check("Ostream& operator<<(Ostream&, const streamlinesParticle&)");
|
|
|
|
return os;
|
|
}
|
|
|
|
|
|
// ************************************************************************* //
|