irregularWaveModel.H
Go to the documentation of this file.
1/*---------------------------------------------------------------------------*\
2 ========= |
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4 \\ / O peration |
5 \\ / A nd | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2015 IH-Cantabria
9 Copyright (C) 2016-2018 OpenCFD Ltd.
10-------------------------------------------------------------------------------
11License
12 This file is part of OpenFOAM.
13
14 OpenFOAM is free software: you can redistribute it and/or modify it
15 under the terms of the GNU General Public License as published by
16 the Free Software Foundation, either version 3 of the License, or
17 (at your option) any later version.
18
19 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22 for more details.
23
24 You should have received a copy of the GNU General Public License
25 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26
27Class
28 Foam::waveModels::irregularWaveModel
29
30Description
31
32\*---------------------------------------------------------------------------*/
33
34#ifndef waveModels_irregularWaveModel_H
35#define waveModels_irregularWaveModel_H
36
37#include "waveGenerationModel.H"
38
39// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40
41namespace Foam
42{
43namespace waveModels
44{
45
46/*---------------------------------------------------------------------------*\
47 Class irregularWaveModel Declaration
48\*---------------------------------------------------------------------------*/
51:
53{
54 //- No copy construct
56
57 //- No copy assignment
58 void operator=(const irregularWaveModel&) = delete;
59
60
61protected:
62
63 // Protected data
64
65 //- Ramp time
66 scalar rampTime_;
67
68 // Protected Member Functions
69
70 //- Return the time scaling coefficient
71 virtual scalar timeCoeff(const scalar t) const;
72
73
74public:
75
76 //- Runtime type information
77 TypeName("irregularWaveModel");
78
79
80 //- Constructor
82 (
83 const dictionary& dict,
84 const fvMesh& mesh,
85 const polyPatch& patch,
86 const bool readFields = true
87 );
88
89 //- Destructor
90 virtual ~irregularWaveModel() = default;
91
92
93 // Public Member Functions
94
95 //- Read from dictionary
96 virtual bool readDict(const dictionary& overrideDict);
97
98 //- Info
99 virtual void info(Ostream& os) const;
100};
101
102
103// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104
105} // End namespace waveModels
106} // End namespace Foam
107
108// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109
110#endif
111
112// ************************************************************************* //
InfoProxy< IOobject > info() const
Return info proxy, for printing information to a stream.
Definition: IOobject.H:690
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:62
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:91
A patch is a list of labels that address the faces in the global face list.
Definition: polyPatch.H:75
virtual ~irregularWaveModel()=default
Destructor.
virtual scalar timeCoeff(const scalar t) const
Return the time scaling coefficient.
virtual bool readDict(const dictionary &overrideDict)
Read from dictionary.
TypeName("irregularWaveModel")
Runtime type information.
dynamicFvMesh & mesh
OBJstream os(runTime.globalPath()/outputName)
Namespace for OpenFOAM.
void readFields(const typename GeoFieldType::Mesh &mesh, const IOobjectList &objects, const wordHashSet &selectedFields, LIFOStack< regIOobject * > &storedObjects)
Read the selected GeometricFields of the templated type.
dictionary dict
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73