translatingWallVelocityFvPatchVectorField.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-2020 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::translatingWallVelocityFvPatchVectorField
26 
27 Description
28  This boundary condition provides a velocity condition for translational
29  motion on walls.
30 
31 Usage
32  \table
33  Property | Description | Required | Default value
34  U | translational velocity | yes |
35  \endtable
36 
37  Example of the boundary condition specification:
38  \verbatim
39  <patchName>
40  {
41  type translatingWallVelocity;
42  U (100 0 0);
43  }
44  \endverbatim
45 
46  The \c U entry is a Function1 of time, see Foam::Function1s.
47 
48 
49 See also
50  Foam::fixedValueFvPatchField
51  Foam::Function1s
52 
53 SourceFiles
54  translatingWallVelocityFvPatchVectorField.C
55 
56 \*---------------------------------------------------------------------------*/
57 
58 #ifndef translatingWallVelocityFvPatchVectorField_H
59 #define translatingWallVelocityFvPatchVectorField_H
60 
62 #include "Function1.H"
63 
64 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
65 
66 namespace Foam
67 {
68 
69 /*---------------------------------------------------------------------------*\
70  Class translatingWallVelocityFvPatchField Declaration
71 \*---------------------------------------------------------------------------*/
72 
73 class translatingWallVelocityFvPatchVectorField
74 :
75  public fixedValueFvPatchVectorField
76 {
77  // Private Data
78 
79  //- Translational velocity
80  autoPtr<Function1<vector>> U_;
81 
82 
83 public:
84 
85  //- Runtime type information
86  TypeName("translatingWallVelocity");
87 
88 
89  // Constructors
90 
91  //- Construct from patch and internal field
93  (
94  const fvPatch&,
96  );
97 
98  //- Construct from patch, internal field and dictionary
100  (
101  const fvPatch&,
103  const dictionary&
104  );
105 
106  //- Construct by mapping given a
107  // translatingWallVelocityFvPatchVectorField onto a new patch
109  (
111  const fvPatch&,
113  const fvPatchFieldMapper&
114  );
115 
116  //- Disallow copy without setting internal field reference
118  (
120  ) = delete;
121 
122  //- Copy constructor setting internal field reference
124  (
127  );
128 
129  //- Construct and return a clone setting internal field reference
131  (
133  ) const
134  {
136  (
138  );
139  }
141 
142  // Member Functions
143 
144  //- Update the coefficients associated with the patch field
145  virtual void updateCoeffs();
146 
147  //- Write
148  virtual void write(Ostream&) const;
149 };
150 
151 
152 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
153 
154 } // End namespace Foam
155 
156 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
157 
158 #endif
159 
160 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:62
This boundary condition provides a velocity condition for translational motion on walls...
virtual tmp< fvPatchVectorField > clone(const DimensionedField< vector, volMesh > &iF) const
Construct and return a clone setting internal field reference.
Foam::fvPatchFieldMapper.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
translatingWallVelocityFvPatchVectorField(const fvPatch &, const DimensionedField< vector, volMesh > &)
Construct from patch and internal field.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
A class for managing temporary objects.
Definition: PtrList.H:53
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
TypeName("translatingWallVelocity")
Runtime type information.
Namespace for OpenFOAM.