initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / applications / solvers / compressible / rhoCentralFoam / BCs / U / maxwellSlipUFvPatchVectorField.H
blob5e3f39faf32a7e6aec7f385faf46339f90a00c10
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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 the
13     Free Software Foundation; either version 2 of the License, or (at your
14     option) any later version.
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.
21     You should have received a copy of the GNU General Public License
22     along with OpenFOAM; if not, write to the Free Software Foundation,
23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 Class
26     Foam::maxwellSlipUFvPatchVectorField
28 Description
29     Maxwell slip boundary condition including thermal creep and surface
30     curvature terms that can be optionally switched off.
32 SourceFiles
33     fixedRhoFvPatchScalarField.C
35 \*---------------------------------------------------------------------------*/
37 #ifndef maxwellSlipUFvPatchVectorField_H
38 #define maxwellSlipUFvPatchVectorField_H
40 #include "mixedFixedValueSlipFvPatchFields.H"
41 #include "Switch.H"
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 namespace Foam
48 /*---------------------------------------------------------------------------*\
49                 Class maxwellSlipUFvPatch Declaration
50 \*---------------------------------------------------------------------------*/
52 class maxwellSlipUFvPatchVectorField
54     public mixedFixedValueSlipFvPatchVectorField
57     // Private data
59         // Accommodation coefficient
60         scalar accommodationCoeff_;
62         // Wall velocity
63         vectorField Uwall_;
65         // Include thermal creep term (default on)
66         Switch thermalCreep_;
68         // Include boundary curvature term (default on)
69         Switch curvature_;
71 public:
73     //- Runtime type information
74     TypeName("maxwellSlipU");
77     // Constructors
79         //- Construct from patch and internal field
80         maxwellSlipUFvPatchVectorField
81         (
82             const fvPatch&,
83             const DimensionedField<vector, volMesh>&
84         );
86         //- Construct from patch, internal field and dictionary
87         maxwellSlipUFvPatchVectorField
88         (
89             const fvPatch&,
90             const DimensionedField<vector, volMesh>&,
91             const dictionary&
92         );
94         //- Construct by mapping given
95         //  maxwellSlipUFvPatchVectorField onto a new patch
96         maxwellSlipUFvPatchVectorField
97         (
98             const maxwellSlipUFvPatchVectorField&,
99             const fvPatch&,
100             const DimensionedField<vector, volMesh>&,
101             const fvPatchFieldMapper&
102         );
104         //- Construct and return a clone
105         virtual tmp<fvPatchVectorField> clone() const
106         {
107             return tmp<fvPatchVectorField>
108             (
109                 new maxwellSlipUFvPatchVectorField(*this)
110             );
111         }
113         //- Construct as copy setting internal field reference
114         maxwellSlipUFvPatchVectorField
115         (
116             const maxwellSlipUFvPatchVectorField&,
117             const DimensionedField<vector, volMesh>&
118         );
120         //- Construct and return a clone setting internal field reference
121         virtual tmp<fvPatchVectorField> clone
122         (
123             const DimensionedField<vector, volMesh>& iF
124         ) const
125         {
126             return tmp<fvPatchVectorField>
127             (
128                 new maxwellSlipUFvPatchVectorField(*this, iF)
129             );
130         }
132     // Member functions
134         //- Update the coefficients associated with the patch field
135         virtual void updateCoeffs();
137         //- Write
138         virtual void write(Ostream&) const;
142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
144 } // End namespace Foam
146 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
148 #endif
150 // ************************************************************************* //