data/src/finiteVolume/cfdTools/general/fvModels/fvModelTemplates.C

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2021-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 "fvModel.H"

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

template<class AlphaRhoFieldType, class ... AlphaRhoFieldTypes>
Foam::dimensionSet Foam::fvModel::sourceDims
(
    const dimensionSet& ds,
    const AlphaRhoFieldType& alphaRhoField,
    const AlphaRhoFieldTypes& ... alphaRhoFields
)
{
    return alphaRhoField.dimensions()*sourceDims(ds, alphaRhoFields ...);
}


template<class AlphaRhoFieldType, class ... AlphaRhoFieldTypes>
const Foam::word& Foam::fvModel::fieldName
(
    const AlphaRhoFieldType& alphaRhoField,
    const AlphaRhoFieldTypes& ... alphaRhoFields
)
{
    return fieldName(alphaRhoFields ...);
}


template<class AlphaRhoFieldType>
const Foam::word& Foam::fvModel::fieldName
(
    const AlphaRhoFieldType& alphaRhoField
)
{
    return alphaRhoField.name();
}


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

template<class Type, class ... AlphaRhoFieldTypes>
Foam::tmp<Foam::fvMatrix<Type>> Foam::fvModel::sourceTerm
(
    const VolField<Type>& eqnField,
    const dimensionSet& ds,
    const AlphaRhoFieldTypes& ... alphaRhoFields
) const
{
    tmp<fvMatrix<Type>> tmtx
    (
        new fvMatrix<Type>
        (
            eqnField,
            sourceDims(ds, alphaRhoFields ...)
        )
    );
    fvMatrix<Type>& mtx = tmtx.ref();

    if (addsSupToField(fieldName(alphaRhoFields ...)))
    {
        addSup(alphaRhoFields ..., mtx);
    }

    return tmtx;
}


// * * * * * * * * * * * * * * Member Operators  * * * * * * * * * * * * * * //

template<class Type>
Foam::tmp<Foam::fvMatrix<Type>> Foam::fvModel::sourceProxy
(
    const VolField<Type>& eqnField
) const
{
    return sourceTerm(eqnField, dimensions::volume/dimensions::time);
}


template<class Type>
Foam::tmp<Foam::fvMatrix<Type>> Foam::fvModel::source
(
    const VolField<Type>& field
) const
{
    return sourceTerm(field, dimensions::volume/dimensions::time, field);
}


template<class Type>
Foam::tmp<Foam::fvMatrix<Type>> Foam::fvModel::sourceProxy
(
    const VolField<Type>& field,
    const VolField<Type>& eqnField
) const
{
    return sourceTerm(eqnField, dimensions::volume/dimensions::time, field);
}


template<class Type>
Foam::tmp<Foam::fvMatrix<Type>> Foam::fvModel::source
(
    const volScalarField& rho,
    const VolField<Type>& field
) const
{
    return sourceTerm(field, dimensions::volume/dimensions::time, rho, field);
}


template<class Type>
Foam::tmp<Foam::fvMatrix<Type>> Foam::fvModel::sourceProxy
(
    const volScalarField& rho,
    const VolField<Type>& field,
    const VolField<Type>& eqnField
) const
{
    return sourceTerm
    (
        eqnField,
        dimensions::volume/dimensions::time,
        rho,
        field
    );
}


template<class Type>
Foam::tmp<Foam::fvMatrix<Type>> Foam::fvModel::source
(
    const volScalarField& alpha,
    const volScalarField& rho,
    const VolField<Type>& field
) const
{
    return sourceTerm
    (
        field,
        dimensions::volume/dimensions::time,
        alpha,
        rho,
        field
    );
}


template<class Type>
Foam::tmp<Foam::fvMatrix<Type>> Foam::fvModel::sourceProxy
(
    const volScalarField& alpha,
    const volScalarField& rho,
    const VolField<Type>& field,
    const VolField<Type>& eqnField
) const
{
    return sourceTerm
    (
        eqnField,
        dimensions::volume/dimensions::time,
        alpha,
        rho,
        field
    );
}


template<class Type>
Foam::tmp<Foam::fvMatrix<Type>> Foam::fvModel::source
(
    const geometricOneField& alpha,
    const geometricOneField& rho,
    const VolField<Type>& field
) const
{
    return this->source(field);
}


template<class Type>
Foam::tmp<Foam::fvMatrix<Type>> Foam::fvModel::source
(
    const volScalarField& alpha,
    const geometricOneField& rho,
    const VolField<Type>& field
) const
{
    return this->source(alpha, field);
}


template<class Type>
Foam::tmp<Foam::fvMatrix<Type>> Foam::fvModel::source
(
    const geometricOneField& alpha,
    const volScalarField& rho,
    const VolField<Type>& field
) const
{
    return this->source(rho, field);
}


template<class Type>
Foam::tmp<Foam::fvMatrix<Type>> Foam::fvModel::d2dt2
(
    const VolField<Type>& field
) const
{
    return sourceTerm(field, dimensions::volume/sqr(dimensions::time), field);
}


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