data/src/Lagrangian/cloud/LagrangianModels/diskInjection/diskInjection.C

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2025-2026 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 "LagrangianMesh.H"
#include "LagrangianSubFieldsFwd.H"
#include "diskInjection.H"
#include "addToRunTimeSelectionTable.H"
#include "LagrangianFields.H"
#include "mathematicalConstants.H"

// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //

namespace Foam
{
namespace Lagrangian
{
    defineTypeNameAndDebug(diskInjection, 0);
    addToRunTimeSelectionTable(LagrangianModel, diskInjection, dictionary);
}
}


// * * * * * * * * * * * * * Private Member Functions  * * * * * * * * * * * //

void Foam::Lagrangian::diskInjection::readCoeffs(const dictionary& modelDict)
{
    centre_.reset
    (
        Function1<vector>::New
        (
            "centre",
            mesh().time().userUnits(),
            dimensions::length,
            modelDict
        ).ptr()
    );

    axis_.reset
    (
        Function1<vector>::New
        (
            "axis",
            mesh().time().userUnits(),
            dimless,
            modelDict
        ).ptr()
    );

    const bool haveDiameter = modelDict.found("diameter");
    const bool haveInnerDiameter = modelDict.found("innerDiameter");
    const bool haveOuterDiameter = modelDict.found("outerDiameter");

    if (haveDiameter == (haveInnerDiameter || haveOuterDiameter))
    {
        FatalIOErrorInFunction(modelDict)
            << "keywords diameter and innerDiameter/outerDiameter are both "
            << (haveDiameter ? "" : "un") << "defined in "
            << "dictionary " << modelDict.name()
            << exit(FatalIOError);
    }

    if (haveInnerDiameter != haveOuterDiameter)
    {
        FatalIOErrorInFunction(modelDict)
            << "keywords innerDiameter and outerDiameter are not both defined "
            << "in dictionary " << modelDict.name()
            << exit(FatalIOError);
    }

    if (haveDiameter)
    {
        innerDiameter_ = 0;
        outerDiameter_ =
            modelDict.lookup<scalar>("diameter", dimensions::length);
    }
    else
    {
        innerDiameter_ =
            modelDict.lookup<scalar>("innerDiameter", dimensions::length);
        outerDiameter_ =
            modelDict.lookup<scalar>("outerDiameter", dimensions::length);
    }

    numberRate_.reset
    (
        Function1<scalar>::New
        (
            "numberRate",
            mesh().time().userUnits(),
            dimensions::rate,
            modelDict
        ).ptr()
    );

    numberDeferred_ = 0;
}


// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //

Foam::Lagrangian::diskInjection::diskInjection
(
    const word& name,
    const LagrangianMesh& mesh,
    const dictionary& modelDict,
    const dictionary& stateDict
)
:
    LagrangianInjection(name, mesh),
    centre_(nullptr),
    axis_(nullptr),
    innerDiameter_(NaN),
    outerDiameter_(NaN),
    numberRate_(nullptr),
    numberDeferred_(stateDict.lookupOrDefault<scalar>("numberDeferred", 0)),
    rndGen_("rndGen", stateDict, name, true),
    timeIndex_(-1)
{
    readCoeffs(modelDict);
}


// * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * * //

const Foam::dimensionedScalar Foam::Lagrangian::diskInjection::area() const
{
    return
        dimensionedScalar
        (
            dimensions::area,
            constant::mathematical::pi
           *(sqr(outerDiameter_) - sqr(innerDiameter_))
        );
}


const Foam::LagrangianSubVectorField&
Foam::Lagrangian::diskInjection::axis() const
{
    if (!axisPtr_.valid())
    {
        FatalErrorInFunction
            << "Axis requested outside of the injection"
            << exit(FatalError);
    }

    return axisPtr_();
}


const Foam::LagrangianSubScalarField&
Foam::Lagrangian::diskInjection::rFrac() const
{
    if (!rFracPtr_.valid())
    {
        FatalErrorInFunction
            << "Radius fraction requested outside of the injection"
            << exit(FatalError);
    }

    return rFracPtr_();
}


