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

Description

SourceFiles
    CoulombI.H
    Coulomb.C
    CoulombIO.C

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

#ifndef Coulomb_H
#define Coulomb_H

#include "scalar.H"
#include "scalarField.H"

#include "Interaction.H"
#include "GasState.H"
#include "constants.H"

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

namespace Foam
{

// Forward declaration of classes
class Istream;
class Ostream;

// Forward declaration of friend functions and operators
class Coulomb;
class Ion;
class Electron;
Istream& operator>>(Istream&, Coulomb&);
Ostream& operator<<(Ostream&, const Coulomb&);


/*---------------------------------------------------------------------------*\
                         Class Coulomb Declaration
\*---------------------------------------------------------------------------*/

class Coulomb
    : public Interaction
{
    // Private data

        //- Combined well depth (depend on Debye Length)
        scalar eij_;

        //- Combined molecular weight
        scalar Wij_;


    // Private Member Functions

        //- Disallow default bitwise copy construct
        Coulomb(const Coulomb&);

        //- Disallow default bitwise assignment
        void operator=(const Coulomb&);


public:

    // Static data members


    // Constructors

        //- Construct null
        Coulomb();

        //- Construct from components
        Coulomb(const Ion& a, const Ion& b);

        //- Construct from components
        Coulomb(const Electron& a, const Ion& b);

        //- Construct from components
        Coulomb(const Electron& a, const Electron& b);

        //- Construct from Istream
        Coulomb(Istream&);

        //- Construct as copy
        // Coulomb(const Coulomb&);


    //- Destructor
    ~Coulomb();


    // Member Functions

        // Access

        // Check

        // Edit

        // Write

        inline scalar Omega11(const scalar T) const ;


        inline scalar Omega22(const scalar T) const ;


        inline scalar D(const scalar p, const scalar T, const scalar rhoQc2) const ;


        inline scalar mu(const scalar p, const scalar T, const scalar rhoQc2) const ;


        inline scalar k(const scalar p, const scalar T) const ;


        inline scalar DebyeLength(const GasState &state) const ;


        inline scalar DebyeLength(const scalar T, const scalar rhoQc2) const ;


        inline scalar epsK(const scalar T, const scalar rhoQc2) const ;

    // Member Operators


    // Friend Functions

    // Friend Operators

    // IOstream Operators

        friend Istream& operator>>(Istream&, Coulomb&);
        friend Ostream& operator<<(Ostream&, const Coulomb&);
};


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

} // End namespace Foam

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

#include "CoulombI.H"

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

#endif

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