src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisVelocityCoupled/filmPyrolysisVelocityCoupledFvPatchVectorField.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::filmPyrolysisVelocityCoupledFvPatchVectorField
  26
  27 Description
  28     Velocity boundary condition for patches on the primary region:
  29
  30     - where the film height > height threshold value:
  31         apply film surface velocity values
  32     - else
  33         apply pyrolysis out-gassing velocity values
  34
  35 SourceFiles
  36     filmPyrolysisVelocityCoupledFvPatchVectorField.C
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef filmPyrolysisVelocityCoupledFvPatchVectorField_H
  41 #define filmPyrolysisVelocityCoupledFvPatchVectorField_H
  42
  43 #include "fixedValueFvPatchFields.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51        Class filmPyrolysisVelocityCoupledFvPatchVectorField Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class filmPyrolysisVelocityCoupledFvPatchVectorField
  55 :
  56     public fixedValueFvPatchVectorField
  57 {
  58     // Private data
  59
  60         //- Name of flux field
  61         word phiName_;
  62
  63         //- Name of density field
  64         word rhoName_;
  65
  66         //- Film height threshold beyond which it is considered 'wet'
  67         scalar deltaWet_;
  68
  69
  70 public:
  71
  72     //- Runtime type information
  73     TypeName("filmPyrolysisVelocityCoupled");
  74
  75
  76     // Constructors
  77
  78         //- Construct from patch and internal field
  79         filmPyrolysisVelocityCoupledFvPatchVectorField
  80         (
  81             const fvPatch&,
  82             const DimensionedField<vector, volMesh>&
  83         );
  84
  85         //- Construct from patch, internal field and dictionary
  86         filmPyrolysisVelocityCoupledFvPatchVectorField
  87         (
  88             const fvPatch&,
  89             const DimensionedField<vector, volMesh>&,
  90             const dictionary&
  91         );
  92
  93         //- Construct by mapping given
  94         //  filmPyrolysisVelocityCoupledFvPatchVectorField onto a new patch
  95         filmPyrolysisVelocityCoupledFvPatchVectorField
  96         (
  97             const filmPyrolysisVelocityCoupledFvPatchVectorField&,
  98             const fvPatch&,
  99             const DimensionedField<vector, volMesh>&,
 100             const fvPatchFieldMapper&
 101         );
 102
 103         //- Construct as copy
 104         filmPyrolysisVelocityCoupledFvPatchVectorField
 105         (
 106             const filmPyrolysisVelocityCoupledFvPatchVectorField&
 107         );
 108
 109         //- Construct and return a clone
 110         virtual tmp<fvPatchVectorField> clone() const
 111         {
 112             return tmp<fvPatchVectorField>
 113             (
 114                 new filmPyrolysisVelocityCoupledFvPatchVectorField(*this)
 115             );
 116         }
 117
 118         //- Construct as copy setting internal field reference
 119         filmPyrolysisVelocityCoupledFvPatchVectorField
 120         (
 121             const filmPyrolysisVelocityCoupledFvPatchVectorField&,
 122             const DimensionedField<vector, volMesh>&
 123         );
 124
 125         //- Construct and return a clone setting internal field reference
 126         virtual tmp<fvPatchVectorField> clone
 127         (
 128             const DimensionedField<vector, volMesh>& iF
 129         ) const
 130         {
 131             return tmp<fvPatchVectorField>
 132             (
 133                 new filmPyrolysisVelocityCoupledFvPatchVectorField(*this, iF)
 134             );
 135         }
 136
 137
 138     // Member functions
 139
 140         // Access
 141
 142             //- Return the name of phi
 143             const word& phiName() const
 144             {
 145                 return phiName_;
 146             }
 147
 148             //- Return reference to the name of phi to allow adjustment
 149             word& phiName()
 150             {
 151                 return phiName_;
 152             }
 153
 154             //- Return the name of rho
 155             const word& rhoName() const
 156             {
 157                 return rhoName_;
 158             }
 159
 160             //- Return reference to the name of rho to allow adjustment
 161             word& rhoName()
 162             {
 163                 return rhoName_;
 164             }
 165
 166
 167         //- Update the coefficients associated with the patch field
 168         virtual void updateCoeffs();
 169
 170         //- Write
 171         virtual void write(Ostream&) const;
 172 };
 173
 174
 175 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 176
 177 } // End namespace Foam
 178
 179 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 180
 181 #endif
 182
 183 // ************************************************************************* //