Initial commit for version 2.0.x patch release
[OpenFOAM-2.0.x.git] / src / thermophysicalModels / properties / solidProperties / ash / ash.H
blob9883a208651a11793dab3227933c96ec8bd0726a
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2008-2011 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::ash
27 Description
28     Coal ash solid properties
30 SourceFiles
31     ash.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef solid_ash_H
36 #define solid_ash_H
38 #include "solidProperties.H"
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 namespace Foam
45 class ash;
47 Ostream& operator<<
49     Ostream&,
50     const ash&
54 /*---------------------------------------------------------------------------*\
55                               Class ash Declaration
56 \*---------------------------------------------------------------------------*/
58 class ash
60     public solidProperties
63 public:
65     //- Runtime type information
66     TypeName("ash");
69     // Constructors
71         //- Construct null
72         ash();
74         //- Construct from solidProperties
75         ash(const solidProperties& s);
77         //- Construct from Istream
78         ash(Istream& is);
80         //- Construct from dictionary
81         ash(const dictionary& dict);
83         //- Construct copy
84         ash(const ash& s);
86         //- Construct and return clone
87         virtual autoPtr<solidProperties> clone() const
88         {
89             return autoPtr<solidProperties>(new ash(*this));
90         }
93     // I-O
95         //- Write the function coefficients
96         void writeData(Ostream& os) const;
99     // Ostream Operator
101         friend Ostream& operator<<(Ostream& os, const ash& s);
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 } // End namespace Foam
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 #endif
113 // ************************************************************************* //