/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | Copyright (C) 2011-2015 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/>.

Class
    Foam::psiThermoFrozen

Description
    Basic thermodynamic properties based on compressibility

SourceFiles
    psiThermoFrozen.C

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

#ifndef psiThermoFrozen_H
#define psiThermoFrozen_H

#include "fluidThermo.H"
#include "runTimeSelectionTables.H"

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

namespace Foam
{

/*---------------------------------------------------------------------------*\
                         Class psiThermoFrozen Declaration
\*---------------------------------------------------------------------------*/

class psiThermoFrozen
:
public fluidThermo
{

 protected:

  // Protected data

  //- Compressibility [s^2/m^2]
  volScalarField psi_;

  //- Dynamic viscosity [kg/m/s]
  volScalarField mu_;


  // Protected Member Functions

  //- Construct as copy (not implemented)
  psiThermoFrozen(const psiThermoFrozen&);


 public:

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


  //- Declare run-time constructor selection table
  declareRunTimeSelectionTable
  (
      autoPtr,
      psiThermoFrozen,
      fvMesh,
      (const fvMesh& mesh, const word& phaseName),
      (mesh, phaseName)
  );


  // Constructors

  //- Construct from mesh and phase name
  psiThermoFrozen
  (
      const fvMesh&,
      const word& phaseName
  );


  //- Selector
  static autoPtr<psiThermoFrozen> New
  (
      const fvMesh& mesh,
      const word& phaseName=word::null
  );


  //- Destructor
  virtual ~psiThermoFrozen();


  // Member functions

  // Fields derived from thermodynamic state variables

  //- Density [kg/m^3] - uses current value of pressure
  virtual tmp<volScalarField> rho() const;

  //- Density for patch [kg/m^3]
  virtual tmp<scalarField> rho(const label patchi) const;

  //- Compressibility [s^2/m^2]
  virtual const volScalarField& psi() const;


  // Access to transport state variables

  //- Dynamic viscosity of mixture [kg/m/s]
  virtual tmp<volScalarField> mu() const;

  //- Dynamic viscosity of mixture for patch [kg/m/s]
  virtual tmp<scalarField> mu(const label patchi) const;
};


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

} // End namespace Foam

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

#endif

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