/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  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::Neutral

Description

SourceFiles
    NeutralI.H
    Neutral.C
    NeutralIO.C

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

#ifndef Neutral_H
#define Neutral_H

#include "Particle.H"

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

namespace Foam
{

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

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


/*---------------------------------------------------------------------------*\
                         Class Neutral Declaration
\*---------------------------------------------------------------------------*/

class Neutral
:
    public Particle
{
    // Private data

        //- Lenard-Jones parameter - potential well depth
        //- epsilon / kB [K]
        scalar wellDepth_;

        //- Lenard-Jones parameter - collision diameter [Angstrom]
        scalar diameter_;

        //- Dipole moment [Debye]
        scalar dipoleMoment_;

        //- Dipole polarizability [Angstrom^3]
        scalar alpha_;

        //- Quadrupole polarizability []
        scalar alphaQ_;

        //- Dispersion coefficient []
        scalar C6_;


    // Private Member Functions

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

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


public:

    // Static data members

        //- Static data staticData
        // static const dataType staticData;


    // Constructors

        //- Construct from components
        Neutral(const dictionary& thermoDict, const dictionary& tranDict);

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

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


    //- Destructor
    ~Neutral();


    // Member Functions

        // Access
        inline scalar wellDepth() const;

        inline scalar diameter() const;

        inline scalar dipoleMoment() const;

        inline scalar alpha() const;

        inline scalar alphaQ() const;

        inline scalar C6() const;

        inline scalar Zrot(scalar T) const;

        inline scalar lambda(const scalar mu, const scalar D, const GasState &state) const;

        // Check

        // Edit

        // Write


    // Member Operators

        // void operator=(const Neutral&);


    // Friend Functions

    // Friend Operators

    // IOstream Operators

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


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

} // End namespace Foam

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

#include "NeutralI.H"

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

#endif

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