DOC: Corrected class names in the file descriptions
[freefoam.git] / src / lagrangian / intermediate / parcels / baseClasses / reactingParcel / reactingParcel.H
bloba27b82a328fe517301fa6ea0d3e9fd5e0788a376
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2008-2010 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
13     the Free Software Foundation, either version 3 of the License, or
14     (at your 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, see <http://www.gnu.org/licenses/>.
24 Class
25     Foam::reactingParcel
27 Description
28     Base class for reacting parcel - simply used to set the contiguous flag
30 SourceFiles
31     reactingParcel.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef reactingParcel_H
36 #define reactingParcel_H
38 #include <OpenFOAM/typeInfo.H>
39 #include <OpenFOAM/contiguous.H>
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 namespace Foam
46 /*---------------------------------------------------------------------------*\
47                        Class reactingParcel Declaration
48 \*---------------------------------------------------------------------------*/
50 class reactingParcel
52 public:
54     //- Run-time type information
55     TypeName("reactingParcel");
57     //- Construct null
58     reactingParcel();
60     //- Destructor
61     virtual ~reactingParcel();
65 template<>
66 inline bool contiguous<reactingParcel>()
68     return false; // Derived classes include scalar lists/fields
72 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
74 } // End namespace Foam
76 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
78 #endif
80 // ************************ vim: set sw=4 sts=4 et: ************************ //