Forward compatibility: flex
[foam-extend-3.2.git] / src / dynamicMesh / meshMotion / fvMotionSolver / pointPatchFields / derived / oscillatingVelocity / oscillatingVelocityPointPatchVectorField.H
blob104bb5642a7539ecdad75634338b002f595b4e01
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | foam-extend: Open Source CFD
4    \\    /   O peration     | Version:     3.2
5     \\  /    A nd           | Web:         http://www.foam-extend.org
6      \\/     M anipulation  | For copyright notice see file Copyright
7 -------------------------------------------------------------------------------
8 License
9     This file is part of foam-extend.
11     foam-extend is free software: you can redistribute it and/or modify it
12     under the terms of the GNU General Public License as published by the
13     Free Software Foundation, either version 3 of the License, or (at your
14     option) any later version.
16     foam-extend is distributed in the hope that it will be useful, but
17     WITHOUT ANY WARRANTY; without even the implied warranty of
18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19     General Public License for more details.
21     You should have received a copy of the GNU General Public License
22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
24 Class
25     Foam::oscillatingVelocityPointPatchVectorField
27 Description
28     Foam::oscillatingVelocityPointPatchVectorField
30 SourceFiles
31     oscillatingVelocityPointPatchVectorField.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef oscillatingVelocityPointPatchVectorField_H
36 #define oscillatingVelocityPointPatchVectorField_H
38 #include "fixedValuePointPatchFields.H"
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 namespace Foam
45 /*---------------------------------------------------------------------------*\
46         Class oscillatingVelocityPointPatchVectorField Declaration
47 \*---------------------------------------------------------------------------*/
49 class oscillatingVelocityPointPatchVectorField
51     public FixedValuePointPatchField
52     <
53         pointPatchField,
54         pointMesh,
55         pointPatch,
56         DummyMatrix,
57         vector
58     >
60     // Private data
62         vector amplitude_;
63         scalar omega_;
65         pointField p0_;
68 public:
70     //- Runtime type information
71     TypeName("oscillatingVelocity");
74     // Constructors
76         //- Construct from patch and internal field
77         oscillatingVelocityPointPatchVectorField
78         (
79             const pointPatch&,
80             const DimensionedField<vector, pointMesh>&
81         );
83         //- Construct from patch, internal field and dictionary
84         oscillatingVelocityPointPatchVectorField
85         (
86             const pointPatch&,
87             const DimensionedField<vector, pointMesh>&,
88             const dictionary&
89         );
91         //- Construct by mapping given patchField<vector> onto a new patch
92         oscillatingVelocityPointPatchVectorField
93         (
94             const oscillatingVelocityPointPatchVectorField&,
95             const pointPatch&,
96             const DimensionedField<vector, pointMesh>&,
97             const PointPatchFieldMapper&
98         );
100         //- Construct and return a clone
101         virtual autoPtr<pointPatchField<vector> > clone() const
102         {
103             return autoPtr<pointPatchField<vector> >
104             (
105                 new oscillatingVelocityPointPatchVectorField(*this)
106             );
107         }
109         //- Construct as copy setting internal field reference
110         oscillatingVelocityPointPatchVectorField
111         (
112             const oscillatingVelocityPointPatchVectorField&,
113             const DimensionedField<vector, pointMesh>&
114         );
116         //- Construct and return a clone setting internal field reference
117         virtual autoPtr<pointPatchField<vector> > clone
118         (
119             const DimensionedField<vector, pointMesh>& iF
120         ) const
121         {
122             return autoPtr<pointPatchField<vector> >
123             (
124                 new oscillatingVelocityPointPatchVectorField(*this, iF)
125             );
126         }
129     // Member functions
131         // Evaluation functions
133             //- Update the coefficients associated with the patch field
134             virtual void updateCoeffs();
137         //- Write
138         virtual void write(Ostream&) const;
142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
144 } // End namespace Foam
146 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
148 #endif
150 // ************************************************************************* //