Files
OpenFOAM-12/src/lagrangian/parcel/submodels/Momentum/InjectionModel/ManualInjection/ManualInjection.C
Will Bainbridge e1e0e258c8 distributions: Generalise usage
The distributions have been extended in various ways to permit usage in
a greater variety of situations...

The distributions now have write methods which allow a distribution to
be written into a field file for restart, therby permitting their usage
in boundary conditions and similar. Their read methods now also support
dimension-checked unit conversions for all their parameters.

An additional selector has been added that allows a distribution to be
re-constructed with a different sample size exponent.

The distributions now own their random generator, thereby simplifying
their usage and preventing the need for a (potentially dangling)
reference member. This makes sense now as the random generators do not
rely on global state; individual sub-models can and should own their own
random generator and manage its initialisation and restart. This
principle should be extended to other parts of the code in future.
2024-06-11 10:47:23 +01:00

252 lines
6.2 KiB
C++

/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2024 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 "ManualInjection.H"
#include "mathematicalConstants.H"
#include "PackedBoolList.H"
using namespace Foam::constant::mathematical;
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
template<class CloudType>
Foam::ManualInjection<CloudType>::ManualInjection
(
const dictionary& dict,
CloudType& owner,
const word& modelName
)
:
InjectionModel<CloudType>(dict, owner, modelName, typeName),
positionsFile_(this->coeffDict().lookup("positionsFile")),
positions_
(
IOobject
(
positionsFile_,
owner.db().time().constant(),
owner.mesh(),
IOobject::MUST_READ,
IOobject::NO_WRITE
)
),
diameters_(positions_.size()),
injectorCoordinates_(positions_.size(), barycentric::uniform(NaN)),
injectorCells_(positions_.size(), -1),
injectorTetFaces_(positions_.size(), -1),
injectorTetPts_(positions_.size(), -1),
massTotal_(this->readMassTotal(dict, owner)),
U0_(this->coeffDict().lookup("U0")),
sizeDistribution_
(
distribution::New
(
dimLength,
this->coeffDict().subDict("sizeDistribution"),
this->sizeSampleQ(),
owner.rndGen().generator()
)
),
ignoreOutOfBounds_
(
this->coeffDict().lookupOrDefault("ignoreOutOfBounds", false)
)
{
topoChange();
// Construct parcel diameters
forAll(diameters_, i)
{
diameters_[i] = sizeDistribution_->sample();
}
}
template<class CloudType>
Foam::ManualInjection<CloudType>::ManualInjection
(
const ManualInjection<CloudType>& im
)
:
InjectionModel<CloudType>(im),
positionsFile_(im.positionsFile_),
positions_(im.positions_),
diameters_(im.diameters_),
injectorCoordinates_(im.injectorCoordinates_),
injectorCells_(im.injectorCells_),
injectorTetFaces_(im.injectorTetFaces_),
injectorTetPts_(im.injectorTetPts_),
massTotal_(im.massTotal_),
U0_(im.U0_),
sizeDistribution_(im.sizeDistribution_, false),
ignoreOutOfBounds_(im.ignoreOutOfBounds_)
{}
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
template<class CloudType>
Foam::ManualInjection<CloudType>::~ManualInjection()
{}
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
template<class CloudType>
void Foam::ManualInjection<CloudType>::topoChange()
{
label nRejected = 0;
PackedBoolList keep(positions_.size(), true);
forAll(positions_, pI)
{
if
(
!this->findCellAtPosition
(
positions_[pI],
injectorCoordinates_[pI],
injectorCells_[pI],
injectorTetFaces_[pI],
injectorTetPts_[pI],
!ignoreOutOfBounds_
)
)
{
keep[pI] = false;
nRejected++;
}
}
if (nRejected > 0)
{
inplaceSubset(keep, positions_);
inplaceSubset(keep, diameters_);
inplaceSubset(keep, injectorCoordinates_);
inplaceSubset(keep, injectorCells_);
inplaceSubset(keep, injectorTetFaces_);
inplaceSubset(keep, injectorTetPts_);
Info<< " " << nRejected
<< " particles ignored, out of bounds" << endl;
}
}
template<class CloudType>
Foam::scalar Foam::ManualInjection<CloudType>::timeEnd() const
{
// Injection is instantaneous - but allow for a finite interval to
// avoid numerical issues when interval is zero
return rootVSmall;
}
template<class CloudType>
Foam::label Foam::ManualInjection<CloudType>::nParcelsToInject
(
const scalar time0,
const scalar time1
)
{
// All parcels introduced at SOI
if (0 >= time0 && 0 < time1)
{
return positions_.size();
}
else
{
return 0;
}
}
template<class CloudType>
Foam::scalar Foam::ManualInjection<CloudType>::massToInject
(
const scalar time0,
const scalar time1
)
{
// All parcels introduced at SOI
if (0 >= time0 && 0 < time1)
{
return massTotal_;
}
else
{
return 0;
}
}
template<class CloudType>
void Foam::ManualInjection<CloudType>::setPositionAndCell
(
const label parcelI,
const label,
const scalar,
barycentric& coordinates,
label& celli,
label& tetFacei,
label& tetPti,
label& facei
)
{
coordinates = injectorCoordinates_[parcelI];
celli = injectorCells_[parcelI];
tetFacei = injectorTetFaces_[parcelI];
tetPti = injectorTetPts_[parcelI];
}
template<class CloudType>
void Foam::ManualInjection<CloudType>::setProperties
(
const label parcelI,
const label,
const scalar,
typename CloudType::parcelType::trackingData& td,
typename CloudType::parcelType& parcel
)
{
// set particle velocity
parcel.U() = U0_;
// set particle diameter
parcel.d() = diameters_[parcelI];
}
template<class CloudType>
bool Foam::ManualInjection<CloudType>::fullyDescribed() const
{
return false;
}
// ************************************************************************* //