cloudLagrangianFieldSourceTemplates.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 "cloudLagrangianFieldSource.H"
#include "LagrangianModel.H"
#include "cloud.H"
#include "CloudTypes.H"
 
// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
 
template<class Derived>
Foam::cloudLagrangianFieldSource::cloudLagrangianFieldSource
(
    const Derived& field
)
:
    field_(static_cast<const LagrangianFieldSourceBase&>(field)),
    cloud_
    (
        field_.db().template foundType<Foam::cloud>()
      ? field_.db().template lookupType<Foam::cloud>()
      : NullObjectRef<Foam::cloud>()
    )
{}
 
 
// * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * * //
 
template<class Cloud, class ... Clouds>
bool Foam::cloudLagrangianFieldSource::isCloud() const
{
    if (isNull(cloud_))
    {
        return false;
    }
    else
    {
        return CloudTypes<Cloud, Clouds ...>::isA(cloud_);
    }
}
 
 
template<class Cloud, class ... Clouds>
void Foam::cloudLagrangianFieldSource::assertCloud() const
{
    if (!isCloud<Cloud, Clouds ...>())
    {
        FatalErrorInFunction
            << "The '" << field_.type() << "' source of field '"
            << (field_.db().dbDir()/field_.internalName()).c_str()
            << "' of cloud '" << cloud_.mesh().name()
            << "' requires a cloud of type "
            << CloudTypes<Cloud, Clouds ...>::typesString("or").c_str()
            << " (or a derivation thereof), rather than '" << cloud_.type()
            << "'" << exit(FatalError);
    }
}
 
 
template<class Cloud, class ... Clouds>
void Foam::cloudLagrangianFieldSource::assertCloud
(
    const LagrangianModel& model
) const
{
    if (!isCloud<Cloud, Clouds ...>())
    {
        FatalErrorInFunction
            << "The '" << field_.type() << "' source of field '"
            << (field_.db().dbDir()/field_.internalName()).c_str()
            << "' for the '" << model.type() << "' Lagrangian model '"
            << model.name() << "' of cloud '" << cloud_.mesh().name()
            << "' requires a cloud of type "
            << CloudTypes<Cloud, Clouds ...>::typesString("or").c_str()
            << " (or a derivation thereof), rather than '" << cloud_.type()
            << "'" << exit(FatalError);
    }
}
 
 
template<class Cloud>
const Cloud& Foam::cloudLagrangianFieldSource::cloud() const
{
    assertCloud<Cloud>();
 
    return refCast<const Cloud>(cloud_);
}
 
 
template<class Cloud>
const Cloud& Foam::cloudLagrangianFieldSource::cloud
(
    const LagrangianModel& model
) const
{
    assertCloud<Cloud>(model);
 
    return refCast<const Cloud>(cloud_);
}
 
 
// ************************************************************************* //