src/vofDynamicMesh/lnInclude/numericalBeachFvPatchField.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software; you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 \*---------------------------------------------------------------------------*/
  26
  27 #include "numericalBeachFvPatchField.H"
  28 #include "addToRunTimeSelectionTable.H"
  29 #include "volFields.H"
  30 #include "surfaceFields.H"
  31 #include "patchWave.H"
  32 #include "mathematicalConstants.H"
  33 #include "inletOutletFvPatchFields.H"
  34
  35 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  36
  37 using namespace Foam::mathematicalConstant;
  38
  39 namespace Foam
  40 {
  41
  42 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  43
  44 numericalBeachFvPatchField::numericalBeachFvPatchField
  45 (
  46     const fvPatch& p,
  47     const DimensionedField<vector, volMesh>& iF
  48 )
  49 :
  50     inletOutletFvPatchField<vector>(p, iF),
  51     thickness_(0.0),
  52     offset_(0.0),
  53     nud_(0.0)
  54 {}
  55
  56
  57 numericalBeachFvPatchField::numericalBeachFvPatchField
  58 (
  59     const numericalBeachFvPatchField& ptf,
  60     const fvPatch& p,
  61     const DimensionedField<vector, volMesh>& iF,
  62     const fvPatchFieldMapper& mapper
  63 )
  64 :
  65     inletOutletFvPatchField<vector>(ptf, p, iF, mapper),
  66     thickness_(ptf.thickness_),
  67     offset_(ptf.offset_),
  68     nud_(ptf.nud_)
  69 {}
  70
  71
  72 numericalBeachFvPatchField::numericalBeachFvPatchField
  73 (
  74     const fvPatch& p,
  75     const DimensionedField<vector, volMesh>& iF,
  76     const dictionary& dict
  77 )
  78 :
  79     inletOutletFvPatchField<vector>(p, iF, dict),
  80     thickness_(readScalar(dict.lookup("thickness"))),
  81     nud_(readScalar(dict.lookup("nud")))
  82 {
  83     if (dict.found("offset"))
  84     {
  85         offset_ = readScalar(dict.lookup("offset", 0.0));
  86
  87         if (offset_ > thickness_)
  88         {
  89             FatalErrorIn
  90             (
  91                 "numericalBeachFvPatchField::numericalBeachFvPatchField("
  92                 "const fvPatch& p,"
  93                 "const DimensionedField<vector, volMesh>& iF,"
  94                 "const dictionary& dict)"
  95             )
  96             << "Offset must be smaller than thickness"
  97             << exit(FatalError);
  98         }
  99     }
 100 }
 101
 102
 103 numericalBeachFvPatchField::numericalBeachFvPatchField
 104 (
 105     const numericalBeachFvPatchField& pivpvf
 106 )
 107 :
 108     inletOutletFvPatchField<vector>(pivpvf),
 109     thickness_(pivpvf.thickness_),
 110     offset_(pivpvf.offset_),
 111     nud_(pivpvf.nud_)
 112 {}
 113
 114
 115 numericalBeachFvPatchField::numericalBeachFvPatchField
 116 (
 117     const numericalBeachFvPatchField& pivpvf,
 118     const DimensionedField<vector, volMesh>& iF
 119 )
 120 :
 121     inletOutletFvPatchField<vector>(pivpvf, iF),
 122     thickness_(pivpvf.thickness_),
 123     offset_(pivpvf.offset_),
 124     nud_(pivpvf.nud_)
 125 {}
 126
 127
 128 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 129
 130 void numericalBeachFvPatchField::updateCoeffs()
 131 {
 132     inletOutletFvPatchField<vector>::updateCoeffs();
 133 }
 134
 135
 136 tmp<volScalarField> numericalBeachFvPatchField::internalDamping() const
 137 {
 138     // Get patchids of walls
 139     labelHashSet wallPatchIDs(1);
 140     wallPatchIDs.insert(this->patch().index());
 141
 142     // Calculate distance starting from wallPatch faces.
 143     patchWave wave(patch().boundaryMesh().mesh(), wallPatchIDs, false);
 144
 145     const scalarField& distance = wave.distance();
 146
 147     const fvMesh& mesh = this->patch().boundaryMesh().mesh();
 148
 149     tmp<volScalarField> tDamping
 150     (
 151         new volScalarField
 152         (
 153             IOobject
 154             (
 155                 "damping",
 156                 mesh.time().timeName(),
 157                 mesh,
 158                 IOobject::NO_READ,
 159                 IOobject::NO_WRITE
 160             ),
 161             mesh,
 162             dimensionedScalar("zero", dimensionSet(0, 0, -1, 0, 0), 0.0)
 163         )
 164     );
 165
 166     volScalarField& damping = tDamping();
 167
 168     forAll(distance, cellI)
 169     {
 170         if ( distance[cellI] < offset_ )
 171         {
 172             damping[cellI] = nud_;
 173         }
 174         else if ( distance[cellI] < thickness_ )
 175         {
 176             scalar nonDimDist =
 177                 (distance[cellI] - offset_)/(thickness_ - offset_);
 178
 179             damping[cellI] = nud_*(0.5 + 0.5*cos(pi*nonDimDist));
 180         }
 181     }
 182
 183     return tDamping;
 184 }
 185
 186
 187 void
 188 numericalBeachFvPatchField::write(Ostream& os) const
 189 {
 190     inletOutletFvPatchField<vector>::write(os);
 191
 192     os.writeKeyword("thickness") << thickness_ << token::END_STATEMENT << nl;
 193     if ( offset_ > 0 )
 194     {
 195         os.writeKeyword("offset") << offset_ << token::END_STATEMENT << nl;
 196     }
 197     os.writeKeyword("nud") << nud_ << token::END_STATEMENT << nl;
 198
 199 }
 200
 201
 202 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 203
 204 makePatchTypeField
 205 (
 206     fvPatchVectorField,
 207     numericalBeachFvPatchField
 208 );
 209
 210 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 211
 212 } // End namespace Foam
 213
 214 // ************************************************************************* //