///////////////////////////////////////////////////////////////////////////////
//
// File: AUSM3Solver.cpp
//
// For more information, please see: http://www.nektar.info
//
// The MIT License
//
// Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
// Department of Aeronautics, Imperial College London (UK), and Scientific
// Computing and Imaging Institute, University of Utah (USA).
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//
// Description: AUSM3 Riemann solver.
//
///////////////////////////////////////////////////////////////////////////////

#include <CompressibleFlowSolver/RiemannSolvers/AUSM3Solver.h>

namespace Nektar
{

std::string AUSM3Solver::solverName =
    SolverUtils::GetRiemannSolverFactory().RegisterCreatorFunction(
        "AUSM3", AUSM3Solver::create, "AUSM3 Riemann solver");

AUSM3Solver::AUSM3Solver(const LibUtilities::SessionReaderSharedPtr &pSession)
    : AUSM0Solver(pSession)
{
    pSession->LoadParameter("Mco", m_Mco, 0.01);
}

/**
 * @brief AUSM3 Riemann solver
 *
 * @param rhoL      Density left state.
 * @param rhoR      Density right state.
 * @param rhouL     x-momentum component left state.
 * @param rhouR     x-momentum component right state.
 * @param rhovL     y-momentum component left state.
 * @param rhovR     y-momentum component right state.
 * @param rhowL     z-momentum component left state.
 * @param rhowR     z-momentum component right state.
 * @param EL        Energy left state.
 * @param ER        Energy right state.
 * @param rhof      Computed Riemann flux for density.
 * @param rhouf     Computed Riemann flux for x-momentum component
 * @param rhovf     Computed Riemann flux for y-momentum component
 * @param rhowf     Computed Riemann flux for z-momentum component
 * @param Ef        Computed Riemann flux for energy.
 */
void AUSM3Solver::v_PointSolve(double rhoL, double rhouL, double rhovL,
                               double rhowL, double EL, double rhoR,
                               double rhouR, double rhovR, double rhowR,
                               double ER, double &rhof, double &rhouf,
                               double &rhovf, double &rhowf, double &Ef)
{
    // Left and Right velocities
    NekDouble uL = rhouL / rhoL;
    NekDouble vL = rhovL / rhoL;
    NekDouble wL = rhowL / rhoL;
    NekDouble uR = rhouR / rhoR;
    NekDouble vR = rhovR / rhoR;
    NekDouble wR = rhowR / rhoR;

    // Internal energy (per unit mass)
    NekDouble eL = (EL - 0.5 * (rhouL * uL + rhovL * vL + rhowL * wL)) / rhoL;
    NekDouble eR = (ER - 0.5 * (rhouR * uR + rhovR * vR + rhowR * wR)) / rhoR;
    // Pressure
    NekDouble pL = m_eos->GetPressure(rhoL, eL);
    NekDouble pR = m_eos->GetPressure(rhoR, eR);
    // Speed of sound
    NekDouble cL = m_eos->GetSoundSpeed(rhoL, eL);
    NekDouble cR = m_eos->GetSoundSpeed(rhoR, eR);

    // Average speeds of sound
    NekDouble cA = 0.5 * (cL + cR);

    // Local Mach numbers
    NekDouble ML = uL / cA;
    NekDouble MR = uR / cA;

    // Parameters for specify the upwinding
    // Note: if fa = 1 then AUSM3 = AUSM3
    NekDouble Mtilde = 0.5 * (ML * ML + MR * MR);
    NekDouble Mo    = std::sqrt(std::min(1.0, std::max(Mtilde, m_Mco * m_Mco)));
    NekDouble fa    = Mo * (2.0 - Mo);
    NekDouble beta  = 0.125;
    NekDouble alpha = 0.1875;
    NekDouble sigma = 1.0;
    NekDouble Kp    = 0.25;
    NekDouble Ku    = 0.75;
    NekDouble rhoA  = 0.5 * (rhoL + rhoR);
    NekDouble Mp    = -(Kp / fa) * ((pR - pL) / (rhoA * cA * cA)) *
                   std::max(1.0 - sigma * Mtilde, 0.0);

    NekDouble Mbar = M4Function(0, beta, ML) + M4Function(1, beta, MR) + Mp;

    NekDouble pu = -2.0 * Ku * rhoA * cA * cA * (MR - ML) *
                   P5Function(0, alpha, ML) * P5Function(1, alpha, MR);

    NekDouble pbar =
        pL * P5Function(0, alpha, ML) + pR * P5Function(1, alpha, MR) + pu;

    if (Mbar >= 0.0)
    {
        rhof  = cA * Mbar * rhoL;
        rhouf = cA * Mbar * rhoL * uL + pbar;
        rhovf = cA * Mbar * rhoL * vL;
        rhowf = cA * Mbar * rhoL * wL;
        Ef    = cA * Mbar * (EL + pL);
    }
    else
    {
        rhof  = cA * Mbar * rhoR;
        rhouf = cA * Mbar * rhoR * uR + pbar;
        rhovf = cA * Mbar * rhoR * vR;
        rhowf = cA * Mbar * rhoR * wR;
        Ef    = cA * Mbar * (ER + pR);
    }
}

} // namespace Nektar
