From 10753b77e733a7af1c3569689447976019ae3689 Mon Sep 17 00:00:00 2001
From: Andrew Heather <a.heather@opencfd.co.uk>
Date: Thu, 15 Dec 2016 13:22:37 +0000
Subject: [PATCH] ENH: Code/doc tidying
---
.../derived/Boussinesq/BoussinesqWaveModel.H | 5 +-
.../derived/StokesI/StokesIWaveModel.H | 3 +
.../derived/StokesII/StokesIIWaveModel.H | 4 +-
.../derived/StokesV/StokesVWaveModel.H | 89 ++++++++-----------
.../derived/cnoidal/cnoidalWaveModel.H | 5 +-
5 files changed, 51 insertions(+), 55 deletions(-)
diff --git a/src/waveModels/waveGenerationModels/derived/Boussinesq/BoussinesqWaveModel.H b/src/waveModels/waveGenerationModels/derived/Boussinesq/BoussinesqWaveModel.H
index e0ece2d7508..ff76841a818 100644
--- a/src/waveModels/waveGenerationModels/derived/Boussinesq/BoussinesqWaveModel.H
+++ b/src/waveModels/waveGenerationModels/derived/Boussinesq/BoussinesqWaveModel.H
@@ -25,6 +25,7 @@ Class
Foam::waveModels::Boussinesq
Description
+ Boussinesq wave model
\*---------------------------------------------------------------------------*/
@@ -41,7 +42,7 @@ namespace waveModels
{
/*---------------------------------------------------------------------------*\
- Class Boussinesq Declaration
+ Class Boussinesq Declaration
\*---------------------------------------------------------------------------*/
class Boussinesq
@@ -64,7 +65,7 @@ protected:
const scalar X0
) const;
- //- wave
+ //- Wave
virtual vector Deta
(
const scalar H,
diff --git a/src/waveModels/waveGenerationModels/derived/StokesI/StokesIWaveModel.H b/src/waveModels/waveGenerationModels/derived/StokesI/StokesIWaveModel.H
index 10d06b97273..82213261bf8 100644
--- a/src/waveModels/waveGenerationModels/derived/StokesI/StokesIWaveModel.H
+++ b/src/waveModels/waveGenerationModels/derived/StokesI/StokesIWaveModel.H
@@ -25,6 +25,7 @@ Class
Foam::waveModels::StokesI
Description
+ Stokes I wave model
\*---------------------------------------------------------------------------*/
@@ -55,6 +56,7 @@ protected:
//- Return the wavelength
virtual scalar waveLength(const scalar h, const scalar T) const;
+ //- Wave height
virtual scalar eta
(
const scalar H,
@@ -67,6 +69,7 @@ protected:
const scalar phase
) const;
+ //- Wave velocity
virtual vector U
(
const scalar H,
diff --git a/src/waveModels/waveGenerationModels/derived/StokesII/StokesIIWaveModel.H b/src/waveModels/waveGenerationModels/derived/StokesII/StokesIIWaveModel.H
index a16f29ace79..044eba4bc57 100644
--- a/src/waveModels/waveGenerationModels/derived/StokesII/StokesIIWaveModel.H
+++ b/src/waveModels/waveGenerationModels/derived/StokesII/StokesIIWaveModel.H
@@ -25,6 +25,7 @@ Class
Foam::waveModels::StokesII
Description
+ Stokes II wave model
\*---------------------------------------------------------------------------*/
@@ -52,6 +53,7 @@ protected:
// Protected Member Functions
+ //- Wave height
virtual scalar eta
(
const scalar H,
@@ -65,6 +67,7 @@ protected:
const scalar phase
) const;
+ //- Wave velocity
virtual vector U
(
const scalar H,
@@ -79,7 +82,6 @@ protected:
const scalar z
) const;
-
//- Set the water level
virtual void setLevel
(
diff --git a/src/waveModels/waveGenerationModels/derived/StokesV/StokesVWaveModel.H b/src/waveModels/waveGenerationModels/derived/StokesV/StokesVWaveModel.H
index 1c127d703e8..225bb9bf1ff 100644
--- a/src/waveModels/waveGenerationModels/derived/StokesV/StokesVWaveModel.H
+++ b/src/waveModels/waveGenerationModels/derived/StokesV/StokesVWaveModel.H
@@ -25,6 +25,14 @@ Class
Foam::waveModels::StokesV
Description
+ Stokes V wave model
+
+ Reference
+ \verbatim
+ Skjelbreia, L., Hendrickson, J. (1960).
+ Fifth order gravity wave theory.
+ Proc. Coastal Engineering Conf., pp. 184-196.
+ \endverbatim
\*---------------------------------------------------------------------------*/
@@ -58,79 +66,58 @@ protected:
// Protected Member Functions
- //-
- virtual scalar A11(const scalar h, const scalar k) const;
+ // Model coefficients
- //-
- virtual scalar A13(const scalar h, const scalar k) const;
+ virtual scalar A11(const scalar h, const scalar k) const;
- //-
- virtual scalar A15(const scalar h, const scalar k) const;
+ virtual scalar A13(const scalar h, const scalar k) const;
- //-
- virtual scalar A22(const scalar h, const scalar k) const;
+ virtual scalar A15(const scalar h, const scalar k) const;
- //-
- virtual scalar A24(const scalar h, const scalar k) const;
+ virtual scalar A22(const scalar h, const scalar k) const;
- //-
- virtual scalar A33(const scalar h, const scalar k) const;
+ virtual scalar A24(const scalar h, const scalar k) const;
- //-
- virtual scalar A35(const scalar h, const scalar k) const;
+ virtual scalar A33(const scalar h, const scalar k) const;
- //-
- virtual scalar A44(const scalar h, const scalar k) const;
+ virtual scalar A35(const scalar h, const scalar k) const;
- //-
- virtual scalar A55(const scalar h, const scalar k) const;
+ virtual scalar A44(const scalar h, const scalar k) const;
- //-
- virtual scalar B22(const scalar h, const scalar k) const;
+ virtual scalar A55(const scalar h, const scalar k) const;
- //-
- virtual scalar B24(const scalar h, const scalar k) const;
+ virtual scalar B22(const scalar h, const scalar k) const;
- //-
- virtual scalar B33(const scalar h, const scalar k) const;
+ virtual scalar B24(const scalar h, const scalar k) const;
- //-
- virtual scalar B33k(const scalar h, const scalar k) const;
+ virtual scalar B33(const scalar h, const scalar k) const;
- //-
- virtual scalar B35(const scalar h, const scalar k) const;
+ virtual scalar B33k(const scalar h, const scalar k) const;
- //-
- virtual scalar B35k(const scalar h, const scalar k) const;
+ virtual scalar B35(const scalar h, const scalar k) const;
- //-
- virtual scalar B44(const scalar h, const scalar k) const;
+ virtual scalar B35k(const scalar h, const scalar k) const;
- //-
- virtual scalar B55(const scalar h, const scalar k) const;
+ virtual scalar B44(const scalar h, const scalar k) const;
- //-
- virtual scalar B55k(const scalar h, const scalar k) const;
+ virtual scalar B55(const scalar h, const scalar k) const;
- //-
- virtual scalar C1(const scalar h, const scalar k) const;
+ virtual scalar B55k(const scalar h, const scalar k) const;
- //-
- virtual scalar C1k(const scalar h, const scalar k) const;
+ virtual scalar C1(const scalar h, const scalar k) const;
- //-
- virtual scalar C2(const scalar h, const scalar k) const;
+ virtual scalar C1k(const scalar h, const scalar k) const;
- //-
- virtual scalar C2k(const scalar h, const scalar k) const;
+ virtual scalar C2(const scalar h, const scalar k) const;
- //-
- virtual scalar C3(const scalar h, const scalar k) const;
+ virtual scalar C2k(const scalar h, const scalar k) const;
- //-
- virtual scalar C4(const scalar h, const scalar k) const;
+ virtual scalar C3(const scalar h, const scalar k) const;
- //-
+ virtual scalar C4(const scalar h, const scalar k) const;
+
+
+ //- Model intialisation
virtual void initialise
(
const scalar H,
@@ -142,7 +129,7 @@ protected:
scalar& f2Out
) const;
- //-
+ //- Wave height
virtual scalar eta
(
const scalar h,
@@ -156,7 +143,7 @@ protected:
const scalar phase
) const;
- //-
+ //- Wave velocity
virtual vector U
(
const scalar d,
diff --git a/src/waveModels/waveGenerationModels/derived/cnoidal/cnoidalWaveModel.H b/src/waveModels/waveGenerationModels/derived/cnoidal/cnoidalWaveModel.H
index dd4e1a169cb..3c786581543 100644
--- a/src/waveModels/waveGenerationModels/derived/cnoidal/cnoidalWaveModel.H
+++ b/src/waveModels/waveGenerationModels/derived/cnoidal/cnoidalWaveModel.H
@@ -25,6 +25,7 @@ Class
Foam::waveModels::cnoidal
Description
+ Cnoidal wave model
\*---------------------------------------------------------------------------*/
@@ -41,7 +42,7 @@ namespace waveModels
{
/*---------------------------------------------------------------------------*\
- Class cnoidal Declaration
+ Class cnoidal Declaration
\*---------------------------------------------------------------------------*/
class cnoidal
@@ -67,6 +68,7 @@ protected:
scalar& LOut
) const;
+ //- Wave height
virtual scalar eta
(
const scalar H,
@@ -104,6 +106,7 @@ protected:
const scalar E
) const;
+ //- Wave velocity
virtual vector U
(
const scalar H,
--
GitLab