solidBodyMotionDisplacementPointPatchVectorField.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2013-2020 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  //- Disallow copy without setting internal field reference
97  (
99  ) = delete;
100 
101  //- Copy constructor setting internal field reference
103  (
106  );
107 
108 
109  //- Construct and return a clone setting internal field reference
111  (
113  ) const
114  {
116  (
118  (
119  *this,
120  iF
121  )
122  );
123  }
124 
125 
126  // Member Functions
127 
128  // Access
129 
130  //- Return the fluctuation scale
131  const solidBodyMotionFunction& motion() const
132  {
133  return SBMFPtr_();
134  }
135 
136  const pointField& localPoints0() const;
137 
138  // Evaluation functions
139 
140  //- Update the coefficients associated with the patch field
141  virtual void updateCoeffs();
142 
143 
144  //- Write
145  virtual void write(Ostream&) const;
146 };
147 
148 
149 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
150 
151 } // End namespace Foam
152 
153 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
154 
155 #endif
156 
157 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
Foam::pointPatchFieldMapper.
const solidBodyMotionFunction & motion() const
Return the fluctuation scale.
Base class for defining solid-body motions.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
virtual autoPtr< pointPatchField< vector > > clone(const DimensionedField< vector, pointMesh > &iF) const
Construct and return a clone setting internal field reference.
Basic pointPatch represents a set of points from the mesh.
Definition: pointPatch.H:56
Enables the specification of a fixed value boundary condition using the solid body motion functions...
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
solidBodyMotionDisplacementPointPatchVectorField(const pointPatch &, const DimensionedField< vector, pointMesh > &)
Construct from patch and internal field.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
TypeName("solidBodyMotionDisplacement")
Runtime type information.
Namespace for OpenFOAM.