File size: 4,648 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2017-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/>.
\*---------------------------------------------------------------------------*/
#include "Airy.H"
#include "mathematicalConstants.H"
#include "addToRunTimeSelectionTable.H"
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
namespace Foam
{
namespace waveModels
{
defineTypeNameAndDebug(Airy, 0);
addToRunTimeSelectionTable(waveModel, Airy, dictionary);
}
}
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
Foam::scalar Foam::waveModels::Airy::readLength
(
const dictionary& dict,
const scalar depth,
const scalar amplitude,
const scalar g,
scalar (*celerityPtr)(const AiryCoeffs&)
)
{
const bool haveLength = dict.found("length");
const bool havePeriod = dict.found("period");
if (haveLength == havePeriod)
{
FatalIOErrorInFunction(dict)
<< "Exactly one of either length or period must be specified"
<< exit(FatalIOError);
}
if (haveLength)
{
return dict.lookup<scalar>("length");
}
else
{
return
AiryCoeffs
(
depth,
amplitude,
dict.lookup<scalar>("period"),
g,
celerityPtr
).length;
}
}
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
Foam::scalar Foam::waveModels::Airy::celerity(const AiryCoeffs& coeffs)
{
return coeffs.celerity();
}
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
Foam::waveModels::Airy::Airy(const Airy& wave)
:
waveModel(wave),
depth_(wave.depth_),
amplitude_(wave.amplitude_, false),
length_(wave.length_),
phase_(wave.phase_)
{}
Foam::waveModels::Airy::Airy
(
const dictionary& dict,
const scalar g,
const word& modelName,
scalar (*celerityPtr)(const AiryCoeffs&)
)
:
waveModel(dict, g),
depth_(dict.lookupOrDefault<scalar>("depth", great)),
amplitude_
(
Function1<scalar>::New
(
"amplitude",
dimensions::time,
dimensions::length,
dict
)
),
length_(readLength(dict, depth_, amplitude(), g, celerityPtr)),
phase_(dict.lookup<scalar>("phase"))
{
const scalar c = celerityPtr(coeffs());
Info<< waveModel::typeName << ": " << modelName
<< ": period = " << length_/c
<< ", length = " << length_ << endl;;
}
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
Foam::waveModels::Airy::~Airy()
{}
// * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
Foam::scalar Foam::waveModels::Airy::celerity() const
{
return celerity(coeffs());
}
Foam::tmp<Foam::scalarField> Foam::waveModels::Airy::elevation
(
const scalar t,
const scalarField& x
) const
{
return amplitude(t)*cos(coeffs().angle(phase_, t, x));
}
Foam::tmp<Foam::vector2DField> Foam::waveModels::Airy::velocity
(
const scalar t,
const vector2DField& xz
) const
{
const scalar ka = coeffs().k()*amplitude(t);
return Airy::celerity()*ka*coeffs().vi(1, phase_, t, xz);
}
void Foam::waveModels::Airy::write(Ostream& os) const
{
waveModel::write(os);
if (!coeffs().deep())
{
writeEntry(os, "depth", depth_);
}
writeEntry(os, amplitude_());
writeEntry(os, "length", length_);
writeEntry(os, "phase", phase_);
}
// ************************************************************************* //
|