const Foam::LagrangianSubVectorField&
Foam::Lagrangian::diskInjection::radial() const
{
    if (!radialPtr_.valid())
    {
        FatalErrorInFunction
            << "Axis requested outside of the injection"
            << exit(FatalError);
    }

    return radialPtr_();
}


Foam::LagrangianSubMesh Foam::Lagrangian::diskInjection::modify
(
    LagrangianMesh& mesh,
    const LagrangianSubMesh&
) const
{
    const scalar t1 = mesh.time().value();
    const scalar t0 = t1 - mesh.time().deltaT().value();

    // Restart the generator if necessary and set the time index up to date
    rndGen_.start(timeIndex_ == time().timeIndex());
    timeIndex_ = time().timeIndex();

    // Calculate the number of particles to inject. Round down to get an
    // integer number. Store the excess to apply at a later time.
    const scalar number = numberRate_->integral(t0, t1) + numberDeferred_;
    const label numberInt = floor(number);
    numberDeferred_ = number - numberInt;

    // Inject at random times throughout the time-step
    scalarField fraction(rndGen_.scalar01(numberInt));

    // Evaluate the variable centre and axis, and create radial vectors to
    // complete the local coordinate system
    tmp<pointField> centre(centre_->value(t0 + fraction*(t1 - t0)));
    tmp<vectorField> axis(normalised(axis_->value(t0 + fraction*(t1 - t0))));
    tmp<vectorField> radial1(normalised(perpendicular(axis())));
    tmp<vectorField> radial2(axis() ^ radial1());

    // Create random radii within and angles around the disk
    tmp<scalarField> rFrac(rndGen_.scalar01(numberInt));
    tmp<scalarField> r
    (
        sqrt
        (
            (1 - rFrac())*sqr(innerDiameter_/2)
          + rFrac()*sqr(outerDiameter_/2)
        )
    );
    tmp<scalarField> phi
    (
        constant::mathematical::twoPi*rndGen_.scalar01(numberInt)
    );

    // Evaluate the radial vector
    tmp<vectorField> radial(cos(phi())*radial1 + sin(phi())*radial2);
    phi.clear();

    // Evaluate the positions
    const pointField positions(centre + r*radial());

    // Locate within the mesh
    barycentricField coordinates(number);
    labelField celli(number, -1), facei(number), faceTrii(number);
    const List<LagrangianMesh::location> locations =
        mesh.locate
        (
            positions,
            coordinates,
            celli,
            facei,
            faceTrii,
            fraction
        );

    // Check for any failures
    checkLocation(locations, positions);

    // Remove particles not on this process
    filter
    (
        coordinates,
        celli,
        facei,
        faceTrii,
        fraction,
        axis.ref(),
        rFrac.ref(),
        radial.ref()
    );

    // Construct the injection sub-mesh
    const LagrangianSubMesh injectionMesh = mesh.injectionMesh(numberInt);

    // Cache the geometry for use by source conditions
    axisPtr_.set
    (
        LagrangianSubVectorField::New
        (
            "axis",
            injectionMesh,
            dimless,
            axis
        ).ptr()
    );
    rFracPtr_.set
    (
        LagrangianSubScalarField::New
        (
            "rFrac",
            injectionMesh,
            dimless,
            rFrac
        ).ptr()
    );
    radialPtr_.set
    (
        LagrangianSubVectorField::New
        (
            "radial",
            injectionMesh,
            dimless,
            radial
        ).ptr()
    );

    // Inject particles
    mesh.inject
    (
        *this,
        injectionMesh,
        coordinates,
        celli,
        facei,
        faceTrii,
        LagrangianMesh::fractionName,
        fraction
    );

    // Clean up
    axisPtr_.clear();
    rFracPtr_.clear();
    radialPtr_.clear();

    return injectionMesh;
}


bool Foam::Lagrangian::diskInjection::read(const dictionary& modelDict)
{
    if (LagrangianInjection::read(modelDict))
    {
        readCoeffs(modelDict);
        return true;
    }
    else
    {
        return false;
    }
}


void Foam::Lagrangian::diskInjection::writeState(Ostream& os) const
{
    LagrangianInjection::writeState(os);

    writeEntry(os, "numberDeferred", numberDeferred_);
    writeEntry(os, "rndGen", rndGen_);
}


// ************************************************************************* //