src/thermophysicalModels/solids/CaCO3/CaCO3.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::CaCO3
  27
  28 Description
  29     Calcium carbonate (limestone)
  30
  31 SourceFiles
  32     CaCO3.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef solid_CaCO3_H
  37 #define solid_CaCO3_H
  38
  39 #include "solid.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 class CaCO3;
  47
  48 Ostream& operator<<
  49 (
  50      Ostream&,
  51      const CaCO3&
  52 );
  53
  54
  55 /*---------------------------------------------------------------------------*\
  56                               Class CaCO3 Declaration
  57 \*---------------------------------------------------------------------------*/
  58
  59 class CaCO3
  60 :
  61     public solid
  62 {
  63
  64 public:
  65
  66     //- Runtime type information
  67     TypeName("CaCO3");
  68
  69
  70     // Constructors
  71
  72         //- Construct null
  73         CaCO3();
  74
  75         //- Construct from solid
  76         CaCO3(const solid& s);
  77
  78         //- Construct from Istream
  79         CaCO3(Istream& is);
  80
  81
  82     // I-O
  83
  84         //- Write the function coefficients
  85         void writeData(Ostream& os) const;
  86
  87
  88     // Ostream Operator
  89
  90         friend Ostream& operator<<(Ostream& os, const CaCO3& s);
  91 };
  92
  93
  94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  95
  96 } // End namespace Foam
  97
  98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  99
 100 #endif
 101
 102 // ************************************************************************* //