maxwellSlipUFvPatchVectorField.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-2022 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::maxwellSlipUFvPatchVectorField
26 
27 Description
28  Maxwell slip boundary condition including thermal creep and surface
29  curvature terms that can be optionally switched off.
30 
31 SourceFiles
32  fixedRhoFvPatchScalarField.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef maxwellSlipUFvPatchVectorField_H
37 #define maxwellSlipUFvPatchVectorField_H
38 
40 #include "Switch.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class maxwellSlipUFvPatch Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 :
53  public mixedFixedValueSlipFvPatchVectorField
54 {
55  // Private Data
56 
57  //- Temperature field name, default = "T"
58  word TName_;
59 
60  //- Density field name, default = "rho"
61  word rhoName_;
62 
63  //- Compressibility field name, default = "thermo:psi"
64  word psiName_;
65 
66  //- Dynamic viscosity field name, default = "thermo:mu"
67  word muName_;
68 
69  //- tauMC field name, default = "tauMC"
70  word tauMCName_;
71 
72  // Accommodation coefficient
73  scalar accommodationCoeff_;
74 
75  // Wall velocity
76  vectorField Uwall_;
77 
78  // Include thermal creep term (default on)
79  Switch thermalCreep_;
80 
81  // Include boundary curvature term (default on)
82  Switch curvature_;
83 
84 
85 public:
86 
87  //- Runtime type information
88  TypeName("maxwellSlipU");
89 
90 
91  // Constructors
92 
93  //- Construct from patch and internal field
95  (
96  const fvPatch&,
98  );
99 
100  //- Construct from patch, internal field and dictionary
102  (
103  const fvPatch&,
105  const dictionary&
106  );
107 
108  //- Construct by mapping given
109  // maxwellSlipUFvPatchVectorField onto a new patch
111  (
113  const fvPatch&,
115  const fvPatchFieldMapper&
116  );
117 
118  //- Construct as copy setting internal field reference
120  (
123  );
124 
125  //- Construct and return a clone setting internal field reference
127  (
129  ) const
130  {
132  (
133  new maxwellSlipUFvPatchVectorField(*this, iF)
134  );
135  }
136 
137 
138  // Member Functions
139 
140  // Mapping functions
141 
142  //- Map (and resize as needed) from self given a mapping object
143  // Used to update fields following mesh topology change
144  virtual void autoMap(const fvPatchFieldMapper&);
145 
146  //- Reverse map the given fvPatchField onto this fvPatchField
147  // Used to reconstruct fields
148  virtual void rmap(const fvPatchVectorField&, const labelList&);
149 
150  //- Reset the fvPatchField to the given fvPatchField
151  // Used for mesh to mesh mapping
152  virtual void reset(const fvPatchVectorField&);
153 
154 
155  // Evaluation functions
156 
157  //- Update the coefficients associated with the patch field
158  virtual void updateCoeffs();
159 
160 
161  //- Write
162  virtual void write(Ostream&) const;
163 };
164 
165 
166 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
167 
168 } // End namespace Foam
169 
170 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
171 
172 #endif
173 
174 // ************************************************************************* //
virtual void write(Ostream &) const
Write.
virtual void reset(const fvPatchVectorField &)
Reset the fvPatchField to the given fvPatchField.
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
A simple wrapper around bool so that it can be read as a word: true/false, on/off, yes/no, y/n, t/f, or none/any.
Definition: Switch.H:60
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:66
Maxwell slip boundary condition including thermal creep and surface curvature terms that can be optio...
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
TypeName("maxwellSlipU")
Runtime type information.
A class for handling words, derived from string.
Definition: word.H:59
Foam::fvPatchFieldMapper.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
virtual void autoMap(const fvPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
virtual void rmap(const fvPatchVectorField &, const labelList &)
Reverse map the given fvPatchField onto this fvPatchField.
virtual tmp< fvPatchVectorField > clone(const DimensionedField< vector, volMesh > &iF) const
Construct and return a clone setting internal field reference.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
maxwellSlipUFvPatchVectorField(const fvPatch &, const DimensionedField< vector, volMesh > &)
Construct from patch and internal field.
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.