carriedTemplates.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 "carried.H"
#include "CarrierField.H"
 
// * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * * //
 
template<class Type>
const Foam::CarrierField<Type>& Foam::clouds::carried::carrierField
(
    const VolField<Type>& psi
) const
{
    return carrierField<Type, VolField<Type>>(psi);
}
 
 
template<class Type, class ... Args>
const Foam::CarrierField<Type>& Foam::clouds::carried::carrierField
(
    const Args& ... args
) const
{
    typename HashPtrTable<CarrierField<Type>>::iterator iter =
        carrierFields<Type>().find(CarrierField<Type>(args ...).name());
 
    if (iter != carrierFields<Type>().end()) return **iter;
 
    CarrierField<Type>* ptr = new CarrierField<Type>(args ...);
    carrierFields<Type>().insert(ptr->name(), ptr);
 
    return *ptr;
}
 
 
template<class Type>
const Foam::CarrierField<Type>& Foam::clouds::carried::noCarrierField
(
    const word& symbolicName,
    const word& descriptiveName,
    const bool isPhase
) const
{
    return
        carrierField<Type>
        (
            nameToCarrierName
            (
                symbolicName,
                isPhase ? phaseName(false) : carrierPhaseName()
            ),
            [this,descriptiveName,isPhase]()
            {
                FatalErrorInFunction
                    << "Cloud " << cloud_.name() << " does not have a "
                    << (isPhase ? "corresponding Eulerian phase" : "carrier")
                    << ' ' << descriptiveName << exit(FatalError);
                return tmp<volScalarField>(nullptr);
            }
        );
}
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //