solidBodyMotionDisplacementPointPatchVectorField.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 | Copyright (C) 2013 OpenFOAM Foundation
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
13  the Free Software Foundation, either version 3 of the License, or
14  (at your 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, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::solidBodyMotionDisplacementPointPatchVectorField
26 
27 Description
28  Enables the specification of a fixed value boundary condition using the
29  solid body motion functions.
30 
31 SourceFiles
32  solidBodyMotionDisplacementPointPatchVectorField.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef solidBodyMotionDisplacementPointPatchVectorField_H
37 #define solidBodyMotionDisplacementPointPatchVectorField_H
38 
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class solidBodyMotionDisplacementPointPatchVectorField Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 :
53  public fixedValuePointPatchVectorField
54 {
55  // Private data
56 
57  //- The motion control function
59 
60  mutable autoPtr<pointField> localPoints0Ptr_;
61 
62 
63 public:
64 
65  //- Runtime type information
66  TypeName("solidBodyMotionDisplacement");
67 
68 
69  // Constructors
70 
71  //- Construct from patch and internal field
73  (
74  const pointPatch&,
76  );
77 
78  //- Construct from patch, internal field and dictionary
80  (
81  const pointPatch&,
83  const dictionary&
84  );
85 
86  //- Construct by mapping given patchField<vector> onto a new patch
88  (
90  const pointPatch&,
93  );
94 
95  //- Construct as copy
97  (
99  );
100 
101  //- Construct and return a clone
102  virtual autoPtr<pointPatchField<vector> > clone() const
103  {
105  (
107  (
108  *this
109  )
110  );
111  }
112 
113  //- Construct as copy setting internal field reference
115  (
118  );
119 
120 
121  //- Construct and return a clone setting internal field reference
123  (
125  ) const
126  {
128  (
130  (
131  *this,
132  iF
133  )
134  );
135  }
136 
137 
138  // Member functions
139 
140  // Access
141 
142  //- Return the fluctuation scale
143  const solidBodyMotionFunction& motion() const
144  {
145  return SBMFPtr_();
146  }
147 
148  const pointField& localPoints0() const;
149 
150  // Evaluation functions
151 
152  //- Update the coefficients associated with the patch field
153  virtual void updateCoeffs();
154 
155 
156  //- Write
157  virtual void write(Ostream&) const;
158 };
159 
160 
161 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
162 
163 } // End namespace Foam
164 
165 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
166 
167 #endif
168 
169 // ************************************************************************* //
Basic pointPatch represents a set of points from the mesh.
Definition: pointPatch.H:56
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Base class for defining solid-body motions.
virtual autoPtr< pointPatchField< vector > > clone() const
Construct and return a clone.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
const solidBodyMotionFunction & motion() const
Return the fluctuation scale.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
Enables the specification of a fixed value boundary condition using the solid body motion functions...
Foam::pointPatchFieldMapper.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
solidBodyMotionDisplacementPointPatchVectorField(const pointPatch &, const DimensionedField< vector, pointMesh > &)
Construct from patch and internal field.
TypeName("solidBodyMotionDisplacement")
Runtime type information.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:117