OpenFOAM logo
Open Source CFD Toolkit

wallHeatTransferFvPatchScalarField.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2005 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software; you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM; if not, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     wallHeatTransferFvPatchScalarField
00027 
00028 Description
00029 
00030 SourceFiles
00031     wallHeatTransferFvPatchScalarField.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef wallHeatTransferFvPatchScalarField_H
00036 #define wallHeatTransferFvPatchScalarField_H
00037 
00038 #include "mixedFvPatchFields.H"
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 /*---------------------------------------------------------------------------*\
00046                   Class wallHeatTransferFvPatch Declaration
00047 \*---------------------------------------------------------------------------*/
00048 
00049 class wallHeatTransferFvPatchScalarField
00050 :
00051     public mixedFvPatchScalarField
00052 {
00053     // Private data
00054 
00055         //- Tinf
00056         scalarField Tinf_;
00057 
00058         //- alphaWall
00059         scalarField alphaWall_;
00060 
00061 
00062 public:
00063 
00064     //- Runtime type information
00065     TypeName("wallHeatTransfer");
00066 
00067 
00068     // Constructors
00069 
00070         //- Construct from patch and internal field
00071         wallHeatTransferFvPatchScalarField
00072         (
00073             const fvPatch&,
00074             const scalarField&
00075         );
00076 
00077         //- Construct from patch, internal field and dictionary
00078         wallHeatTransferFvPatchScalarField
00079         (
00080             const fvPatch&,
00081             const scalarField&,
00082             const dictionary&
00083         );
00084 
00085         //- Construct by mapping given wallHeatTransferFvPatchScalarField
00086         // onto a new patch
00087         wallHeatTransferFvPatchScalarField
00088         (
00089             const wallHeatTransferFvPatchScalarField&,
00090             const fvPatch&,
00091             const scalarField&,
00092             const fvPatchFieldMapper&
00093         );
00094 
00095         //- Construct and return a clone
00096         virtual tmp<fvPatchScalarField> clone() const
00097         {
00098             return tmp<fvPatchScalarField>
00099             (
00100                 new wallHeatTransferFvPatchScalarField(*this)
00101             );
00102         }
00103 
00104         //- Construct as copy setting internal field reference
00105         wallHeatTransferFvPatchScalarField
00106         (
00107             const wallHeatTransferFvPatchScalarField&,
00108             const scalarField&
00109         );
00110 
00111         //- Construct and return a clone setting internal field reference
00112         virtual tmp<fvPatchScalarField> clone(const scalarField& iF) const
00113         {
00114             return tmp<fvPatchScalarField>
00115             (
00116                 new wallHeatTransferFvPatchScalarField(*this, iF)
00117             );
00118         }
00119 
00120 
00121     // Member functions
00122 
00123         // Access
00124 
00125             //- Return Tinf
00126             const scalarField& Tinf() const
00127             {
00128                 return Tinf_;
00129             }
00130 
00131             //- Return reference to Tinf to allow adjustment
00132             scalarField& Tinf()
00133             {
00134                 return Tinf_;
00135             }
00136 
00137             //- Return alphaWall
00138             const scalarField& alphaWall() const
00139             {
00140                 return alphaWall_;
00141             }
00142 
00143             //- Return reference to alphaWall to allow adjustment
00144             scalarField& alphaWall()
00145             {
00146                 return alphaWall_;
00147             }
00148 
00149 
00150         // Mapping functions
00151 
00152             //- Map (and resize as needed) from self given a mapping object
00153             virtual void autoMap
00154             (
00155                 const fvPatchFieldMapper&
00156             );
00157 
00158             //- Reverse map the given fvPatchField onto this fvPatchField
00159             virtual void rmap
00160             (
00161                 const fvPatchScalarField&,
00162                 const labelList&
00163             );
00164 
00165 
00166         // Evaluation functions
00167 
00168             //- Update the coefficients associated with the patch field
00169             virtual void updateCoeffs();
00170 
00171 
00172         //- Write
00173         virtual void write(Ostream&) const;
00174 };
00175 
00176 
00177 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00178 
00179 } // End namespace Foam
00180 
00181 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00182 
00183 #endif
00184 
00185 // ************************************************************************* //
For further information go to www.openfoam.org