/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | www.openfoam.com
     \\/     M anipulation  |
-------------------------------------------------------------------------------
    Copyright (C) 2015 IH-Cantabria
    Copyright (C) 2016-2018 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::waveModels::regularWaveModel

Description

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

#ifndef waveModels_regularWaveModel_H
#define waveModels_regularWaveModel_H

#include "irregularWaveModel.H"

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

namespace Foam
{
namespace waveModels
{

/*---------------------------------------------------------------------------*\
                       Class regularWaveModel Declaration
\*---------------------------------------------------------------------------*/

class regularWaveModel
:
    public irregularWaveModel
{
    // Private Member Functions

        //- No copy construct
        regularWaveModel(const regularWaveModel&) = delete;

        //- No copy assignment
        void operator=(const regularWaveModel&) = delete;


protected:

    // Protected data

        //- Wave height / [m]
        scalar waveHeight_;

        //- Wave angle / [rad]  (read in degrees)
        scalar waveAngle_;

        //- Wave period
        scalar wavePeriod_;

        //- Wavelength
        scalar waveLength_;

        //- Wave phase
        scalar wavePhase_;


    // Protected Member Functions

        //- Return word description of wave type
        virtual word waveType() const;


public:

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


    //- Constructor
    regularWaveModel
    (
        const dictionary& dict,
        const fvMesh& mesh,
        const polyPatch& patch,
        const bool readFields = true
    );

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


    // Public Member Functions

        //- Read from dictionary
        virtual bool readDict(const dictionary& overrideDict);

        //- Info
        virtual void info(Ostream& os) const;
};


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

} // End namespace waveModels
} // End namespace Foam

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

#endif

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