uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2016 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField
28 
29 Description
30  Foam::uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField
31 
32 SourceFiles
33  uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField_H
38 #define uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField_H
39 
41 #include "sixDoFRigidBodyMotion.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 :
54  public fixedValuePointPatchField<vector>
55 {
56  // Private data
57 
58  //- Six dof motion object
59  sixDoFRigidBodyMotion motion_;
60 
61  //- Initial positions of points on the patch
62  pointField initialPoints_;
63 
64  //- Current time index (used for updating)
65  label curTimeIndex_;
66 
67 
68 public:
69 
70  //- Runtime type information
71  TypeName("uncoupledSixDoFRigidBodyDisplacement");
72 
73 
74  // Constructors
75 
76  //- Construct from patch and internal field
78  (
79  const pointPatch&,
81  );
82 
83  //- Construct from patch, internal field and dictionary
85  (
86  const pointPatch&,
88  const dictionary&
89  );
90 
91  //- Construct by mapping given patchField<vector> onto a new patch
93  (
95  const pointPatch&,
98  );
99 
100  //- Construct and return a clone
101  virtual autoPtr<pointPatchField<vector>> clone() const
102  {
104  (
106  (
107  *this
108  )
109  );
110  }
111 
112  //- Construct as copy setting internal field reference
114  (
117  );
118 
119  //- Construct and return a clone setting internal field reference
121  (
123  ) const
124  {
126  (
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  (
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 // ************************************************************************* //
Foam::uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::autoMap
virtual void autoMap(const pointPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
Definition: uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField.C:119
Foam::uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::rmap
virtual void rmap(const pointPatchField< vector > &, const labelList &)
Reverse map the given pointPatchField onto this pointPatchField.
Definition: uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField.C:130
Foam::uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Definition: uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField.C:147
Foam::uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField
uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField(const pointPatch &, const DimensionedField< vector, pointMesh > &)
Construct from patch and internal field.
Definition: uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField.C:46
Foam::pointPatch
Basic pointPatch represents a set of points from the mesh.
Definition: pointPatch.H:58
Foam::pointPatchField< vector >
sixDoFRigidBodyMotion.H
Foam::pointPatchFieldMapper
Foam::pointPatchFieldMapper.
Definition: pointPatchFieldMapper.H:48
Foam::uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::TypeName
TypeName("uncoupledSixDoFRigidBodyDisplacement")
Runtime type information.
Foam::fixedValuePointPatchField
A FixedValue boundary condition for pointField.
Definition: fixedValuePointPatchField.H:51
Foam::Field< vector >
fixedValuePointPatchField.H
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam::uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::write
virtual void write(Ostream &) const
Write.
Definition: uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField.C:196
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField
Foam::uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField.
Definition: uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField.H:51
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
Foam::sixDoFRigidBodyMotion
Six degree of freedom motion for a rigid body.
Definition: sixDoFRigidBodyMotion.H:69
Foam::List< label >
Foam::uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::clone
virtual autoPtr< pointPatchField< vector > > clone() const
Construct and return a clone.
Definition: uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField.H:100
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:54