File size: 4,180 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / 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::waveModel
Description
Generic base class for waves. Derived classes must implement field
functions which return the elevation above the wave surface and the
velocity field, both as a function of position.
SourceFiles
waveModel.C
waveModelNew.C
\*---------------------------------------------------------------------------*/
#ifndef waveModel_H
#define waveModel_H
#include "dictionary.H"
#include "Function1.H"
#include "runTimeSelectionTables.H"
#include "vectorField.H"
#include "vector2DField.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class waveModel Declaration
\*---------------------------------------------------------------------------*/
class waveModel
{
// Private Data
//- Gravitational acceleration [m/s^2]
const scalar g_;
public:
//- Runtime type information
TypeName("waveModel");
// Declare runtime construction
declareRunTimeSelectionTable
(
autoPtr,
waveModel,
dictionary,
(const dictionary& dict, const scalar g),
(dict, g)
);
// Constructors
//- Construct a copy
waveModel(const waveModel& wave);
//- Construct from a dictionary and gravity
waveModel(const dictionary& dict, const scalar g);
//- Construct a clone
virtual autoPtr<waveModel> clone() const = 0;
// Selectors
//- Select
static autoPtr<waveModel> New
(
const dictionary& dict,
const scalar g
);
//- Select
static autoPtr<waveModel> New
(
const word& type,
const dictionary& dict,
const scalar g
);
//- Destructor
virtual ~waveModel();
// Member Functions
//- Get the value of gravity
scalar g() const
{
return g_;
}
//- The wave celerity [m/s]
virtual scalar celerity() const = 0;
//- 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 = 0;
//- 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 = 0;
//- Write
virtual void write(Ostream& os) const;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|