All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
noSlipFvPatchVectorField.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) 2016-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::noSlipFvPatchVectorField
26 
27 Description
28  This boundary condition fixes the velocity to zero at walls.
29 
30 Usage
31  Example of the boundary condition specification:
32  \verbatim
33  <patchName>
34  {
35  type noSlip;
36  }
37  \endverbatim
38 
39 See also
40  Foam::fixedValueFvPatchVectorField
41 
42 SourceFiles
43  noSlipFvPatchVectorField.C
44 
45 \*---------------------------------------------------------------------------*/
46 
47 #ifndef noSlipFvPatchVectorField_H
48 #define noSlipFvPatchVectorField_H
49 
51 
52 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
53 
54 namespace Foam
55 {
56 
57 /*---------------------------------------------------------------------------*\
58  Class noSlipFvPatchVectorField Declaration
59 \*---------------------------------------------------------------------------*/
60 
62 :
63  public fixedValueFvPatchVectorField
64 {
65 
66 public:
67 
68  //- Runtime type information
69  TypeName("noSlip");
70 
71 
72  // Constructors
73 
74  //- Construct from patch and internal field
76  (
77  const fvPatch&,
79  );
80 
81  //- Construct from patch, internal field and dictionary
83  (
84  const fvPatch&,
86  const dictionary&
87  );
88 
89  //- Construct by mapping given noSlipFvPatchVectorField
90  // onto a new patch
92  (
94  const fvPatch&,
96  const fvPatchFieldMapper&
97  );
98 
99  //- Disallow copy without setting internal field reference
101  (
103  ) = delete;
104 
105  //- Copy constructor setting internal field reference
107  (
110  );
111 
112  //- Construct and return a clone setting internal field reference
114  (
116  ) const
117  {
119  (
120  new noSlipFvPatchVectorField(*this, iF)
121  );
122  }
123 
124 
125  // Member Functions
126 
127  //- Write
128  virtual void write(Ostream&) const;
129 };
130 
131 
132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
133 
134 } // End namespace Foam
135 
136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
137 
138 #endif
139 
140 // ************************************************************************* //
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
noSlipFvPatchVectorField(const fvPatch &, const DimensionedField< vector, volMesh > &)
Construct from patch and internal field.
Foam::fvPatchFieldMapper.
This boundary condition fixes the velocity to zero at walls.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
TypeName("noSlip")
Runtime type information.
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 tmp< fvPatchVectorField > clone(const DimensionedField< vector, volMesh > &iF) const
Construct and return a clone setting internal field reference.
virtual void write(Ostream &) const
Write.
Namespace for OpenFOAM.