slipFaPatchField.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) 2016-2017 Wikki Ltd
9  Copyright (C) 2019 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 Class
28  Foam::slipFaPatchField
29 
30 Description
31  Foam::slipFaPatchField
32 
33 Author
34  Zeljko Tukovic, FMENA
35  Hrvoje Jasak, Wikki Ltd.
36 
37 SourceFiles
38  slipFaPatchField.C
39 
40 \*---------------------------------------------------------------------------*/
41 
42 #ifndef slipFaPatchField_H
43 #define slipFaPatchField_H
44 
46 
47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
48 
49 namespace Foam
50 {
51 
52 /*---------------------------------------------------------------------------*\
53  Class slipFaPatch Declaration
54 \*---------------------------------------------------------------------------*/
55 
56 template<class Type>
57 class slipFaPatchField
58 :
59  public basicSymmetryFaPatchField<Type>
60 {
61 
62 public:
63 
64  //- Runtime type information
65  TypeName("slip");
66 
67 
68  // Constructors
69 
70  //- Construct from patch and internal field
72  (
73  const faPatch&,
75  );
76 
77  //- Construct from patch, internal field and dictionary
79  (
80  const faPatch&,
82  const dictionary&
83  );
84 
85  //- Construct by mapping given slipFaPatchField onto a new patch
87  (
89  const faPatch&,
91  const faPatchFieldMapper&
92  );
93 
94  //- Construct as copy
96  (
98  );
99 
100  //- Construct and return a clone
101  virtual tmp<faPatchField<Type>> clone() const
102  {
103  return tmp<faPatchField<Type>>
104  (
105  new slipFaPatchField<Type>(*this)
106  );
107  }
108 
109  //- Construct as copy setting internal field reference
111  (
112  const slipFaPatchField<Type>&,
114  );
115 
116  //- Construct and return a clone setting internal field reference
118  (
120  ) const
121  {
122  return tmp<faPatchField<Type>>
123  (
124  new slipFaPatchField<Type>(*this, iF)
125  );
126  }
127 
128  //- Destructor
129  virtual ~slipFaPatchField() = default;
130 };
131 
132 
133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134 
135 } // End namespace Foam
136 
137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
138 
139 #ifdef NoRepository
140  #include "slipFaPatchField.C"
141 #endif
142 
143 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
144 
145 #endif
146 
147 // ************************************************************************* //
Foam::slipFaPatchField::TypeName
TypeName("slip")
Runtime type information.
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::faPatchFieldMapper
Definition: faPatchFieldMapper.H:44
Foam::slipFaPatchField::clone
virtual tmp< faPatchField< Type > > clone() const
Construct and return a clone.
Definition: slipFaPatchField.H:100
Foam::basicSymmetryFaPatchField
A symmetry patch.
Definition: basicSymmetryFaPatchField.H:56
basicSymmetryFaPatchField.H
slipFaPatchField.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::slipFaPatchField
Foam::slipFaPatchField.
Definition: slipFaPatchField.H:56
Foam::slipFaPatchField::slipFaPatchField
slipFaPatchField(const faPatch &, const DimensionedField< Type, areaMesh > &)
Construct from patch and internal field.
Definition: slipFaPatchField.C:34
Foam::slipFaPatchField::~slipFaPatchField
virtual ~slipFaPatchField()=default
Destructor.
Foam::faPatch
Finite area patch class. Used for 2-D non-Euclidian finite area method.
Definition: faPatch.H:69
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:54