solitary.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2017-2023 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::waveModels::solitary
 
Description
    Solitary wave model.
 
    Reference:
    \verbatim
        Dean, R. G., & Dalrymple, R. A. (1991).
        Water wave mechanics for engineers and scientists (Vol. 2).
        World Scientific Publishing Company.
    \endverbatim
 
    See pages 314-317.
 
Usage
    \table
        Property  | Description               | Required? | Default
        depth     | The water depth [m]       | no        | great
        amplitude | Peak amplitude [m]        | yes       |
        offset    | The positional offset [m] | yes       |
    \endtable
 
    Example specification in constant/waveProperties:
    \verbatim
    waves
    (
        solitary
        {
            length      40;
            amplitude   0.5;
            offset      0;
        }
    );
    \endverbatim
 
SourceFiles
    solitary.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef solitary_H
#define solitary_H
 
#include "waveModel.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
namespace waveModels
{
 
/*---------------------------------------------------------------------------*\
                          Class solitary Declaration
\*---------------------------------------------------------------------------*/
 
class solitary
:
    public waveModel
{
    // Private Data
 
        //- Depth [m]
        const scalar depth_;
 
        //- Amplitude [m]
        const scalar amplitude_;
 
        //- Offset [m]
        const scalar offset_;
 
 
    // Private Member Functions
 
        //- The wavenumber [1/m]
        scalar k() const;
 
        //- The dimensionless amplitude [1]
        scalar alpha() const;
 
        //- The evolution parameter [1]
        //  This is analogous to the oscillation angle of a periodic wave
        tmp<scalarField> parameter
        (
            const scalar t,
            const scalarField& x
        ) const;
 
        //- The dimensionless elevation [1]
        tmp<scalarField> Pi
        (
            const scalar t,
            const scalarField& x
        ) const;
 
 
public:
 
    //- Runtime type information
    TypeName("solitary");
 
 
    // Constructors
 
        //- Construct a copy
        solitary(const solitary& wave);
 
        //- Construct from a dictionary and gravity
        solitary(const dictionary& dict, const scalar g);
 
        //- Construct a clone
        virtual autoPtr<waveModel> clone() const
        {
            return autoPtr<waveModel>(new solitary(*this));
        }
 
 
    //- Destructor
    virtual ~solitary();
 
 
    // Member Functions
 
        // Access
 
            //- Get the depth
            scalar depth() const
            {
                return depth_;
            }
 
            //- Get the amplitude
            scalar amplitude() const
            {
                return amplitude_;
            }
 
            //- Get the offset
            scalar offset() const
            {
                return offset_;
            }
 
        //- The wave celerity [m/s]
        scalar celerity() const;
 
        //- Get the wave elevation at a given time and local coordinates. Local
        //  x is aligned with the direction of propagation.
        virtual tmp<scalarField> elevation
        (
            const scalar t,
            const scalarField& x
        ) const;
 
        //- Get the wave velocity at a given time and local coordinates. Local
        //  x is aligned with the direction of propagation, and z with negative
        //  gravity.
        virtual tmp<vector2DField> velocity
        (
            const scalar t,
            const vector2DField& xz
        ) const;
 
        //- Write
        virtual void write(Ostream& os) const;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace waveModels
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //