OpenFOAM logo
Open Source CFD Toolkit

wedgeFvPatchField.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     wedgeFvPatchField
00027 
00028 Description
00029 
00030 SourceFiles
00031     wedgeFvPatchField.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef wedgeFvPatchField_H
00036 #define wedgeFvPatchField_H
00037 
00038 #include "transformFvPatchField.H"
00039 #include "wedgeFvPatch.H"
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 /*---------------------------------------------------------------------------*\
00047                          Class wedgeFvPatch Declaration
00048 \*---------------------------------------------------------------------------*/
00049 
00050 template<class Type>
00051 class wedgeFvPatchField
00052 :
00053     public transformFvPatchField<Type>
00054 {
00055 
00056 public:
00057 
00058     //- Runtime type information
00059     TypeName(wedgeFvPatch::typeName_());
00060 
00061 
00062     // Constructors
00063 
00064         //- Construct from patch and internal field
00065         wedgeFvPatchField
00066         (
00067             const fvPatch&,
00068             const Field<Type>&
00069         );
00070 
00071         //- Construct from patch, internal field and dictionary
00072         wedgeFvPatchField
00073         (
00074             const fvPatch&,
00075             const Field<Type>&,
00076             const dictionary&
00077         );
00078 
00079         //- Construct by mapping given wedgeFvPatchField onto a new patch
00080         wedgeFvPatchField
00081         (
00082             const wedgeFvPatchField<Type>&,
00083             const fvPatch&,
00084             const Field<Type>&,
00085             const fvPatchFieldMapper&
00086         );
00087 
00088         //- Construct and return a clone
00089         virtual tmp<fvPatchField<Type> > clone() const
00090         {
00091             return tmp<fvPatchField<Type> >
00092             (
00093                 new wedgeFvPatchField<Type>(*this)
00094             );
00095         }
00096 
00097         //- Construct as copy setting internal field reference
00098         wedgeFvPatchField
00099         (
00100             const wedgeFvPatchField<Type>&,
00101             const Field<Type>&
00102         );
00103 
00104         //- Construct and return a clone setting internal field reference
00105         virtual tmp<fvPatchField<Type> > clone(const Field<Type>& iF) const
00106         {
00107             return tmp<fvPatchField<Type> >
00108             (
00109                 new wedgeFvPatchField<Type>(*this, iF)
00110             );
00111         }
00112 
00113 
00114     // Member functions
00115 
00116         // Evaluation functions
00117 
00118             //- Return gradient at boundary
00119             virtual tmp<Field<Type> > snGrad() const;
00120 
00121             //- Evaluate the patch field
00122             virtual void evaluate();
00123 
00124             //- Return face-gradient transform diagonal
00125             virtual tmp<Field<Type> > snGradTransformDiag() const;
00126 };
00127 
00128 
00129 // * * * * * * * * * * * Template Specialisations  * * * * * * * * * * * * * //
00130 
00131 template<>
00132 tmp<scalarField > wedgeFvPatchField<scalar>::snGrad() const;
00133 
00134 template<>
00135 void wedgeFvPatchField<scalar>::evaluate();
00136 
00137 
00138 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00139 
00140 } // End namespace Foam
00141 
00142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00143 
00144 #ifdef NoRepository
00145 #   include "wedgeFvPatchField.C"
00146 #endif
00147 
00148 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00149 
00150 #endif
00151 
00152 // ************************************************************************* //
For further information go to www.openfoam.org