src/vofDynamicMesh/lnInclude/numericalBeachFvPatchField.H

   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 Class
  26     Foam::numericalBeachFvPatchField
  27
  28 Description
  29     Foam::numericalBeachFvPatchField
  30
  31 Author
  32     Henrik Rusche, Wikki GmbH.  All rights reserved.
  33
  34 SourceFiles
  35     numericalBeachFvPatchField.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef numericalBeachFvPatchField_H
  40 #define numericalBeachFvPatchField_H
  41
  42 #include "fvPatchFields.H"
  43 #include "inletOutletFvPatchFields.H"
  44 #include "volFieldsFwd.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 /*---------------------------------------------------------------------------*\
  52                 Class numericalBeachFvPatchField Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class numericalBeachFvPatchField
  56 :
  57     public inletOutletFvPatchField<vector>
  58 {
  59     // Private data
  60
  61         //- Thickness measured from the patch
  62         scalar thickness_;
  63
  64         //- Offset to allow some constant damping towards the walls
  65         scalar offset_;
  66
  67         //- Damping factor
  68         scalar nud_;
  69
  70
  71 public:
  72
  73     //- Runtime type information
  74     TypeName("numericalBeach");
  75
  76
  77     // Constructors
  78
  79         //- Construct from patch and internal field
  80         numericalBeachFvPatchField
  81         (
  82             const fvPatch&,
  83             const DimensionedField<vector, volMesh>&
  84         );
  85
  86         //- Construct from patch, internal field and dictionary
  87         numericalBeachFvPatchField
  88         (
  89             const fvPatch&,
  90             const DimensionedField<vector, volMesh>&,
  91             const dictionary&
  92         );
  93
  94         //- Construct by mapping given
  95         //  numericalBeachFvPatchField
  96         //  onto a new patch
  97         numericalBeachFvPatchField
  98         (
  99             const numericalBeachFvPatchField&,
 100             const fvPatch&,
 101             const DimensionedField<vector, volMesh>&,
 102             const fvPatchFieldMapper&
 103         );
 104
 105         //- Construct as copy
 106         numericalBeachFvPatchField
 107         (
 108             const numericalBeachFvPatchField&
 109         );
 110
 111         //- Construct and return a clone
 112         virtual tmp<fvPatchVectorField> clone() const
 113         {
 114             return tmp<fvPatchVectorField>
 115             (
 116                 new numericalBeachFvPatchField
 117                 (
 118                     *this
 119                 )
 120             );
 121         }
 122
 123         //- Construct as copy setting internal field reference
 124         numericalBeachFvPatchField
 125         (
 126             const numericalBeachFvPatchField&,
 127             const DimensionedField<vector, volMesh>&
 128         );
 129
 130         //- Construct and return a clone setting internal field reference
 131         virtual tmp<fvPatchVectorField> clone
 132         (
 133             const DimensionedField<vector, volMesh>& iF
 134         ) const
 135         {
 136             return tmp<fvPatchVectorField>
 137             (
 138                 new numericalBeachFvPatchField
 139                 (
 140                     *this,
 141                     iF
 142                 )
 143             );
 144         }
 145
 146
 147     // Member functions
 148
 149         // Access
 150
 151         //- Return the damping in the internal field
 152         tmp<volScalarField> internalDamping() const;
 153
 154         //- Update the coefficients associated with the patch field
 155         virtual void updateCoeffs();
 156
 157         //- Write
 158         virtual void write(Ostream&) const;
 159 };
 160
 161
 162 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 163
 164 } // End namespace Foam
 165
 166 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 167
 168 #endif
 169
 170 // ************************************************************************* //