Skip to content

GitLab

Commit cab7820f authored by Andrew Heather's avatar Andrew Heather
Browse files

ENH: Refactored waveMaker BC to support piston and flap motions

parent 6e1e854c
Hide whitespace changes
Inline Side-by-side
src/waveModels/Make/files
View file @ cab7820f
......@@ -20,6 +20,7 @@ waveAbsorptionModels/derived/shallowWaterAbsorption/shallowWaterAbsorption.C
derivedFvPatchFields/waveVelocity/waveVelocityFvPatchVectorField.C
derivedFvPatchFields/waveAlpha/waveAlphaFvPatchScalarField.C
derivedPointPatchFields/waveMaker/waveMakerPointPatchVectorField.C
fvOptions/multiphaseMangrovesSource/multiphaseMangrovesSource.C
fvOptions/multiphaseMangrovesTurbulenceModel/multiphaseMangrovesTurbulenceModel.C
......
src/waveModels/derivedFvPatchFields/waveMakerPiston/waveMakerPistonPointPatchVectorField.C deleted 100644 → 0
View file @ 6e1e854c
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2016 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/>.
\*---------------------------------------------------------------------------*/
#include "waveMakerPistonPointPatchVectorField.H"
#include "mathematicalConstants.H"
#include "pointPatchFields.H"
#include "addToRunTimeSelectionTable.H"
#include "Time.H"
#include "polyMesh.H"
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
Foam::waveMakerPistonPointPatchVectorField::
waveMakerPistonPointPatchVectorField
(
const pointPatch& p,
const DimensionedField<vector, pointMesh>& iF
)
:
fixedValuePointPatchField<vector>(p, iF),
initialDepth_(0.0),
wavePeriod_(0.0),
waveHeigth_(0.0),
waveLength_(0.0),
wavePhase_(0.0),
waveNumber_(0.0),
rampTime_(0.0),
g_(Zero),
secondOrder_(false)
{}
Foam::waveMakerPistonPointPatchVectorField::
waveMakerPistonPointPatchVectorField
(
const pointPatch& p,
const DimensionedField<vector, pointMesh>& iF,
const dictionary& dict
)
:
fixedValuePointPatchField<vector>(p, iF, dict),
initialDepth_(readScalar(dict.lookup("initialDepth"))),
wavePeriod_(readScalar(dict.lookup("wavePeriod"))),
waveHeigth_(readScalar(dict.lookup("waveHeigth"))),
waveLength_(readScalar(dict.lookup("waveLength"))),
wavePhase_(readScalar(dict.lookup("wavePhase"))),
waveNumber_(readScalar(dict.lookup("waveNumber"))),
rampTime_(readScalar(dict.lookup("rampTime"))),
g_(dict.lookup("g")),
secondOrder_(dict.lookupOrDefault<bool>("secondOrder",false))
{
if (!dict.found("value"))
{
updateCoeffs();
}
}
Foam::waveMakerPistonPointPatchVectorField::
waveMakerPistonPointPatchVectorField
(
const waveMakerPistonPointPatchVectorField& ptf,
const pointPatch& p,
const DimensionedField<vector, pointMesh>& iF,
const pointPatchFieldMapper& mapper
)
:
fixedValuePointPatchField<vector>(ptf, p, iF, mapper),
initialDepth_(ptf.initialDepth_),
wavePeriod_(ptf.wavePeriod_),
waveHeigth_(ptf.waveHeigth_),
waveLength_(ptf.waveLength_),
wavePhase_(ptf.wavePhase_),
waveNumber_(ptf.waveNumber_),
rampTime_(ptf.rampTime_),
g_(ptf.g_),
secondOrder_(ptf.secondOrder_)
{}
Foam::waveMakerPistonPointPatchVectorField::
waveMakerPistonPointPatchVectorField
(
const waveMakerPistonPointPatchVectorField& ptf,
const DimensionedField<vector, pointMesh>& iF
)
:
fixedValuePointPatchField<vector>(ptf, iF),
initialDepth_(ptf.initialDepth_),
wavePeriod_(ptf.wavePeriod_),
waveHeigth_(ptf.waveHeigth_),
waveLength_(ptf.waveLength_),
wavePhase_(ptf.wavePhase_),
waveNumber_(ptf.waveNumber_),
rampTime_(ptf.rampTime_),
g_(ptf.g_),
secondOrder_(ptf.secondOrder_)
{}
// * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * * //
Foam::scalar Foam::waveMakerPistonPointPatchVectorField::waveLength
(
const scalar h,
const scalar T
)
{
const scalar L0 = mag(g_)*T*T/(constant::mathematical::twoPi);
scalar L = L0;
for(int i=1; i<=100; i++)
{
L = L0*tanh(constant::mathematical::twoPi*h/L);
}
return L;
}
Foam::scalar Foam::waveMakerPistonPointPatchVectorField::timeCoeff
(
const scalar t
) const
{
return max(0, min(t/rampTime_, 1));
}
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
void Foam::waveMakerPistonPointPatchVectorField::updateCoeffs()
{
if (this->updated())
{
return;
}
const polyMesh& mesh = this->internalField().mesh()();
const Time& t = mesh.time();
// Time ramp weight
const scalar tCoeff = timeCoeff(t.value());
vectorField localPoints_ = this->patch().localPoints();
vectorField auxPoints = 0.0*localPoints_;
waveLength_ = waveLength (initialDepth_, wavePeriod_);
const scalar waveK = constant::mathematical::twoPi/waveLength_;
vector waveBoardMotion_(0,0,0);
const scalar sigma_ = (2.0*constant::mathematical::pi) / wavePeriod_;
//first order
if ( secondOrder_ == false)
{
scalar waveBoardStroke_ = (sinh(2.0*waveK*initialDepth_)
+ 2.0*waveK*initialDepth_)
/ (2.0*(cosh(2.0*waveK*initialDepth_)
- 1.0)) * waveHeigth_;
waveBoardMotion_.component(0)= tCoeff*(waveBoardStroke_/2.0)
* sin(sigma_*t.value());
Field<vector>::operator=
(
waveBoardMotion_
);
}
//second order
else if ( secondOrder_ == true)
{
scalar m1_ = (2.0*(cosh(2.0*waveK*initialDepth_)-1.0))
/ (sinh(2.0*waveK*initialDepth_)
+ 2.0*waveK*initialDepth_);
waveBoardMotion_.component(0) = tCoeff * (waveHeigth_/(2.0*m1_)
* sin(sigma_*t.value()) + pow(waveHeigth_,2)
/ (32.0*initialDepth_)*(3.0*cosh(waveK*initialDepth_)
/ pow(sinh(waveK*initialDepth_),3)-2.0/m1_)
* sin(2.0*sigma_*t.value()));
Field<vector>::operator=
(
waveBoardMotion_
);
}
fixedValuePointPatchField<vector>::updateCoeffs();
}
void Foam::waveMakerPistonPointPatchVectorField::write(Ostream& os) const
{
pointPatchField<vector>::write(os);
os.writeEntry("initialDepth", initialDepth_);
os.writeEntry("wavePeriod", wavePeriod_);
os.writeEntry("waveHeigth", waveHeigth_);
os.writeEntry("waveLength", waveLength_);
os.writeEntry("wavePhase", wavePhase_);
os.writeEntry("waveNumber", waveNumber_);
os.writeEntry("rampTime", rampTime_);
os.writeEntry("g", g_);
os.writeEntry("secondOrder", secondOrder_);
writeEntry("value", os);
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
makePointPatchTypeField
(
pointPatchVectorField,
waveMakerPistonPointPatchVectorField
);
}
// ************************************************************************* //
src/waveModels/derivedFvPatchFields/waveMakerPiston/waveMakerPistonPointPatchVectorField.H deleted 100644 → 0
View file @ 6e1e854c
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2016 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::waveMakerPistonPointPatchVectorField
Description
Foam::waveMakerPistonPointPatchVectorField
SourceFiles
waveMakerPistonPointPatchVectorField.C
\*---------------------------------------------------------------------------*/
#ifndef waveMakerPistonPointPatchVectorField_H
#define waveMakerPistonPointPatchVectorField_H
#include "fixedValuePointPatchField.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class waveMakerPistonPointPatchVectorField Declaration
\*---------------------------------------------------------------------------*/
class waveMakerPistonPointPatchVectorField
:
public fixedValuePointPatchField<vector>
{
// Private data
//inital water depth
scalar initialDepth_;
//wave period
scalar wavePeriod_;
//wave heigth
scalar waveHeigth_;
//wavelength
scalar waveLength_;
//wave phase
scalar wavePhase_;
//wave number
scalar waveNumber_;
//ramp time
scalar rampTime_;
// gravity vector
vector g_;
//on/off second order generation
scalar secondOrder_;
// Protected Member Functions
// Dispersion equation
virtual scalar waveLength(const scalar h, const scalar T);
//- Return the time scaling coefficient
virtual scalar timeCoeff(const scalar t) const;
public:
//- Runtime type information
TypeName("waveMakerPiston");
// Constructors
//- Construct from patch and internal field
waveMakerPistonPointPatchVectorField
(
const pointPatch&,
const DimensionedField<vector, pointMesh>&
);
//- Construct from patch, internal field and dictionary
waveMakerPistonPointPatchVectorField
(
const pointPatch&,
const DimensionedField<vector, pointMesh>&,
const dictionary&
);
//- Construct by mapping given patchField<vector> onto a new patch
waveMakerPistonPointPatchVectorField
(
const waveMakerPistonPointPatchVectorField&,
const pointPatch&,
const DimensionedField<vector, pointMesh>&,
const pointPatchFieldMapper&
);
//- Construct and return a clone
virtual autoPtr<pointPatchField<vector>> clone() const
{
return autoPtr<pointPatchField<vector>>
(
new waveMakerPistonPointPatchVectorField
(
*this
)
);
}
//- Construct as copy setting internal field reference
waveMakerPistonPointPatchVectorField
(
const waveMakerPistonPointPatchVectorField&,
const DimensionedField<vector, pointMesh>&
);
//- Construct and return a clone setting internal field reference
virtual autoPtr<pointPatchField<vector>> clone
(
const DimensionedField<vector, pointMesh>& iF
) const
{
return autoPtr<pointPatchField<vector>>
(
new waveMakerPistonPointPatchVectorField
(
*this,
iF
)
);
}
// Member functions
// Evaluation functions
//- Update the coefficients associated with the patch field
virtual void updateCoeffs();
//- Write
virtual void write(Ostream&) const;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
src/waveModels/derivedFvPatchFields/waveMakerFlap/waveMakerFlapPointPatchVectorField.C → src/waveModels/derivedPointPatchFields/waveMaker/waveMakerPointPatchVectorField.C
View file @ cab7820f
......@@ -2,8 +2,8 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
\\ / A nd | Copyright (C) 2018 OpenCFD Ltd.
\\/ M anipulation | Copyright (C) 2018 IH-Cantabria
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
......@@ -23,54 +23,121 @@ License
\*---------------------------------------------------------------------------*/
#include "waveMakerFlapPointPatchVectorField.H"
#include "waveMakerPointPatchVectorField.H"
#include "mathematicalConstants.H"
#include "pointPatchFields.H"
#include "addToRunTimeSelectionTable.H"
#include "Time.H"
#include "polyMesh.H"
#include "gravityMeshObject.H"
// * * * * * * * * * * * * * Static Member Data * * * * * * * * * * * * * * //
const Foam::Enum<Foam::waveMakerPointPatchVectorField::motionTypes>
Foam::waveMakerPointPatchVectorField::motionTypeNames
({
{ motionTypes::piston, "piston" },
{ motionTypes::flap, "flap" }
});
// * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * * //
const Foam::vector& Foam::waveMakerPointPatchVectorField::g()
{
const meshObjects::gravity& gf = meshObjects::gravity::New(db().time());
if (mag(gf.value()) < SMALL)
{
FatalErrorInFunction
<< "Gravity vector is not set. Please update "
<< gf.uniformDimensionedVectorField::path()
<< exit(FatalError);
}
return gf.value();
}
Foam::scalar Foam::waveMakerPointPatchVectorField::waveLength
(
const scalar h,
const scalar T
)
{
const scalar L0 = mag(g())*T*T/(constant::mathematical::twoPi);
scalar L = L0;
for (label i=1; i<=100; ++i)
{
L = L0*tanh(constant::mathematical::twoPi*h/L);
}
return L;
}
Foam::scalar Foam::waveMakerPointPatchVectorField::timeCoeff
(
const scalar t
) const
{
return max(0, min(t/rampTime_, 1));
}
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
Foam::waveMakerFlapPointPatchVectorField::
waveMakerFlapPointPatchVectorField
Foam::waveMakerPointPatchVectorField::waveMakerPointPatchVectorField
(
const pointPatch& p,
const DimensionedField<vector, pointMesh>& iF
)
:
fixedValuePointPatchField<vector>(p, iF),
initialDepth_(0.0),
wavePeriod_(0.0),
waveHeigth_(0.0),
waveLength_(0.0),
wavePhase_(0.0),
waveNumber_(0.0),
rampTime_(0.0),
g_(Zero),
motionType_(motionTypes::piston),
n_(Zero),
gHat_(Zero),
initialDepth_(0),
wavePeriod_(0),
waveHeight_(0),
wavePhase_(0),
waveLength_(0),
rampTime_(0),
secondOrder_(false)
{}
Foam::waveMakerFlapPointPatchVectorField::
waveMakerFlapPointPatchVectorField
Foam::waveMakerPointPatchVectorField::waveMakerPointPatchVectorField
(
const pointPatch& p,
const DimensionedField<vector, pointMesh>& iF,
const dictionary& dict
)
:
fixedValuePointPatchField<vector>(p, iF, dict),
initialDepth_(readScalar(dict.lookup("initialDepth"))),
wavePeriod_(readScalar(dict.lookup("wavePeriod"))),
waveHeigth_(readScalar(dict.lookup("waveHeigth"))),
waveLength_(readScalar(dict.lookup("waveLength"))),
wavePhase_(readScalar(dict.lookup("wavePhase"))),
waveNumber_(readScalar(dict.lookup("waveNumber"))),
rampTime_(readScalar(dict.lookup("rampTime"))),
g_(dict.lookup("g")),
secondOrder_(dict.lookupOrDefault<bool>("secondOrder",false))
fixedValuePointPatchField<vector>(p, iF, dict, false),
motionType_(motionTypeNames.lookup("motionType", dict)),
n_(dict.get<vector>("n")),
gHat_(Zero),
initialDepth_(dict.get<scalar>("initialDepth")),
wavePeriod_(dict.get<scalar>("wavePeriod")),
waveHeight_(dict.get<scalar>("waveHeight")),
wavePhase_(dict.get<scalar>("wavePhase")),
waveLength_(this->waveLength(initialDepth_, wavePeriod_)),
rampTime_(dict.get<scalar>("rampTime")),
secondOrder_(dict.lookupOrDefault<bool>("secondOrder", false))
{
// Create the co-ordinate system
if (mag(n_) < SMALL)
{
FatalIOErrorInFunction(dict)
<< "Patch normal direction vector is not set. 'n' = " << n_
<< exit(FatalIOError);
}
n_ /= mag(n_);