waveDisplacementPointPatchVectorField.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-2016 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::waveDisplacementPointPatchVectorField
26 
27 Description
28  Foam::waveDisplacementPointPatchVectorField
29 
30 SourceFiles
31  waveDisplacementPointPatchVectorField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef waveDisplacementPointPatchVectorField_H
36 #define waveDisplacementPointPatchVectorField_H
37 
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class waveDisplacementPointPatchVectorField Declaration
47 \*---------------------------------------------------------------------------*/
48 
50 :
51  public fixedValuePointPatchField<vector>
52 {
53  // Private data
54 
55  vector amplitude_;
56  scalar omega_;
57  vector waveNumber_;
58 
59 
60 public:
61 
62  //- Runtime type information
63  TypeName("waveDisplacement");
64 
65 
66  // Constructors
67 
68  //- Construct from patch and internal field
70  (
71  const pointPatch&,
73  );
74 
75  //- Construct from patch, internal field and dictionary
77  (
78  const pointPatch&,
80  const dictionary&
81  );
82 
83  //- Construct by mapping given patchField<vector> onto a new patch
85  (
87  const pointPatch&,
90  );
91 
92  //- Construct and return a clone
93  virtual autoPtr<pointPatchField<vector>> clone() const
94  {
96  (
98  (
99  *this
100  )
101  );
102  }
103 
104  //- Construct as copy setting internal field reference
106  (
109  );
110 
111  //- Construct and return a clone setting internal field reference
113  (
115  ) const
116  {
118  (
120  (
121  *this,
122  iF
123  )
124  );
125  }
126 
127 
128  // Member functions
129 
130  // Evaluation functions
131 
132  //- Update the coefficients associated with the patch field
133  virtual void updateCoeffs();
134 
135 
136  //- Write
137  virtual void write(Ostream&) const;
138 };
139 
140 
141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
142 
143 } // End namespace Foam
144 
145 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
146 
147 #endif
148 
149 // ************************************************************************* //
TypeName("waveDisplacement")
Runtime type information.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
A FixedValue boundary condition for pointField.
waveDisplacementPointPatchVectorField(const pointPatch &, const DimensionedField< vector, pointMesh > &)
Construct from patch and internal field.
Foam::pointPatchFieldMapper.
Foam::waveDisplacementPointPatchVectorField.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
virtual autoPtr< pointPatchField< vector > > clone() const
Construct and return a clone.
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...
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:53
Namespace for OpenFOAM.