fixedNormalSlipPointPatchField.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-2017 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::fixedNormalSlipPointPatchField
28 
29 Description
30  slip with user-specified normal
31 
32 SourceFiles
33  fixedNormalSlipPointPatchField.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef fixedNormalSlipPointPatchField_H
38 #define fixedNormalSlipPointPatchField_H
39 
40 #include "slipPointPatchField.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 // Forward declaration of friend functions and operators
48 
49 template<class Type>
51 
52 template<class Type>
53 Ostream& operator<<
54 (
55  Ostream&,
57 );
58 
59 
60 /*---------------------------------------------------------------------------*\
61  Class fixedNormalSlipPointPatchField Declaration
62 \*---------------------------------------------------------------------------*/
63 
64 template<class Type>
66 :
67  public slipPointPatchField<Type>
68 {
69  // Private data
70 
71  //- User specified normal
72  vector n_;
73 
74 
75 public:
76 
77  //- Runtime type information
78  TypeName("fixedNormalSlip");
79 
80 
81  // Constructors
82 
83  //- Construct from patch and internal field
85  (
86  const pointPatch&,
88  );
89 
90  //- Construct from patch, internal field and dictionary
92  (
93  const pointPatch&,
95  const dictionary&
96  );
97 
98  //- Construct by mapping given patchField<Type> onto a new patch
100  (
102  const pointPatch&,
104  const pointPatchFieldMapper&
105  );
106 
107  //- Construct and return a clone
108  virtual autoPtr<pointPatchField<Type>> clone() const
109  {
111  (
113  (
114  *this
115  )
116  );
117  }
118 
119  //- Construct as copy setting internal field reference
121  (
124  );
125 
126  //- Construct and return a clone setting internal field reference
128  (
130  ) const
131  {
133  (
135  (
136  *this,
137  iF
138  )
139  );
140  }
141 
142  // Member functions
143 
144  //- Update the patch field
145  virtual void evaluate
146  (
148  );
149 
150  //- Write
151  virtual void write(Ostream&) const;
152 };
153 
154 
155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
156 
157 } // End namespace Foam
158 
159 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
160 
161 #ifdef NoRepository
163 #endif
164 
165 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
166 
167 #endif
168 
169 // ************************************************************************* //
Foam::fixedNormalSlipPointPatchField::write
virtual void write(Ostream &) const
Write.
Definition: fixedNormalSlipPointPatchField.C:102
Foam::fixedNormalSlipPointPatchField
slip with user-specified normal
Definition: fixedNormalSlipPointPatchField.H:49
slipPointPatchField.H
Foam::pointPatch
Basic pointPatch represents a set of points from the mesh.
Definition: pointPatch.H:58
Foam::pointPatchFieldMapper
Foam::pointPatchFieldMapper.
Definition: pointPatchFieldMapper.H:48
Foam::fixedNormalSlipPointPatchField::clone
virtual autoPtr< pointPatchField< Type > > clone() const
Construct and return a clone.
Definition: fixedNormalSlipPointPatchField.H:107
fixedNormalSlipPointPatchField.C
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam::slipPointPatchField
Foam::slipPointPatchField.
Definition: slipPointPatchField.H:51
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::fixedNormalSlipPointPatchField::TypeName
TypeName("fixedNormalSlip")
Runtime type information.
Foam::UPstream::commsTypes
commsTypes
Types of communications.
Definition: UPstream.H:69
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
Foam::Vector< scalar >
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
Foam::fixedNormalSlipPointPatchField::evaluate
virtual void evaluate(const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
Update the patch field.
Definition: fixedNormalSlipPointPatchField.C:87
Foam::fixedNormalSlipPointPatchField::fixedNormalSlipPointPatchField
fixedNormalSlipPointPatchField(const pointPatch &, const DimensionedField< Type, pointMesh > &)
Construct from patch and internal field.
Definition: fixedNormalSlipPointPatchField.C:34
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:54
Foam::UPstream::commsTypes::blocking