transport.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) 2011-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 "transport.H"
#include "XiEqModel.H"
#include "XiProfile.H"
#include "XiGModel.H"
#include "fvmDiv.H"
#include "fvcLaplacian.H"
#include "fvModels.H"
#include "fvConstraints.H"
#include "addToRunTimeSelectionTable.H"
 
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
 
namespace Foam
{
namespace XiModels
{
    defineTypeNameAndDebug(transport, 0);
    addToRunTimeSelectionTable(XiModel, transport, dictionary);
}
}
 
 
// * * * * * * * * * * * * Protected Member Functions  * * * * * * * * * * * //
 
bool Foam::XiModels::transport::readCoeffs(const dictionary& dict)
{
    XiModel::readCoeffs(dict);
    strainReduction_ =
        dict.lookupOrDefault<Switch>("strainReduction", true);
    curvatureReduction_ =
        dict.lookupOrDefault<Switch>("curvatureReduction", false);
    differentialPropagation_ =
        dict.lookupOrDefault<Switch>("differentialPropagation", false);
    return true;
}
 
 
// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
 
Foam::XiModels::transport::transport
(
    const dictionary& dict,
    const ubRhoThermo& thermo,
    const compressibleMomentumTransportModel& turbulence,
    const volScalarField& Su
)
:
    XiModel(thermo, turbulence, Su),
    XiEqModel_(XiEqModel::New(dict, thermo, turbulence, Su)),
    XiProfile_(XiProfile::New(dict, b_)),
    XiGModel_(XiGModel::New(dict, thermo, turbulence, Su))
{
    readCoeffs(dict);
    Xi_.writeOpt() = IOobject::AUTO_WRITE;
}
 
 
// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
 
Foam::XiModels::transport::~transport()
{}
 
 
// * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * * //
 
Foam::tmp<Foam::volScalarField> Foam::XiModels::transport::Db() const
{
    return XiEqModel_->Db();
}
 
 
void Foam::XiModels::transport::correct()
{
    const fvMesh& mesh(thermo_.mesh());
 
    const Foam::fvModels& fvModels(Foam::fvModels::New(mesh));
    const Foam::fvConstraints& fvConstraints(Foam::fvConstraints::New(mesh));
 
    const volScalarField XiEqEta(XiEqModel_->XiEq());
 
    const volScalarField::Internal GEta(XiGModel_->G());
    const volScalarField::Internal R(GEta*XiEqEta()/(XiEqEta() - 0.999));
    const volScalarField::Internal XiEqStar(R/(R - GEta));
    const volScalarField::Internal XiEq
    (
        1 + XiProfile_->profile()()*(XiEqStar - 1)
    );
    const volScalarField::Internal G(R*(XiEq - 1)/XiEq);
 
    const surfaceScalarField& phiSt =
        mesh.lookupObject<surfaceScalarField>("phiSt");
    const volScalarField& Db = mesh.lookupObject<volScalarField>("Db");
    const volVectorField& n = mesh.lookupObject<volVectorField>("n");
    const surfaceScalarField& nf = mesh.lookupObject<surfaceScalarField>("nf");
 
    surfaceScalarField phiXi("phiXi", phiSt);
 
    if (differentialPropagation_)
    {
        phiXi += fvc::interpolate(rho_)*fvc::interpolate(Su_*(1/Xi_ - Xi_))*nf;
    }
 
    const surfaceScalarField& phi = momentumTransport_.alphaRhoPhi();
 
    fvScalarMatrix XiEqn
    (
        fvm::ddt(rho_, Xi_)
      + fvm::div(phi + phiXi, Xi_, "div(phiXi,Xi)")
      - fvm::Sp(fvc::div(phiXi), Xi_)
      - fvc::laplacian(Db, Xi_)
     ==
        rho_*R
      - fvm::Sp(rho_*(R - G), Xi_)
      + fvModels.source(rho_, Xi_)
    );
 
    if (strainReduction_)
    {
        const tmp<volTensorField> tgradU(fvc::grad(momentumTransport_.U()));
        const volTensorField::Internal& gradU(tgradU());
 
        const volScalarField::Internal rhoSigma
        (
            rho_
           *max
            (
                (n() & n())*tr(gradU) - (n & gradU & n),
                dimensionedScalar(dimless/dimTime, 0)
            )
        );
 
        XiEqn += fvm::Sp(rhoSigma, Xi_) - rhoSigma;
    }
 
    if (curvatureReduction_)
    {
        const tmp<volTensorField> tgradSt(fvc::grad(Su_*Xi_*n));
        const volTensorField::Internal& gradSt(tgradSt());
 
        const volScalarField::Internal rhoSigmaSt
        (
            rho_
           *max
            (
                (n() & n())*tr(gradSt) - (n & gradSt & n),
                dimensionedScalar(dimless/dimTime, 0)
            )
        );
 
        XiEqn += fvm::Sp(rhoSigmaSt, Xi_) - rhoSigmaSt;
    }
 
    XiEqn.relax();
 
    fvConstraints.constrain(XiEqn);
 
    XiEqn.solve();
 
    fvConstraints.constrain(Xi_);
 
    // Limit range of Xi for realisability and stability
    Xi_.max(1);
    Xi_ = min(Xi_, 2*XiEqEta);
}
 
 
// ************************************************************************* //