mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
124 lines
3.2 KiB
C++
124 lines
3.2 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2016 OpenCFD Ltd.
|
|
\\/ M anipulation | Copyright (C) 2015 IH-Cantabria
|
|
-------------------------------------------------------------------------------
|
|
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::regularWaveModel
|
|
|
|
Description
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef waveModels_reguarWaveModel_H
|
|
#define waveModels_reguarWaveModel_H
|
|
|
|
#include "waveGenerationModel.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
namespace waveModels
|
|
{
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class regularWaveModel Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class regularWaveModel
|
|
:
|
|
public waveGenerationModel
|
|
{
|
|
// Private Member Functions
|
|
|
|
//- Disallow default bitwise copy construct
|
|
regularWaveModel(const regularWaveModel&);
|
|
|
|
//- Disallow default bitwise assignment
|
|
void operator=(const regularWaveModel&);
|
|
|
|
|
|
protected:
|
|
|
|
// Protected data
|
|
|
|
//- Ramp time
|
|
scalar rampTime_;
|
|
|
|
//- Wave period
|
|
scalar wavePeriod_;
|
|
|
|
//- Wavelength
|
|
scalar waveLength_;
|
|
|
|
//- Wave phase
|
|
scalar wavePhase_;
|
|
|
|
|
|
// Protected Member Functions
|
|
|
|
//- Return the time scaling coefficient
|
|
virtual scalar timeCoeff(const scalar t) const;
|
|
|
|
//- Return word description of wave type
|
|
virtual word waveType() const;
|
|
|
|
|
|
public:
|
|
|
|
//- Runtime type information
|
|
TypeName("regularWaveModel");
|
|
|
|
|
|
//- Constructor
|
|
regularWaveModel
|
|
(
|
|
const dictionary& dict,
|
|
const fvMesh& mesh,
|
|
const polyPatch& patch,
|
|
const bool readFields = true
|
|
);
|
|
|
|
//- Destructor
|
|
virtual ~regularWaveModel();
|
|
|
|
|
|
// Public Member Functions
|
|
|
|
//- Read from dictionary
|
|
virtual bool read(const dictionary& overrideDict);
|
|
|
|
//- Info
|
|
virtual void info(Ostream& os) const;
|
|
};
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace waveModels
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|