src/postProcessing/functionObjects/forces/pointPatchFields/derived/sixDoFRigidBodyDisplacement/sixDoFRigidBodyDisplacementPointPatchVectorField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   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::sixDoFRigidBodyDisplacementPointPatchVectorField
  27
  28 Description
  29     Foam::sixDoFRigidBodyDisplacementPointPatchVectorField
  30
  31 SourceFiles
  32     sixDoFRigidBodyDisplacementPointPatchVectorField.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef sixDoFRigidBodyDisplacementPointPatchVectorField_H
  37 #define sixDoFRigidBodyDisplacementPointPatchVectorField_H
  38
  39 #include "fixedValuePointPatchField.H"
  40 #include "sixDoFRigidBodyMotion.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48         Class sixDoFRigidBodyDisplacementPointPatchVectorField Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class sixDoFRigidBodyDisplacementPointPatchVectorField
  52 :
  53     public fixedValuePointPatchField<vector>
  54 {
  55     // Private data
  56
  57         //- Six dof motion object
  58         sixDoFRigidBodyMotion motion_;
  59
  60         //- Initial positions of points on the patch
  61         pointField initialPoints_;
  62
  63         //- Reference density required by the forces object for
  64         //  incompressible calculations
  65         scalar rhoInf_;
  66
  67
  68 public:
  69
  70     //- Runtime type information
  71     TypeName("sixDoFRigidBodyDisplacement");
  72
  73
  74     // Constructors
  75
  76         //- Construct from patch and internal field
  77         sixDoFRigidBodyDisplacementPointPatchVectorField
  78         (
  79             const pointPatch&,
  80             const DimensionedField<vector, pointMesh>&
  81         );
  82
  83         //- Construct from patch, internal field and dictionary
  84         sixDoFRigidBodyDisplacementPointPatchVectorField
  85         (
  86             const pointPatch&,
  87             const DimensionedField<vector, pointMesh>&,
  88             const dictionary&
  89         );
  90
  91         //- Construct by mapping given patchField<vector> onto a new patch
  92         sixDoFRigidBodyDisplacementPointPatchVectorField
  93         (
  94             const sixDoFRigidBodyDisplacementPointPatchVectorField&,
  95             const pointPatch&,
  96             const DimensionedField<vector, pointMesh>&,
  97             const pointPatchFieldMapper&
  98         );
  99
 100         //- Construct and return a clone
 101         virtual autoPtr<pointPatchField<vector> > clone() const
 102         {
 103             return autoPtr<pointPatchField<vector> >
 104             (
 105                 new sixDoFRigidBodyDisplacementPointPatchVectorField
 106                 (
 107                     *this
 108                 )
 109             );
 110         }
 111
 112         //- Construct as copy setting internal field reference
 113         sixDoFRigidBodyDisplacementPointPatchVectorField
 114         (
 115             const sixDoFRigidBodyDisplacementPointPatchVectorField&,
 116             const DimensionedField<vector, pointMesh>&
 117         );
 118
 119         //- Construct and return a clone setting internal field reference
 120         virtual autoPtr<pointPatchField<vector> > clone
 121         (
 122             const DimensionedField<vector, pointMesh>& iF
 123         ) const
 124         {
 125             return autoPtr<pointPatchField<vector> >
 126             (
 127                 new sixDoFRigidBodyDisplacementPointPatchVectorField
 128                 (
 129                     *this,
 130                     iF
 131                 )
 132             );
 133         }
 134
 135
 136     // Member functions
 137
 138         // Mapping functions
 139
 140             //- Map (and resize as needed) from self given a mapping object
 141             virtual void autoMap
 142             (
 143                 const pointPatchFieldMapper&
 144             );
 145
 146             //- Reverse map the given pointPatchField onto this pointPatchField
 147             virtual void rmap
 148             (
 149                 const pointPatchField<vector>&,
 150                 const labelList&
 151             );
 152
 153
 154         // Evaluation functions
 155
 156             //- Update the coefficients associated with the patch field
 157             virtual void updateCoeffs();
 158
 159
 160         //- Write
 161         virtual void write(Ostream&) const;
 162 };
 163
 164
 165 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 166
 167 } // End namespace Foam
 168
 169 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 170
 171 #endif
 172
 173 // ************************************************************************* //