src/thermophysicalModels/properties/solidProperties/CaCO3/CaCO3.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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 "solidProperties.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 solidProperties
  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 solidProperties
  75         CaCO3(const solidProperties& s);
  76
  77         //- Construct from Istream
  78         CaCO3(Istream& is);
  79
  80         //- Construct from dictionary
  81         CaCO3(const dictionary& dict);
  82
  83         //- Construct copy
  84         CaCO3(const CaCO3& s);
  85
  86         //- Construct and return clone
  87         virtual autoPtr<solidProperties> clone() const
  88         {
  89             return autoPtr<solidProperties>(new CaCO3(*this));
  90         }
  91
  92
  93     // I-O
  94
  95         //- Write the function coefficients
  96         void writeData(Ostream& os) const;
  97
  98
  99     // Ostream Operator
 100
 101         friend Ostream& operator<<(Ostream& os, const CaCO3& s);
 102 };
 103
 104
 105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 106
 107 } // End namespace Foam
 108
 109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 110
 111 #endif
 112
 113 // ************************************************************************* //