solitaryWaveModel.C
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-2017 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
27\*---------------------------------------------------------------------------*/
28
29#include "solitaryWaveModel.H"
30#include "polyPatch.H"
31#include "SubField.H"
32#include "unitConversion.H"
33
34// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
35
36namespace Foam
37{
38namespace waveModels
39{
41}
42}
43
44
45// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
46
48(
49 const scalar t
50) const
51{
52 // Ramping not applicable to solitary waves
53 return 1;
54}
55
56
57// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
58
60(
61 const dictionary& dict,
62 const fvMesh& mesh,
63 const polyPatch& patch,
64 const bool readFields
65)
66:
67 waveGenerationModel(dict, mesh, patch, false),
68 waveHeight_(0),
69 waveAngle_(0),
70 x_
71 (
72 patch.faceCentres().component(0)*cos(waveAngle_)
73 + patch.faceCentres().component(1)*sin(waveAngle_)
74 ),
75 x0_(gMin(x_))
76{
77 if (readFields)
78 {
80 }
81}
82
83
84// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
85
87(
88 const dictionary& overrideDict
89)
90{
91 if (waveGenerationModel::readDict(overrideDict))
92 {
93 waveHeight_ = readWaveHeight();
94 waveAngle_ = readWaveAngle();
95
96 return true;
97 }
98
99 return false;
100}
101
102
104{
106
107 os << " Wave height : " << waveHeight_ << nl
108 << " Wave angle : " << radToDeg(waveAngle_) << nl
109 << " x0: " << x0_ << nl;
110}
111
112
113// ************************************************************************* //
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
InfoProxy< ensightCells > info() const
Return info proxy.
Definition: ensightCells.H:254
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 scalar timeCoeff(const scalar t) const
Return the time scaling coefficient.
virtual bool readDict(const dictionary &overrideDict)
Read from dictionary.
#define defineTypeNameAndDebug(Type, DebugSwitch)
Define the typeName and debug information.
Definition: className.H:121
dynamicFvMesh & mesh
OBJstream os(runTime.globalPath()/outputName)
Namespace for OpenFOAM.
void component(FieldField< Field, typename FieldField< Field, Type >::cmptType > &sf, const FieldField< Field, Type > &f, const direction d)
dimensionedScalar sin(const dimensionedScalar &ds)
void readFields(const typename GeoFieldType::Mesh &mesh, const IOobjectList &objects, const wordHashSet &selectedFields, LIFOStack< regIOobject * > &storedObjects)
Read the selected GeometricFields of the templated type.
constexpr scalar radToDeg() noexcept
Multiplication factor for radians to degrees conversion.
Type gMin(const FieldField< Field, Type > &f)
dimensionedScalar cos(const dimensionedScalar &ds)
constexpr char nl
The newline '\n' character (0x0a)
Definition: Ostream.H:53
dictionary dict
Unit conversion functions.