src/regionModels/pyrolysisModels/pyrolysisModel/pyrolysisModel.C

   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 \*---------------------------------------------------------------------------*/
  25
  26 #include "pyrolysisModel.H"
  27 #include "fvMesh.H"
  28 #include "directMappedFieldFvPatchField.H"
  29
  30 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  31
  32 namespace Foam
  33 {
  34 namespace regionModels
  35 {
  36 namespace pyrolysisModels
  37 {
  38
  39 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  40
  41 defineTypeNameAndDebug(pyrolysisModel, 0);
  42 defineRunTimeSelectionTable(pyrolysisModel, mesh);
  43
  44 // * * * * * * * * * * * * Private Member Functions  * * * * * * * * * * * * //
  45
  46 void pyrolysisModel::constructMeshObjects()
  47 {
  48     // construct filmDelta field if coupled to film model
  49     if (filmCoupled_)
  50     {
  51         filmDeltaPtr_.reset
  52         (
  53             new volScalarField
  54             (
  55                 IOobject
  56                 (
  57                     "filmDelta",
  58                     time_.timeName(),
  59                     regionMesh(),
  60                     IOobject::MUST_READ,
  61                     IOobject::AUTO_WRITE
  62                 ),
  63                 regionMesh()
  64             )
  65         );
  66
  67         const volScalarField& filmDelta = filmDeltaPtr_();
  68
  69         bool foundCoupledPatch = false;
  70         forAll(filmDelta.boundaryField(), patchI)
  71         {
  72             const fvPatchField<scalar>& fvp = filmDelta.boundaryField()[patchI];
  73             if (isA<directMappedFieldFvPatchField<scalar> >(fvp))
  74             {
  75                 foundCoupledPatch = true;
  76                 break;
  77             }
  78         }
  79
  80         if (!foundCoupledPatch)
  81         {
  82             WarningIn("void pyrolysisModels::constructMeshObjects()")
  83                 << "filmCoupled flag set to true, but no "
  84                 << directMappedFieldFvPatchField<scalar>::typeName
  85                 << " patches found on " << filmDelta.name() << " field"
  86                 << endl;
  87         }
  88     }
  89 }
  90
  91
  92 // * * * * * * * * * * * * Protected Member Functions  * * * * * * * * * * * //
  93
  94 bool pyrolysisModel::read()
  95 {
  96     if (regionModel1D::read())
  97     {
  98         filmCoupled_ = readBool(coeffs_.lookup("filmCoupled"));
  99         reactionDeltaMin_ =
 100             coeffs_.lookupOrDefault<scalar>("reactionDeltaMin", 0.0);
 101
 102         return true;
 103     }
 104     else
 105     {
 106         return false;
 107     }
 108 }
 109
 110
 111 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
 112
 113 pyrolysisModel::pyrolysisModel(const fvMesh& mesh)
 114 :
 115     regionModel1D(mesh),
 116     filmCoupled_(false),
 117     filmDeltaPtr_(NULL),
 118     reactionDeltaMin_(0.0)
 119 {}
 120
 121
 122 pyrolysisModel::pyrolysisModel(const word& modelType, const fvMesh& mesh)
 123 :
 124     regionModel1D(mesh, "pyrolysis", modelType),
 125     filmCoupled_(false),
 126     filmDeltaPtr_(NULL),
 127     reactionDeltaMin_(0.0)
 128 {
 129     if (active_)
 130     {
 131         read();
 132         constructMeshObjects();
 133     }
 134 }
 135
 136
 137 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
 138
 139 pyrolysisModel::~pyrolysisModel()
 140 {}
 141
 142
 143 // * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * * //
 144
 145 scalar pyrolysisModel::addMassSources
 146 (
 147     const label patchI,
 148     const label faceI
 149 )
 150 {
 151     return 0.0;
 152 }
 153
 154
 155 void pyrolysisModel::preEvolveRegion()
 156 {
 157     if (filmCoupled_)
 158     {
 159         filmDeltaPtr_->correctBoundaryConditions();
 160     }
 161 }
 162
 163
 164 scalar pyrolysisModel::solidRegionDiffNo() const
 165 {
 166     return VSMALL;
 167 }
 168
 169
 170 scalar pyrolysisModel::maxDiff() const
 171 {
 172     return GREAT;
 173 }
 174
 175
 176 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 177
 178 } // End namespace surfaceFilmModels
 179 } // End namespace regionModels
 180 } // End namespace Foam
 181
 182 // ************************************************************************* //