File size: 5,416 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2023-2026 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::irregular
Description
Irregular wave model. Phase fraction and velocity field are built up from
multiple first-order waves, sampled from a selectable wave spectrum.
Usage
\table
Property | Description | Required? | Default
depth | The water depth [m] | no | great
spectrum | The wave spectrum | yes |
n | The number of times to sample \\
the spectrum | yes |
span | The fractional range across \\
which to sample the spectrum | no | (0.01 0.99)
setFormat | The format with which to plot \\
the spectrum | no | none
\endtable
Example specification in constant/waveProperties:
\verbatim
waves
(
irregular
{
spectrum PiersonMoskowitz;
PiersonMoskowitz
{
U19_5 15;
}
n 16;
span (0.01 0.99);
}
);
\endverbatim
SourceFiles
irregular.C
\*---------------------------------------------------------------------------*/
#ifndef irregular_H
#define irregular_H
#include "waveModel.H"
#include "waveSpectrum.H"
#include "AiryCoeffs.H"
#include "setWriter.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace waveModels
{
/*---------------------------------------------------------------------------*\
Class irregular Declaration
\*---------------------------------------------------------------------------*/
class irregular
:
public waveModel
{
// Private Data
//- Depth [m]
const scalar depth_;
//- Spectrum
autoPtr<waveSpectrum> spectrum_;
//- The number of times to sample the spectrum
const label n_;
//- The fractional range across which to sample the spectrum
const Pair<scalar> span_;
//- Formatter with which to plot the spectrum
autoPtr<setWriter> formatter_;
//- Amplitudes [m]
scalarList amplitudes_;
//- Wavelengths [m]
scalarList lengths_;
//- Phase offsets [rad]
scalarList phases_;
// Private Member Function
//- Return the i-th wave coefficients
AiryCoeffs coeffs(const label i) const;
public:
//- Runtime type information
TypeName("irregular");
// Constructors
//- Construct a copy
irregular(const irregular& wave);
//- Construct from a dictionary and gravity
irregular
(
const dictionary& dict,
const scalar g,
const word& modelName = irregular::typeName
);
//- Construct a clone
virtual autoPtr<waveModel> clone() const
{
return autoPtr<waveModel>(new irregular(*this));
}
//- Destructor
virtual ~irregular();
// Member Functions
// Access
//- Get the depth
scalar depth() const
{
return depth_;
}
//- The wave celerity [m/s]
virtual 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
// ************************************************************************* //
|