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 / SpecularReflection / SpecularReflection.H
blob9f56df3dedea67ea1ddf255a926a6ab393b2f714
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::SpecularReflection
27 Description
28     Reversing the wall-normal component of the particle velocity
30 \*---------------------------------------------------------------------------*/
32 #ifndef SpecularReflection_H
33 #define SpecularReflection_H
35 #include "WallInteractionModel.H"
37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
39 namespace Foam
41 /*---------------------------------------------------------------------------*\
42                       Class SpecularReflection Declaration
43 \*---------------------------------------------------------------------------*/
45 template<class CloudType>
46 class SpecularReflection
48     public WallInteractionModel<CloudType>
50 public:
52     //- Runtime type information
53     TypeName("SpecularReflection");
56     // Constructors
58         //- Construct from dictionary
59         SpecularReflection
60         (
61             const dictionary& dict,
62             CloudType& cloud
63         );
66     // Destructor
67     virtual ~SpecularReflection();
70     // Member Functions
72         //- Apply wall correction
73         virtual void correct
74         (
75             const wallPolyPatch& wpp,
76             const label faceId,
77             vector& U,
78             scalar& Ei,
79             label typeId
80         );
84 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
86 } // End namespace Foam
88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
90 #ifdef NoRepository
91 #   include "SpecularReflection.C"
92 #endif
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 #endif
98 // ************************************************************************* //