src/fvMotionSolver/pointPatchFields/derived/surfaceDisplacement/surfaceDisplacementPointPatchVectorField.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     surfaceDisplacementPointPatchVectorField
  27
  28 Description
  29     Displacement fixed by projection onto triSurface.
  30     Use in a displacement fvMotionSolver
  31     as a bc on the pointDisplacement field.
  32
  33     Calculates the projection onto the surface according
  34     to the projectMode
  35     - NEAREST : nearest
  36     - POINTNORMAL : intersection with point normal
  37     - FIXEDNORMAL : intersection with fixed vector
  38
  39     This displacement is then clipped with the specified velocity * deltaT.
  40
  41     Optionally (intersection only) removes a component ("wedgePlane") to
  42     stay in 2D.
  43
  44     Needs:
  45     - geometry : dictionary with searchableSurfaces. (usually
  46       triSurfaceMeshes in constant/triSurface)
  47     - projectMode : see above
  48     - projectDirection : if projectMode = fixedNormal
  49     - wedgePlane : -1 or component to knock out of intersection normal
  50     - frozenPointsZone : empty or name of pointZone containing points
  51                          that do not move
  52
  53 SourceFiles
  54     surfaceDisplacementPointPatchVectorField.C
  55
  56 \*---------------------------------------------------------------------------*/
  57
  58 #ifndef surfaceDisplacementPointPatchVectorField_H
  59 #define surfaceDisplacementPointPatchVectorField_H
  60
  61 #include "pointPatchFields.H"
  62 #include "fixedValuePointPatchFields.H"
  63 #include "searchableSurfaces.H"
  64 #include "Switch.H"
  65
  66 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  67
  68 namespace Foam
  69 {
  70
  71 /*---------------------------------------------------------------------------*\
  72           Class surfaceDisplacementPointPatchVectorField Declaration
  73 \*---------------------------------------------------------------------------*/
  74
  75 class surfaceDisplacementPointPatchVectorField
  76 :
  77     public FixedValuePointPatchField
  78     <
  79         pointPatchField,
  80         pointMesh,
  81         pointPatch,
  82         DummyMatrix,
  83         vector
  84     >
  85 {
  86
  87 public:
  88
  89     // Public data types
  90
  91         enum projectMode
  92         {
  93             NEAREST,
  94             POINTNORMAL,
  95             FIXEDNORMAL
  96         };
  97
  98 private:
  99
 100     // Private data
 101
 102         //- project mode names
 103         static const NamedEnum<projectMode, 3> projectModeNames_;
 104
 105         //- Maximum velocity
 106         const vector velocity_;
 107
 108         //- names of surfaces
 109         const dictionary surfacesDict_;
 110
 111         //- How to project/project onto surface
 112         const projectMode projectMode_;
 113
 114         //- direction to project
 115         const vector projectDir_;
 116
 117         //- plane for 2D wedge case or -1.
 118         const label wedgePlane_;
 119
 120         //- pointZone with frozen points
 121         const word frozenPointsZone_;
 122
 123         //- Demand driven: surface to project
 124         mutable autoPtr<searchableSurfaces> surfacesPtr_;
 125
 126
 127     // Private Member Functions
 128
 129         //- Calculate displacement (w.r.t. points0()) to project onto surface
 130         void calcProjection(vectorField& displacement) const;
 131
 132
 133         //- Disallow default bitwise assignment
 134         void operator=(const surfaceDisplacementPointPatchVectorField&);
 135
 136 public:
 137
 138     //- Runtime type information
 139     TypeName("surfaceDisplacement");
 140
 141
 142     // Constructors
 143
 144         //- Construct from patch and internal field
 145         surfaceDisplacementPointPatchVectorField
 146         (
 147             const pointPatch&,
 148             const DimensionedField<vector, pointMesh>&
 149         );
 150
 151         //- Construct from patch, internal field and dictionary
 152         surfaceDisplacementPointPatchVectorField
 153         (
 154             const pointPatch&,
 155             const DimensionedField<vector, pointMesh>&,
 156             const dictionary&
 157         );
 158
 159         //- Construct by mapping given patchField<vector> onto a new patch
 160         surfaceDisplacementPointPatchVectorField
 161         (
 162             const surfaceDisplacementPointPatchVectorField&,
 163             const pointPatch&,
 164             const DimensionedField<vector, pointMesh>&,
 165             const PointPatchFieldMapper&
 166         );
 167
 168         //- Construct as copy
 169         surfaceDisplacementPointPatchVectorField
 170         (
 171             const surfaceDisplacementPointPatchVectorField&
 172         );
 173
 174         //- Construct and return a clone
 175         virtual autoPtr<pointPatchVectorField> clone() const
 176         {
 177             return autoPtr<pointPatchVectorField>
 178             (
 179                 new surfaceDisplacementPointPatchVectorField
 180                 (
 181                     *this
 182                 )
 183             );
 184         }
 185
 186         //- Construct as copy setting internal field reference
 187         surfaceDisplacementPointPatchVectorField
 188         (
 189             const surfaceDisplacementPointPatchVectorField&,
 190             const DimensionedField<vector, pointMesh>&
 191         );
 192
 193         //- Construct and return a clone setting internal field reference
 194         virtual autoPtr<pointPatchVectorField> clone
 195         (
 196             const DimensionedField<vector, pointMesh>& iF
 197         ) const
 198         {
 199             return autoPtr<pointPatchVectorField>
 200             (
 201                 new surfaceDisplacementPointPatchVectorField
 202                 (
 203                     *this,
 204                     iF
 205                 )
 206             );
 207         }
 208
 209     // Member Functions
 210
 211         //- Surface to follow. Demand loads surfaceNames.
 212         const searchableSurfaces& surfaces() const;
 213
 214         //- Update the coefficients associated with the patch field
 215         virtual void updateCoeffs();
 216
 217         //- Write
 218         virtual void write(Ostream&) const;
 219 };
 220
 221
 222 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 223
 224 } // End namespace Foam
 225
 226 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 227
 228 #endif
 229
 230 // ************************************************************************* //