/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | www.openfoam.com
     \\/     M anipulation  |
-------------------------------------------------------------------------------
    Copyright (C) 2018-2020 OpenFOAM Foundation
    Copyright (C) 2021 OpenCFD Ltd.
-------------------------------------------------------------------------------
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/>.

Class
    Foam::laminarModels::generalizedNewtonian

Description
    Turbulence model for shear-dependent Non-Newtonian flow.

SourceFiles
    generalizedNewtonian.C

\*---------------------------------------------------------------------------*/

#ifndef generalizedNewtonian_H
#define generalizedNewtonian_H

#include "laminarModel.H"
#include "linearViscousStress.H"
#include "generalizedNewtonianViscosityModel.H"

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

namespace Foam
{
namespace laminarModels
{

/*---------------------------------------------------------------------------*\
                    Class generalizedNewtonian Declaration
\*---------------------------------------------------------------------------*/

template<class BasicMomentumTransportModel>
class generalizedNewtonian
:
    public linearViscousStress<laminarModel<BasicMomentumTransportModel>>
{
protected:

    // Protected Data

        //- Run-time selectable non-Newtonian viscosity model
        autoPtr<generalizedNewtonianViscosityModel> viscosityModel_;

        //- The non-Newtonian viscosity field
        volScalargpuField nu_;


    // Protected Member Functions

        virtual tmp<volScalargpuField> strainRate() const;


public:

    typedef typename BasicMomentumTransportModel::alphaField alphaField;
    typedef typename BasicMomentumTransportModel::rhoField rhoField;
    typedef typename BasicMomentumTransportModel::transportModel transportModel;


    //- Runtime type information
    TypeName("generalizedNewtonian");


    // Constructors

        //- Construct from components
        generalizedNewtonian
        (
            const alphaField& alpha,
            const rhoField& rho,
            const volVectorgpuField& U,
            const surfaceScalargpuField& alphaRhoPhi,
            const surfaceScalargpuField& phi,
            const transportModel& transport,
            const word& propertiesName
        );


    // Selectors

        //- Return a reference to the selected turbulence model
        static autoPtr<generalizedNewtonian> New
        (
            const alphaField& alpha,
            const rhoField& rho,
            const volVectorgpuField& U,
            const surfaceScalargpuField& alphaRhoPhi,
            const surfaceScalargpuField& phi,
            const transportModel& transport,
            const word& propertiesName
        );


    //- Destructor
    virtual ~generalizedNewtonian() = default;


    // Member Functions

        //- Read turbulence (momentumTransport) dictionary
        virtual bool read();

        //- Return the turbulence viscosity,
        virtual tmp<volScalargpuField> nut() const;

        //- Return the turbulence viscosity on patch
        virtual tmp<scalargpuField> nut(const label patchi) const;

        //- Return the effective viscosity
        virtual tmp<volScalargpuField> nuEff() const;

        //- Return the effective viscosity on patch
        virtual tmp<scalargpuField> nuEff(const label patchi) const;

        //- Correct the generalizedNewtonian viscosity
        virtual void correct();
};


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

} // End namespace laminarModels
} // End namespace Foam

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

#ifdef NoRepository
    #include "generalizedNewtonian.C"
#endif

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

#endif

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