applications/solvers/heatTransfer/chtMultiRegionFoam/derivedFvPatchFields/solidWallHeatFluxTemperature/solidWallHeatFluxTemperatureFvPatchScalarField.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     solidWallHeatFluxTemperatureFvPatchScalarField
  27
  28 Description
  29     Heat flux boundary condition for temperature on solid region
  30
  31     Example usage:
  32         myWallPatch
  33         {
  34             type            solidWallHeatFluxTemperature;
  35             K               K;                 // Name of K field
  36             q               uniform 1000;      // Heat flux / [W/m2]
  37             value           300.0;             // Initial temperature / [K]
  38         }
  39
  40
  41 SourceFiles
  42     solidWallHeatFluxTemperatureFvPatchScalarField.C
  43
  44 \*---------------------------------------------------------------------------*/
  45
  46 #ifndef solidWallHeatFluxTemperatureFvPatchScalarField_H
  47 #define solidWallHeatFluxTemperatureFvPatchScalarField_H
  48
  49 #include "fixedValueFvPatchFields.H"
  50
  51 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  52
  53 namespace Foam
  54 {
  55
  56 /*---------------------------------------------------------------------------*\
  57       Class solidWallHeatFluxTemperatureFvPatchScalarField Declaration
  58 \*---------------------------------------------------------------------------*/
  59
  60 class solidWallHeatFluxTemperatureFvPatchScalarField
  61 :
  62     public fixedValueFvPatchScalarField
  63 {
  64     // Private data
  65
  66         //- Heat flux / [W/m2]
  67         scalarField q_;
  68
  69         //- Name of thermal conductivity field
  70         word KName_;
  71
  72
  73 public:
  74
  75     //- Runtime type information
  76     TypeName("solidWallHeatFluxTemperature");
  77
  78
  79     // Constructors
  80
  81         //- Construct from patch and internal field
  82         solidWallHeatFluxTemperatureFvPatchScalarField
  83         (
  84             const fvPatch&,
  85             const DimensionedField<scalar, volMesh>&
  86         );
  87
  88         //- Construct from patch, internal field and dictionary
  89         solidWallHeatFluxTemperatureFvPatchScalarField
  90         (
  91             const fvPatch&,
  92             const DimensionedField<scalar, volMesh>&,
  93             const dictionary&
  94         );
  95
  96         //- Construct by mapping given
  97         // solidWallHeatFluxTemperatureFvPatchScalarField
  98         // onto a new patch
  99         solidWallHeatFluxTemperatureFvPatchScalarField
 100         (
 101             const solidWallHeatFluxTemperatureFvPatchScalarField&,
 102             const fvPatch&,
 103             const DimensionedField<scalar, volMesh>&,
 104             const fvPatchFieldMapper&
 105         );
 106
 107         //- Construct as copy
 108         solidWallHeatFluxTemperatureFvPatchScalarField
 109         (
 110             const solidWallHeatFluxTemperatureFvPatchScalarField&
 111         );
 112
 113         //- Construct and return a clone
 114         virtual tmp<fvPatchScalarField> clone() const
 115         {
 116             return tmp<fvPatchScalarField>
 117             (
 118                 new solidWallHeatFluxTemperatureFvPatchScalarField(*this)
 119             );
 120         }
 121
 122         //- Construct as copy setting internal field reference
 123         solidWallHeatFluxTemperatureFvPatchScalarField
 124         (
 125             const solidWallHeatFluxTemperatureFvPatchScalarField&,
 126             const DimensionedField<scalar, volMesh>&
 127         );
 128
 129         //- Construct and return a clone setting internal field reference
 130         virtual tmp<fvPatchScalarField> clone
 131         (
 132             const DimensionedField<scalar, volMesh>& iF
 133         ) const
 134         {
 135             return tmp<fvPatchScalarField>
 136             (
 137                 new solidWallHeatFluxTemperatureFvPatchScalarField(*this, iF)
 138             );
 139         }
 140
 141
 142     // Member functions
 143
 144         // Evaluation functions
 145
 146             //- Update the coefficients associated with the patch field
 147             virtual void updateCoeffs();
 148
 149
 150         // Mapping functions
 151
 152             //- Map (and resize as needed) from self given a mapping object
 153             virtual void autoMap
 154             (
 155                 const fvPatchFieldMapper&
 156             );
 157
 158             //- Reverse map the given fvPatchField onto this fvPatchField
 159             virtual void rmap
 160             (
 161                 const fvPatchScalarField&,
 162                 const labelList&
 163             );
 164
 165
 166         // I-O
 167
 168             //- Write
 169             void write(Ostream&) const;
 170 };
 171
 172
 173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 174
 175 } // End namespace Foam
 176
 177 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 178
 179 #endif
 180
 181 // ************************************************************************* //