angularOscillatingVelocityPointPatchVectorField.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) 2011-2023 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::angularOscillatingVelocityPointPatchVectorField
26 
27 Description
28  Foam::angularOscillatingVelocityPointPatchVectorField
29 
30 SourceFiles
31  angularOscillatingVelocityPointPatchVectorField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef angularOscillatingVelocityPointPatchVectorField_H
36 #define angularOscillatingVelocityPointPatchVectorField_H
37 
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class angularOscillatingVelocityPointPatchVectorField Declaration
47 \*---------------------------------------------------------------------------*/
48 
50 :
51  public fixedValuePointPatchField<vector>
52 {
53  // Private Data
54 
55  vector axis_;
56  vector origin_;
57  scalar angle0_;
58  scalar amplitude_;
59  scalar omega_;
60 
61  pointField p0_;
62 
63 
64 public:
65 
66  //- Runtime type information
67  TypeName("angularOscillatingVelocity");
68 
69 
70  // Constructors
71 
72  //- Construct from patch, internal field and dictionary
74  (
75  const pointPatch&,
77  const dictionary&
78  );
79 
80  //- Construct by mapping given
81  // angularOscillatingVelocityPointPatchVectorField
82  // onto a new patch
84  (
86  const pointPatch&,
89  );
90 
91  //- Construct as copy setting internal field reference
93  (
96  );
97 
98  //- Construct and return a clone setting internal field reference
100  (
102  ) const
103  {
105  (
107  (
108  *this,
109  iF
110  )
111  );
112  }
113 
114 
115  // Member Functions
116 
117  // Mapping functions
118 
119  //- Map the given pointPatchField onto this pointPatchField
120  virtual void map
121  (
123  const pointPatchFieldMapper&
124  );
125 
126  //- Reset the pointPatchField to the given pointPatchField
127  // Used for mesh to mesh mapping
128  virtual void reset(const pointPatchField<vector>&);
129 
130 
131  // Evaluation functions
132 
133  //- Update the coefficients associated with the patch field
134  virtual void updateCoeffs();
135 
136 
137  //- Write
138  virtual void write(Ostream&) const;
139 };
140 
141 
142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
143 
144 } // End namespace Foam
145 
146 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
147 
148 #endif
149 
150 // ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
tmp< Field< Type > > clone() const
Clone.
Definition: Field.C:240
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
angularOscillatingVelocityPointPatchVectorField(const pointPatch &, const DimensionedField< vector, pointMesh > &, const dictionary &)
Construct from patch, internal field and dictionary.
virtual void reset(const pointPatchField< vector > &)
Reset the pointPatchField to the given pointPatchField.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
virtual void map(const pointPatchField< vector > &, const pointPatchFieldMapper &)
Map the given pointPatchField onto this pointPatchField.
TypeName("angularOscillatingVelocity")
Runtime type information.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:160
A FixedValue boundary condition for pointField.
Foam::pointPatchFieldMapper.
Abstract base class for point-mesh patch fields.
Basic pointPatch represents a set of points from the mesh.
Definition: pointPatch.H:57
Namespace for OpenFOAM.