Stokes5.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2017-2018 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::waveModels::Stokes5
26 
27 Description
28  Fifth-order wave model.
29 
30  Reference:
31  \verbatim
32  Fenton, J. D. (1985).
33  A fifth-order Stokes theory for steady waves.
34  Journal of waterway, port, coastal, and ocean engineering, 111(2),
35  216-234.
36  \endverbatim
37 
38 SourceFiles
39  Stokes5.C
40 
41 \*---------------------------------------------------------------------------*/
42 
43 #ifndef Stokes5_H
44 #define Stokes5_H
45 
46 #include "Stokes2.H"
47 
48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
49 
50 namespace Foam
51 {
52 namespace waveModels
53 {
54 
55 /*---------------------------------------------------------------------------*\
56  Class Stokes5 Declaration
57 \*---------------------------------------------------------------------------*/
58 
59 class Stokes5
60 :
61  public Stokes2
62 {
63 public:
64 
65  //- Runtime type information
66  TypeName("Stokes5");
67 
68 
69  // Constructors
70 
71  //- Construct from a database and a dictionary
72  Stokes5(const objectRegistry& db, const dictionary& dict);
73 
74  //- Construct a clone
75  virtual autoPtr<waveModel> clone() const
76  {
77  return autoPtr<waveModel>(new Stokes5(*this));
78  }
79 
80 
81  //- Destructor
82  virtual ~Stokes5();
83 
84 
85  // Member Functions
86 
87  //- Get the wave elevation at a given time and local coordinates. Local
88  // x is aligned with the direction of propagation.
90  (
91  const scalar t,
92  const scalarField& x
93  ) const;
94 
95  //- Get the wave velocity at a given time and local coordinates. Local
96  // x is aligned with the direction of propagation, and z with negative
97  // gravity.
99  (
100  const scalar t,
101  const vector2DField& xz
102  ) const;
103 };
104 
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 } // End namespace Foam
109 } // End namespace waveModels
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 #endif
114 
115 // ************************************************************************* //
dictionary dict
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
virtual autoPtr< waveModel > clone() const
Construct a clone.
Definition: Stokes5.H:74
virtual ~Stokes5()
Destructor.
Definition: Stokes5.C:55
virtual tmp< vector2DField > velocity(const scalar t, const vector2DField &xz) const
Get the wave velocity at a given time and local coordinates. Local.
Definition: Stokes5.C:128
Stokes5(const objectRegistry &db, const dictionary &dict)
Construct from a database and a dictionary.
Definition: Stokes5.C:44
TypeName("Stokes5")
Runtime type information.
virtual tmp< scalarField > elevation(const scalar t, const scalarField &x) const
Get the wave elevation at a given time and local coordinates. Local.
Definition: Stokes5.C:62
Second-order wave model.
Definition: Stokes2.H:59
Fifth-order wave model.
Definition: Stokes5.H:58
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
A class for managing temporary objects.
Definition: PtrList.H:53
Registry of regIOobjects.
Namespace for OpenFOAM.