improvedNoSlipFvPatchVectorField.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) 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::improvedNoSlipFvPatchVectorField
26 
27 Group
28  grpWallBoundaryConditions
29 
30 Description
31  This boundary condition fixes the velocity to zero at walls.
32 
33 Usage
34  Example of the boundary condition specification:
35  \verbatim
36  <patchName>
37  {
38  type improvedNoSlip;
39  }
40  \endverbatim
41 
42 See also
43  Foam::fixedValueFvPatchVectorField
44 
45 SourceFiles
46  improvedNoSlipFvPatchVectorField.C
47 
48 \*---------------------------------------------------------------------------*/
49 
50 #ifndef improvedNoSlipFvPatchVectorField_H
51 #define improvedNoSlipFvPatchVectorField_H
52 
54 
55 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
56 
57 namespace Foam
58 {
59 
60 /*---------------------------------------------------------------------------*\
61  Class improvedNoSlipFvPatchVectorField Declaration
62 \*---------------------------------------------------------------------------*/
63 
65 :
66  public fixedValueFvPatchVectorField
67 {
68 
69 public:
70 
71  //- Runtime type information
72  TypeName("improvedNoSlip");
73 
74 
75  // Constructors
76 
77  //- Construct from patch and internal field
79  (
80  const fvPatch&,
82  );
83 
84  //- Construct from patch, internal field and dictionary
86  (
87  const fvPatch&,
89  const dictionary&
90  );
91 
92  //- Construct by mapping given improvedNoSlipFvPatchVectorField
93  // onto a new patch
95  (
97  const fvPatch&,
99  const fvPatchFieldMapper&
100  );
101 
102  //- Construct as copy
104  (
106  );
107 
108  //- Construct and return a clone
109  virtual tmp<fvPatchVectorField> clone() const
110  {
112  (
114  );
115  }
116 
117  //- Construct as copy setting internal field reference
119  (
122  );
123 
124  //- Construct and return a clone setting internal field reference
126  (
128  ) const
129  {
131  (
132  new improvedNoSlipFvPatchVectorField(*this, iF)
133  );
134  }
135 
136 
137  // Member functions
138 
139  //virtual tmp<Field<vector> > valueInternalCoeffs
140  //(
141  // const tmp<scalarField> &
142  //) const;
143 
144  //virtual tmp<Field<vector> > valueBoundaryCoeffs
145  //(
146  // const tmp<scalarField> &
147  //) const;
148 
149  virtual tmp<Field<vector> > gradientInternalCoeffs() const;
150 
151  virtual tmp<Field<vector> > gradientBoundaryCoeffs() const;
152 
153  //- Write
154  virtual void write(Ostream&) const;
155 };
156 
157 
158 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
159 
160 } // End namespace Foam
161 
162 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
163 
164 #endif
165 
166 // ************************************************************************* //
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:118
Foam::improvedNoSlipFvPatchVectorField::TypeName
TypeName("improvedNoSlip")
Runtime type information.
Foam::improvedNoSlipFvPatchVectorField::gradientBoundaryCoeffs
virtual tmp< Field< vector > > gradientBoundaryCoeffs() const
Definition: improvedNoSlipFvPatchVectorField.C:118
Foam::fvPatch
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
Foam::improvedNoSlipFvPatchVectorField::clone
virtual tmp< fvPatchVectorField > clone() const
Construct and return a clone.
Definition: improvedNoSlipFvPatchVectorField.H:108
Foam::improvedNoSlipFvPatchVectorField
This boundary condition fixes the velocity to zero at walls.
Definition: improvedNoSlipFvPatchVectorField.H:63
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::improvedNoSlipFvPatchVectorField::improvedNoSlipFvPatchVectorField
improvedNoSlipFvPatchVectorField(const fvPatch &, const DimensionedField< vector, volMesh > &)
Construct from patch and internal field.
Definition: improvedNoSlipFvPatchVectorField.C:33
Foam::improvedNoSlipFvPatchVectorField::write
virtual void write(Ostream &) const
Write.
Definition: improvedNoSlipFvPatchVectorField.C:145
fixedValueFvPatchFields.H
Foam::fvPatchFieldMapper
Foam::fvPatchFieldMapper.
Definition: fvPatchFieldMapper.H:45
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:53
Foam::improvedNoSlipFvPatchVectorField::gradientInternalCoeffs
virtual tmp< Field< vector > > gradientInternalCoeffs() const
Definition: improvedNoSlipFvPatchVectorField.C:101
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:51