FreeFOAM The Cross-Platform CFD Toolkit
CaCO3.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
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.
15 
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.
20 
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/>.
23 
24 Class
25  Foam::CaCO3
26 
27 Description
28  Calcium carbonate (limestone)
29 
30 SourceFiles
31  CaCO3.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef solid_CaCO3_H
36 #define solid_CaCO3_H
37 
38 #include <solids/solid.H>
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 class CaCO3;
46 
47 Ostream& operator<<
48 (
49  Ostream&,
50  const CaCO3&
51 );
52 
53 
54 /*---------------------------------------------------------------------------*\
55  Class CaCO3 Declaration
56 \*---------------------------------------------------------------------------*/
57 
58 class CaCO3
59 :
60  public solid
61 {
62 
63 public:
64 
65  //- Runtime type information
66  TypeName("CaCO3");
67 
68 
69  // Constructors
70 
71  //- Construct null
72  CaCO3();
73 
74  //- Construct from solid
75  CaCO3(const solid& s);
76 
77  //- Construct from Istream
78  CaCO3(Istream& is);
79 
80 
81  // I-O
82 
83  //- Write the function coefficients
84  void writeData(Ostream& os) const;
85 
86 
87  // Ostream Operator
88 
89  friend Ostream& operator<<(Ostream& os, const CaCO3& s);
90 };
91 
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 } // End namespace Foam
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 #endif
100 
101 // ************************ vim: set sw=4 sts=4 et: ************************ //