Merge branch 'master' of ssh://git.code.sf.net/p/foam-extend/foam-extend-3.2
[foam-extend-3.2.git] / src / lagrangian / dsmc / submodels / WallInteractionModel / MaxwellianThermal / MaxwellianThermal.H
blobbaa65c8ca3d62384e3753f2508ec6840c3606b19
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | foam-extend: Open Source CFD
4    \\    /   O peration     | Version:     3.2
5     \\  /    A nd           | Web:         http://www.foam-extend.org
6      \\/     M anipulation  | For copyright notice see file Copyright
7 -------------------------------------------------------------------------------
8 License
9     This file is part of foam-extend.
11     foam-extend 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 3 of the License, or (at your
14     option) any later version.
16     foam-extend is distributed in the hope that it will be useful, but
17     WITHOUT ANY WARRANTY; without even the implied warranty of
18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19     General Public License for more details.
21     You should have received a copy of the GNU General Public License
22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
24 Class
25     Foam::MaxwellianThermal
27 Description
28     Wall interaction setting microscopic velocity to a random one drawn from a
29     Maxwellian distribution corresponding to a specified temperature
31 \*---------------------------------------------------------------------------*/
33 #ifndef MaxwellianThermal_H
34 #define MaxwellianThermal_H
36 #include "WallInteractionModel.H"
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 namespace Foam
42 /*---------------------------------------------------------------------------*\
43                       Class MaxwellianThermal Declaration
44 \*---------------------------------------------------------------------------*/
46 template<class CloudType>
47 class MaxwellianThermal
49     public WallInteractionModel<CloudType>
51 public:
53     //- Runtime type information
54     TypeName("MaxwellianThermal");
57     // Constructors
59         //- Construct from dictionary
60         MaxwellianThermal
61         (
62             const dictionary& dict,
63             CloudType& cloud
64         );
67     // Destructor
68     virtual ~MaxwellianThermal();
71     // Member Functions
73         //- Apply wall correction
74         virtual void correct
75         (
76             const wallPolyPatch& wpp,
77             const label faceId,
78             vector& U,
79             scalar& Ei,
80             label typeId
81         );
85 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
87 } // End namespace Foam
89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91 #ifdef NoRepository
92 #   include "MaxwellianThermal.C"
93 #endif
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 #endif
99 // ************************************************************************* //