OpenFOAM logo
Open Source CFD Toolkit

zeroGradientFaPatchField.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     zeroGradientFaPatchField
00027 
00028 Description
00029 
00030 SourceFiles
00031     zeroGradientFaPatchField.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef zeroGradientFaPatchField_H
00036 #define zeroGradientFaPatchField_H
00037 
00038 #include "faPatchField.H"
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 /*---------------------------------------------------------------------------*\
00046                       Class zeroGradientFaPatch Declaration
00047 \*---------------------------------------------------------------------------*/
00048 
00049 template<class Type>
00050 class zeroGradientFaPatchField
00051 :
00052     public faPatchField<Type>
00053 {
00054 
00055 public:
00056 
00057     //- Runtime type information
00058     TypeName("zeroGradient");
00059 
00060 
00061     // Constructors
00062 
00063         //- Construct from patch and internal field
00064         zeroGradientFaPatchField
00065         (
00066             const faPatch&,
00067             const Field<Type>&
00068         );
00069 
00070         //- Construct from patch, internal field and dictionary
00071         zeroGradientFaPatchField
00072         (
00073             const faPatch&,
00074             const Field<Type>&,
00075             const dictionary&
00076         );
00077 
00078         //- Construct by mapping the given zeroGradientFaPatchField<Type>
00079         //  onto a new patch
00080         zeroGradientFaPatchField
00081         (
00082             const zeroGradientFaPatchField<Type>&,
00083             const faPatch&,
00084             const Field<Type>&,
00085             const faPatchFieldMapper&
00086         );
00087 
00088         //- Construct and return a clone
00089         virtual tmp<faPatchField<Type> > clone() const
00090         {
00091             return tmp<faPatchField<Type> >
00092             (
00093                 new zeroGradientFaPatchField<Type>(*this)
00094             );
00095         }
00096 
00097         //- Construct as copy setting internal field reference
00098         zeroGradientFaPatchField
00099         (
00100             const zeroGradientFaPatchField<Type>&,
00101             const Field<Type>&
00102         );
00103 
00104         //- Construct and return a clone setting internal field reference
00105         virtual tmp<faPatchField<Type> > clone(const Field<Type>& iF) const
00106         {
00107             return tmp<faPatchField<Type> >
00108             (
00109                 new zeroGradientFaPatchField<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                 return tmp<Field<Type> >
00122                 (
00123                     new Field<Type>(this->size(), pTraits<Type>::zero)
00124                 );
00125             }
00126 
00127             //- Evaluate the patch field
00128             virtual void evaluate();
00129 
00130             //- Return the matrix diagonal coefficients corresponding to the
00131             //  evaluation of the value of this patchField with given weights
00132             virtual tmp<Field<Type> > valueInternalCoeffs
00133             (
00134                 const tmp<scalarField>&
00135             ) const;
00136 
00137             //- Return the matrix source coefficients corresponding to the
00138             //  evaluation of the value of this patchField with given weights
00139             virtual tmp<Field<Type> > valueBoundaryCoeffs
00140             (
00141                 const tmp<scalarField>&
00142             ) const;
00143 
00144             //- Return the matrix diagonal coefficients corresponding to the
00145             //  evaluation of the gradient of this patchField
00146             virtual tmp<Field<Type> > gradientInternalCoeffs() const;
00147 
00148             //- Return the matrix source coefficients corresponding to the
00149             //  evaluation of the gradient of this patchField
00150             virtual tmp<Field<Type> > gradientBoundaryCoeffs() const;
00151 };
00152 
00153 
00154 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00155 
00156 } // End namespace Foam
00157 
00158 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00159 
00160 #ifdef NoRepository
00161 #   include "zeroGradientFaPatchField.C"
00162 #endif
00163 
00164 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00165 
00166 #endif
00167 
00168 // ************************************************************************* //
For further information go to www.openfoam.org