applications/solvers/heatTransfer/chtMultiRegionFoam/derivedFvPatchFields/solidWallTemperatureCoupled/solidWallTemperatureCoupledFvPatchScalarField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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     solidWallHeatFluxCoupledFvPatchScalarField
  27
  28 Description
  29     Fixed value boundary condition for temperature, to be used by the
  30     conjugate heat transfer solver.
  31
  32     Example usage:
  33         myInterfacePatchName
  34         {
  35             type                solidWallTemperatureCoupled;
  36             neighbourRegionName fluid;
  37             neighbourPatchName  fluidSolidInterface;
  38             neighbourFieldName  T;
  39             K                   K;
  40             value               uniform 300;
  41         }
  42
  43 SourceFiles
  44     solidWallTemperatureCoupledFvPatchScalarField.C
  45
  46 \*---------------------------------------------------------------------------*/
  47
  48 #ifndef solidWallTemperatureCoupledFvPatchScalarField_H
  49 #define solidWallTemperatureCoupledFvPatchScalarField_H
  50
  51 #include "fvPatchFields.H"
  52 #include "fixedValueFvPatchFields.H"
  53 #include "coupleManager.H"
  54
  55 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  56
  57 namespace Foam
  58 {
  59
  60 /*---------------------------------------------------------------------------*\
  61         Class solidWallTemperatureCoupledFvPatchScalarField Declaration
  62 \*---------------------------------------------------------------------------*/
  63
  64 class solidWallTemperatureCoupledFvPatchScalarField
  65 :
  66     public fixedValueFvPatchScalarField
  67 {
  68     // Private data
  69
  70         //- Couple manager object
  71         coupleManager coupleManager_;
  72
  73         //- Name of thermal conductivity field
  74         word KName_;
  75
  76
  77 public:
  78
  79     //- Runtime type information
  80     TypeName("solidWallTemperatureCoupled");
  81
  82
  83     // Constructors
  84
  85         //- Construct from patch and internal field
  86         solidWallTemperatureCoupledFvPatchScalarField
  87         (
  88             const fvPatch&,
  89             const DimensionedField<scalar, volMesh>&
  90         );
  91
  92         //- Construct from patch, internal field and dictionary
  93         solidWallTemperatureCoupledFvPatchScalarField
  94         (
  95             const fvPatch&,
  96             const DimensionedField<scalar, volMesh>&,
  97             const dictionary&
  98         );
  99
 100         //- Construct by mapping given solidWallTemperatureCoupledFvPatchScalarField
 101         //  onto a new patch
 102         solidWallTemperatureCoupledFvPatchScalarField
 103         (
 104             const solidWallTemperatureCoupledFvPatchScalarField&,
 105             const fvPatch&,
 106             const DimensionedField<scalar, volMesh>&,
 107             const fvPatchFieldMapper&
 108         );
 109
 110         //- Construct and return a clone
 111         virtual tmp<fvPatchScalarField> clone() const
 112         {
 113             return tmp<fvPatchScalarField>
 114             (
 115                 new solidWallTemperatureCoupledFvPatchScalarField(*this)
 116             );
 117         }
 118
 119         //- Construct as copy setting internal field reference
 120         solidWallTemperatureCoupledFvPatchScalarField
 121         (
 122             const solidWallTemperatureCoupledFvPatchScalarField&,
 123             const DimensionedField<scalar, volMesh>&
 124         );
 125
 126         //- Construct and return a clone setting internal field reference
 127         virtual tmp<fvPatchScalarField> clone
 128         (
 129             const DimensionedField<scalar, volMesh>& iF
 130         ) const
 131         {
 132             return tmp<fvPatchScalarField>
 133             (
 134                 new solidWallTemperatureCoupledFvPatchScalarField(*this, iF)
 135             );
 136         }
 137
 138
 139     // Member functions
 140
 141         //- Flux
 142         tmp<scalarField> flux() const;
 143
 144         //- Update the coefficients associated with the patch field
 145         virtual void updateCoeffs();
 146
 147         //- Write
 148         virtual void write(Ostream&) const;
 149 };
 150
 151
 152 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 153
 154 } // End namespace Foam
 155
 156 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 157
 158 #endif
 159
 160 // ************************************************************************* //