distributionLagrangianScalarFieldSource.C

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  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 "distributionLagrangianScalarFieldSource.H"
#include "addToRunTimeSelectionTable.H"
 
// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
 
Foam::distributionLagrangianScalarFieldSource::
distributionLagrangianScalarFieldSource
(
    const regIOobject& iIo,
    const dictionary& dict
)
:
    LagrangianScalarFieldSource(iIo, dict),
    distribution_
    (
        distribution::New
        (
            internalDimensions(),
            dict.subDict("distribution"),
            0,
            randomGenerator::seed(iIo.name() + ':' + dict.dictName())
        )
    ),
    timeIndex_(-1)
{}
 
 
Foam::distributionLagrangianScalarFieldSource::
distributionLagrangianScalarFieldSource
(
    const distributionLagrangianScalarFieldSource& field,
    const regIOobject& iIo
)
:
    LagrangianScalarFieldSource(field, iIo),
    distribution_(field.distribution_, false),
    timeIndex_(-1)
{}
 
 
// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
 
Foam::distributionLagrangianScalarFieldSource::
~distributionLagrangianScalarFieldSource()
{}
 
 
// * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * * //
 
Foam::tmp<Foam::LagrangianSubScalarField>
Foam::distributionLagrangianScalarFieldSource::value
(
    const LagrangianInjection& injection,
    const LagrangianSubMesh& subMesh
) const
{
    // Restart the distribution if the time index has not changed. This ensures
    // multiple evaluations from different conditions and/or iterations
    // generate the same values
    distribution_->start(timeIndex_ == time().timeIndex());
    timeIndex_ = time().timeIndex();
 
    // Sample the distribution and return the result as a sub-field
    return
        LagrangianSubScalarField::New
        (
            internalField().name() + ":" + injection.name(),
            subMesh,
            internalDimensions(),
            distribution_->sample(subMesh.size())
        );
}
 
 
void Foam::distributionLagrangianScalarFieldSource::write(Ostream& os) const
{
    LagrangianScalarFieldSource::write(os);
 
    writeEntry(os, "distribution", internalDimensions(), distribution_());
}
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
    makeLagrangianTypeFieldSource
    (
        LagrangianScalarFieldSource,
        distributionLagrangianScalarFieldSource
    );
}
 
// ************************************************************************* //