angularOscillatingDisplacementPointPatchVectorField.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::angularOscillatingDisplacementPointPatchVectorField
28 
29 Description
30  Foam::angularOscillatingDisplacementPointPatchVectorField
31 
32 SourceFiles
33  angularOscillatingDisplacementPointPatchVectorField.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef angularOscillatingDisplacementPointPatchVectorField_H
38 #define angularOscillatingDisplacementPointPatchVectorField_H
39 
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class angularOscillatingDisplacementPointPatchVectorField Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 :
53  public fixedValuePointPatchField<vector>
54 {
55  // Private data
56 
57  vector axis_;
58  vector origin_;
59  scalar angle0_;
60  scalar amplitude_;
61  scalar omega_;
62 
63  pointField p0_;
64 
65 
66 public:
67 
68  //- Runtime type information
69  TypeName("angularOscillatingDisplacement");
70 
71 
72  // Constructors
73 
74  //- Construct from patch and internal field
76  (
77  const pointPatch&,
79  );
80 
81  //- Construct from patch, internal field and dictionary
83  (
84  const pointPatch&,
86  const dictionary&
87  );
88 
89  //- Construct by mapping given patchField<vector> onto a new patch
91  (
93  const pointPatch&,
96  );
97 
98  //- Construct and return a clone
99  virtual autoPtr<pointPatchField<vector>> clone() const
100  {
102  (
104  (
105  *this
106  )
107  );
108  }
109 
110  //- Construct as copy setting internal field reference
112  (
115  );
116 
117  //- Construct and return a clone setting internal field reference
119  (
121  ) const
122  {
124  (
126  (
127  *this,
128  iF
129  )
130  );
131  }
132 
133 
134  // Member functions
135 
136  // Mapping functions
137 
138  //- Map (and resize as needed) from self given a mapping object
139  virtual void autoMap
140  (
141  const pointPatchFieldMapper&
142  );
143 
144  //- Reverse map the given pointPatchField onto this pointPatchField
145  virtual void rmap
146  (
148  const labelList&
149  );
150 
151 
152  // Evaluation functions
153 
154  //- Update the coefficients associated with the patch field
155  virtual void updateCoeffs();
156 
157 
158  //- Write
159  virtual void write(Ostream&) const;
160 };
161 
162 
163 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
164 
165 } // End namespace Foam
166 
167 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
168 
169 #endif
170 
171 // ************************************************************************* //
Foam::angularOscillatingDisplacementPointPatchVectorField
Foam::angularOscillatingDisplacementPointPatchVectorField.
Definition: angularOscillatingDisplacementPointPatchVectorField.H:50
Foam::pointPatch
Basic pointPatch represents a set of points from the mesh.
Definition: pointPatch.H:58
Foam::angularOscillatingDisplacementPointPatchVectorField::write
virtual void write(Ostream &) const
Write.
Definition: angularOscillatingDisplacementPointPatchVectorField.C:179
Foam::pointPatchField< vector >
Foam::pointPatchFieldMapper
Foam::pointPatchFieldMapper.
Definition: pointPatchFieldMapper.H:48
Foam::fixedValuePointPatchField
A FixedValue boundary condition for pointField.
Definition: fixedValuePointPatchField.H:51
Foam::Field< vector >
Foam::angularOscillatingDisplacementPointPatchVectorField::TypeName
TypeName("angularOscillatingDisplacement")
Runtime type information.
Foam::angularOscillatingDisplacementPointPatchVectorField::autoMap
virtual void autoMap(const pointPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
Definition: angularOscillatingDisplacementPointPatchVectorField.C:128
Foam::angularOscillatingDisplacementPointPatchVectorField::rmap
virtual void rmap(const pointPatchField< vector > &, const labelList &)
Reverse map the given pointPatchField onto this pointPatchField.
Definition: angularOscillatingDisplacementPointPatchVectorField.C:139
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
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::angularOscillatingDisplacementPointPatchVectorField::angularOscillatingDisplacementPointPatchVectorField
angularOscillatingDisplacementPointPatchVectorField(const pointPatch &, const DimensionedField< vector, pointMesh > &)
Construct from patch and internal field.
Definition: angularOscillatingDisplacementPointPatchVectorField.C:43
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
Foam::angularOscillatingDisplacementPointPatchVectorField::updateCoeffs
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Definition: angularOscillatingDisplacementPointPatchVectorField.C:153
Foam::angularOscillatingDisplacementPointPatchVectorField::clone
virtual autoPtr< pointPatchField< vector > > clone() const
Construct and return a clone.
Definition: angularOscillatingDisplacementPointPatchVectorField.H:98
Foam::Vector< scalar >
Foam::List< label >
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