angularOscillatingVelocityPointPatchVectorField.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) 2011 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 
57  scalar angle0_;
58  scalar amplitude_;
59  scalar omega_;
60 
62 
63 
64 public:
65 
66  //- Runtime type information
67  TypeName("angularOscillatingVelocity");
68 
69 
70  // Constructors
71 
72  //- Construct from patch and internal field
74  (
75  const pointPatch&,
77  );
78 
79  //- Construct from patch, internal field and dictionary
81  (
82  const pointPatch&,
84  const dictionary&
85  );
86 
87  //- Construct by mapping given patchField<vector> onto a new patch
89  (
91  const pointPatch&,
94  );
95 
96  //- Construct and return a clone
97  virtual autoPtr<pointPatchField<vector> > clone() const
98  {
100  (
102  (
103  *this
104  )
105  );
106  }
107 
108  //- Construct as copy setting internal field reference
110  (
113  );
114 
115  //- Construct and return a clone setting internal field reference
117  (
119  ) const
120  {
122  (
124  (
125  *this,
126  iF
127  )
128  );
129  }
130 
131 
132  // Member functions
133 
134  // Mapping functions
135 
136  //- Map (and resize as needed) from self given a mapping object
137  virtual void autoMap
138  (
139  const pointPatchFieldMapper&
140  );
141 
142  //- Reverse map the given pointPatchField onto this pointPatchField
143  virtual void rmap
144  (
146  const labelList&
147  );
148 
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 // ************************************************************************* //
Foam::angularOscillatingVelocityPointPatchVectorField::amplitude_
scalar amplitude_
Definition: angularOscillatingVelocityPointPatchVectorField.H:57
Foam::angularOscillatingVelocityPointPatchVectorField
Foam::angularOscillatingVelocityPointPatchVectorField.
Definition: angularOscillatingVelocityPointPatchVectorField.H:48
Foam::angularOscillatingVelocityPointPatchVectorField::TypeName
TypeName("angularOscillatingVelocity")
Runtime type information.
Foam::angularOscillatingVelocityPointPatchVectorField::omega_
scalar omega_
Definition: angularOscillatingVelocityPointPatchVectorField.H:58
Foam::pointPatch
Basic pointPatch represents a set of points from the mesh.
Definition: pointPatch.H:56
Foam::pointPatchField< vector >
Foam::angularOscillatingVelocityPointPatchVectorField::write
virtual void write(Ostream &) const
Write.
Definition: angularOscillatingVelocityPointPatchVectorField.C:182
Foam::angularOscillatingVelocityPointPatchVectorField::updateCoeffs
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Definition: angularOscillatingVelocityPointPatchVectorField.C:151
Foam::pointPatchFieldMapper
Foam::pointPatchFieldMapper.
Definition: pointPatchFieldMapper.H:46
Foam::angularOscillatingVelocityPointPatchVectorField::clone
virtual autoPtr< pointPatchField< vector > > clone() const
Construct and return a clone.
Definition: angularOscillatingVelocityPointPatchVectorField.H:96
Foam::angularOscillatingVelocityPointPatchVectorField::angle0_
scalar angle0_
Definition: angularOscillatingVelocityPointPatchVectorField.H:56
Foam::fixedValuePointPatchField
A FixedValue boundary condition for pointField.
Definition: fixedValuePointPatchField.H:49
Foam::Field
Pre-declare SubField and related Field type.
Definition: Field.H:57
fixedValuePointPatchField.H
Foam::dictionary
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:137
Foam
Namespace for OpenFOAM.
Definition: combustionModel.C:30
Foam::autoPtr
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:117
Foam::Vector< scalar >
Foam::List
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: HashTable.H:59
Foam::angularOscillatingVelocityPointPatchVectorField::angularOscillatingVelocityPointPatchVectorField
angularOscillatingVelocityPointPatchVectorField(const pointPatch &, const DimensionedField< vector, pointMesh > &)
Construct from patch and internal field.
Definition: angularOscillatingVelocityPointPatchVectorField.C:41
Foam::angularOscillatingVelocityPointPatchVectorField::autoMap
virtual void autoMap(const pointPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
Definition: angularOscillatingVelocityPointPatchVectorField.C:126
Foam::angularOscillatingVelocityPointPatchVectorField::axis_
vector axis_
Definition: angularOscillatingVelocityPointPatchVectorField.H:54
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:53
Foam::angularOscillatingVelocityPointPatchVectorField::origin_
vector origin_
Definition: angularOscillatingVelocityPointPatchVectorField.H:55
Foam::angularOscillatingVelocityPointPatchVectorField::rmap
virtual void rmap(const pointPatchField< vector > &, const labelList &)
Reverse map the given pointPatchField onto this pointPatchField.
Definition: angularOscillatingVelocityPointPatchVectorField.C:137
Foam::angularOscillatingVelocityPointPatchVectorField::p0_
pointField p0_
Definition: angularOscillatingVelocityPointPatchVectorField.H:60
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:51