slipFvPatchField.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::slipFvPatchField
26 
27 Description
28  This boundary condition provides a slip constraint.
29 
30 Usage
31  Example of the boundary condition specification:
32  \verbatim
33  <patchName>
34  {
35  type slip;
36  }
37  \endverbatim
38 
39 SourceFiles
40  slipFvPatchField.C
41 
42 \*---------------------------------------------------------------------------*/
43 
44 #ifndef slipFvPatchField_H
45 #define slipFvPatchField_H
46 
48 
49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
50 
51 namespace Foam
52 {
53 
54 /*---------------------------------------------------------------------------*\
55  Class slipFvPatchField Declaration
56 \*---------------------------------------------------------------------------*/
57 
58 template<class Type>
59 class slipFvPatchField
60 :
61  public basicSymmetryFvPatchField<Type>
62 {
63 
64 public:
65 
66  //- Runtime type information
67  TypeName("slip");
68 
69 
70  // Constructors
71 
72  //- Construct from patch and internal field
74  (
75  const fvPatch&,
77  );
78 
79  //- Construct from patch, internal field and dictionary
81  (
82  const fvPatch&,
84  const dictionary&
85  );
86 
87  //- Construct by mapping given slipFvPatchField onto a new patch
89  (
91  const fvPatch&,
93  const fvPatchFieldMapper&
94  );
95 
96  //- Disallow copy without setting internal field reference
98 
99  //- Copy constructor setting internal field reference
101  (
102  const slipFvPatchField<Type>&,
104  );
105 
106  //- Construct and return a clone setting internal field reference
108  (
110  ) const
111  {
112  return tmp<fvPatchField<Type>>
113  (
114  new slipFvPatchField<Type>(*this, iF)
115  );
116  }
117 
118 
119  // Member Functions
120 
121  // Attributes
122 
123  //- Return false: this patch field is not altered by assignment
124  virtual bool assignable() const
125  {
126  return false;
127  }
128 
129 
130  // Member Operators
131 
132  // virtual void operator=(const UList<Type>&) {}
133 
134  // virtual void operator=(const fvPatchField<Type>&) {}
135  // virtual void operator+=(const fvPatchField<Type>&) {}
136  // virtual void operator-=(const fvPatchField<Type>&) {}
137  // virtual void operator*=(const fvPatchField<scalar>&) {}
138  // virtual void operator/=(const fvPatchField<scalar>&) {}
139 
140  // virtual void operator+=(const Field<Type>&) {}
141  // virtual void operator-=(const Field<Type>&) {}
142 
143  // virtual void operator*=(const Field<scalar>&) {}
144  // virtual void operator/=(const Field<scalar>&) {}
145 
146  // virtual void operator=(const Type&) {}
147  // virtual void operator+=(const Type&) {}
148  // virtual void operator-=(const Type&) {}
149  // virtual void operator*=(const scalar) {}
150  // virtual void operator/=(const scalar) {}
151 };
152 
153 
154 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
155 
156 } // End namespace Foam
157 
158 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
159 
160 #ifdef NoRepository
161  #include "slipFvPatchField.C"
162 #endif
163 
164 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
165 
166 #endif
167 
168 // ************************************************************************* //
slipFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
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:63
TypeName("slip")
Runtime type information.
Foam::fvPatchFieldMapper.
This boundary condition provides a slip constraint.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
virtual bool assignable() const
Return false: this patch field is not altered by assignment.
A class for managing temporary objects.
Definition: PtrList.H:53
tmp< fvPatchField< Type > > clone() const
Disallow clone without setting internal field reference.
Definition: fvPatchField.H:199
Namespace for OpenFOAM.