slipFvPatchField.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2016 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::slipFvPatchField
28 
29 Group
30  grpWallBoundaryConditions grpGenericBoundaryConditions
31 
32 Description
33  This boundary condition provides a slip constraint.
34 
35 Usage
36  Example of the boundary condition specification:
37  \verbatim
38  <patchName>
39  {
40  type slip;
41  }
42  \endverbatim
43 
44 SourceFiles
45  slipFvPatchField.C
46 
47 \*---------------------------------------------------------------------------*/
48 
49 #ifndef slipFvPatchField_H
50 #define slipFvPatchField_H
51 
53 
54 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
55 
56 namespace Foam
57 {
58 
59 /*---------------------------------------------------------------------------*\
60  Class slipFvPatchField Declaration
61 \*---------------------------------------------------------------------------*/
62 
63 template<class Type>
64 class slipFvPatchField
65 :
66  public basicSymmetryFvPatchField<Type>
67 {
68 
69 public:
70 
71  //- Runtime type information
72  TypeName("slip");
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 slipFvPatchField onto a new patch
94  (
96  const fvPatch&,
98  const fvPatchFieldMapper&
99  );
100 
101  //- Construct as copy
103  (
105  );
106 
107  //- Construct and return a clone
108  virtual tmp<fvPatchField<Type>> clone() const
109  {
110  return tmp<fvPatchField<Type>>
111  (
112  new slipFvPatchField<Type>(*this)
113  );
114  }
115 
116  //- Construct as copy setting internal field reference
118  (
119  const slipFvPatchField<Type>&,
121  );
122 
123  //- Construct and return a clone setting internal field reference
125  (
127  ) const
128  {
129  return tmp<fvPatchField<Type>>
130  (
131  new slipFvPatchField<Type>(*this, iF)
132  );
133  }
134 
135 
136  // Member functions
137 
138  // Attributes
139 
140  //- Return false: this patch field is not altered by assignment
141  virtual bool assignable() const
142  {
143  return false;
144  }
145 
146 
147  // Member operators
148 
149  // virtual void operator=(const UList<Type>&) {}
150 
151  // virtual void operator=(const fvPatchField<Type>&) {}
152  // virtual void operator+=(const fvPatchField<Type>&) {}
153  // virtual void operator-=(const fvPatchField<Type>&) {}
154  // virtual void operator*=(const fvPatchField<scalar>&) {}
155  // virtual void operator/=(const fvPatchField<scalar>&) {}
156 
157  // virtual void operator+=(const Field<Type>&) {}
158  // virtual void operator-=(const Field<Type>&) {}
159 
160  // virtual void operator*=(const Field<scalar>&) {}
161  // virtual void operator/=(const Field<scalar>&) {}
162 
163  // virtual void operator=(const Type&) {}
164  // virtual void operator+=(const Type&) {}
165  // virtual void operator-=(const Type&) {}
166  // virtual void operator*=(const scalar) {}
167  // virtual void operator/=(const scalar) {}
168 };
169 
170 
171 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
172 
173 } // End namespace Foam
174 
175 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
176 
177 #ifdef NoRepository
178  #include "slipFvPatchField.C"
179 #endif
180 
181 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
182 
183 #endif
184 
185 // ************************************************************************* //
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::slipFvPatchField::TypeName
TypeName("slip")
Runtime type information.
Foam::basicSymmetryFvPatchField
A symmetry patch.
Definition: basicSymmetryFvPatchField.H:55
Foam::slipFvPatchField::slipFvPatchField
slipFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
Definition: slipFvPatchField.C:34
Foam::fvPatch
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:65
basicSymmetryFvPatchField.H
slipFvPatchField.C
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::slipFvPatchField
This boundary condition provides a slip constraint.
Definition: slipFvPatchField.H:63
Foam::fvPatchFieldMapper
Foam::fvPatchFieldMapper.
Definition: fvPatchFieldMapper.H:47
Foam::slipFvPatchField::clone
virtual tmp< fvPatchField< Type > > clone() const
Construct and return a clone.
Definition: slipFvPatchField.H:107
Foam::slipFvPatchField::assignable
virtual bool assignable() const
Return false: this patch field is not altered by assignment.
Definition: slipFvPatchField.H:140
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:54