src/regionModels/pyrolysisModels/pyrolysisModel/pyrolysisModelCollection.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::pyrolysisModelCollection
  26
  27 Description
  28     A centralized pyrolysis collection.
  29
  30     Container class for a set of pyrolysis with functions implemented
  31     to loop over the functions for each type.
  32
  33 SourceFiles
  34     pyrolysisModelCollection.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef pyrolysisModelCollection_H
  39 #define pyrolysisModelCollection_H
  40
  41 #include "IOPtrList.H"
  42 #include "pyrolysisModel.H"
  43 #include "fvc.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 // Forward declaration of friend functions and operators
  51 class fvMesh;
  52
  53 namespace regionModels
  54 {
  55 namespace pyrolysisModels
  56 {
  57
  58 /*---------------------------------------------------------------------------*\
  59                            Class pyrolysisModelCollection Declaration
  60 \*---------------------------------------------------------------------------*/
  61
  62 class pyrolysisModelCollection
  63 :
  64     public IOPtrList<pyrolysisModel>
  65 {
  66     // Private data
  67
  68         //- Reference to the finite volume mesh this zone is part of
  69         const fvMesh& mesh_;
  70
  71
  72     // Private Member Functions
  73
  74         //- Disallow default bitwise copy construct
  75         pyrolysisModelCollection(const pyrolysisModelCollection&);
  76
  77         //- Disallow default bitwise assignment
  78         void operator=(const pyrolysisModelCollection&);
  79
  80
  81 public:
  82
  83
  84     // Constructors
  85
  86         //- Construct from mesh
  87         pyrolysisModelCollection(const fvMesh&);
  88
  89
  90     // Member Functions
  91
  92         //- Pre-evolve regions
  93         void preEvolveRegion();
  94
  95          //- Evolve the pyrolysis equation regions
  96         void evolveRegion();
  97
  98         //- Evolve regions
  99         void evolve();
 100
 101         //- Provide some feedback from pyrolysis regions
 102         void info() const;
 103
 104         //- Return max diffusivity allowed in the solid
 105         scalar maxDiff() const;
 106
 107         //- Mean diffusion number of the solid regions
 108         scalar solidRegionDiffNo() const;
 109
 110 };
 111
 112
 113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 114
 115 } // End namespace pyrolysisModels
 116 } // End namespace regionModels
 117 } // End namespace Foam
 118
 119
 120 #endif
 121
 122 // ************************************************************************* //