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