sixDoFMotion: Adding restraints and constraints to the motion of objects.
[OpenFOAM-1.6.x.git] / src / postProcessing / functionObjects / forces / pointPatchFields / derived / uncoupledSixDoFRigidBodyDisplacement / uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField.H
blobfb4177d10464ecbd32726b7abb4f3fac56d6f487
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.
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.
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.
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
25 Class
26     Foam::uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField
28 Description
29     Foam::uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField
31 SourceFiles
32     uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField.C
34 \*---------------------------------------------------------------------------*/
36 #ifndef uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField_H
37 #define uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField_H
39 #include "fixedValuePointPatchField.H"
40 #include "sixDoFRigidBodyMotion.H"
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 namespace Foam
47 /*---------------------------------------------------------------------------*\
48   Class uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField Declaration
49 \*---------------------------------------------------------------------------*/
51 class uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField
53     public fixedValuePointPatchField<vector>
55     // Private data
57         //- Six dof motion object
58         sixDoFRigidBodyMotion motion_;
60         //- Reference positions of points on the patch
61         pointField p0_;
63         //- Reference density required by the forces object for
64         //  incompressible calculations.  Retained here to give
65         //  dictionary compatibility with other sixDoF patches.
66         scalar rhoInf_;
69 public:
71     //- Runtime type information
72     TypeName("uncoupledSixDoFRigidBodyDisplacement");
75     // Constructors
77         //- Construct from patch and internal field
78         uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField
79         (
80             const pointPatch&,
81             const DimensionedField<vector, pointMesh>&
82         );
84         //- Construct from patch, internal field and dictionary
85         uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField
86         (
87             const pointPatch&,
88             const DimensionedField<vector, pointMesh>&,
89             const dictionary&
90         );
92         //- Construct by mapping given patchField<vector> onto a new patch
93         uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField
94         (
95             const uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField&,
96             const pointPatch&,
97             const DimensionedField<vector, pointMesh>&,
98             const pointPatchFieldMapper&
99         );
101         //- Construct and return a clone
102         virtual autoPtr<pointPatchField<vector> > clone() const
103         {
104             return autoPtr<pointPatchField<vector> >
105             (
106                 new uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField
107                 (
108                     *this
109                 )
110             );
111         }
113         //- Construct as copy setting internal field reference
114         uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField
115         (
116             const uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField&,
117             const DimensionedField<vector, pointMesh>&
118         );
120         //- Construct and return a clone setting internal field reference
121         virtual autoPtr<pointPatchField<vector> > clone
122         (
123             const DimensionedField<vector, pointMesh>& iF
124         ) const
125         {
126             return autoPtr<pointPatchField<vector> >
127             (
128                 new uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField
129                 (
130                     *this,
131                     iF
132                 )
133             );
134         }
137     // Member functions
139         // Evaluation functions
141             //- Update the coefficients associated with the patch field
142             virtual void updateCoeffs();
145         //- Write
146         virtual void write(Ostream&) const;
150 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
152 } // End namespace Foam
154 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
156 #endif
158 // ************************************************************************* //