FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

fixedGradientFvPatchField.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-2010 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
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your 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, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::fixedGradientFvPatchField
00026 
00027 Description
00028     Foam::fixedGradientFvPatchField
00029 
00030 SourceFiles
00031     fixedGradientFvPatchField.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef fixedGradientFvPatchField_H
00036 #define fixedGradientFvPatchField_H
00037 
00038 #include <finiteVolume/fvPatchField.H>
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 /*---------------------------------------------------------------------------*\
00046                            Class fixedGradientFvPatch Declaration
00047 \*---------------------------------------------------------------------------*/
00048 
00049 template<class Type>
00050 class fixedGradientFvPatchField
00051 :
00052     public fvPatchField<Type>
00053 {
00054     // Private data
00055 
00056         Field<Type> gradient_;
00057 
00058 
00059 public:
00060 
00061     //- Runtime type information
00062     TypeName("fixedGradient");
00063 
00064 
00065     // Constructors
00066 
00067         //- Construct from patch and internal field
00068         fixedGradientFvPatchField
00069         (
00070             const fvPatch&,
00071             const DimensionedField<Type, volMesh>&
00072         );
00073 
00074         //- Construct from patch, internal field and dictionary
00075         fixedGradientFvPatchField
00076         (
00077             const fvPatch&,
00078             const DimensionedField<Type, volMesh>&,
00079             const dictionary&
00080         );
00081 
00082         //- Construct by mapping the given fixedGradientFvPatchField
00083         //  onto a new patch
00084         fixedGradientFvPatchField
00085         (
00086             const fixedGradientFvPatchField<Type>&,
00087             const fvPatch&,
00088             const DimensionedField<Type, volMesh>&,
00089             const fvPatchFieldMapper&
00090         );
00091 
00092         //- Construct as copy
00093         fixedGradientFvPatchField
00094         (
00095             const fixedGradientFvPatchField<Type>&
00096         );
00097 
00098         //- Construct and return a clone
00099         virtual tmp<fvPatchField<Type> > clone() const
00100         {
00101             return tmp<fvPatchField<Type> >
00102             (
00103                 new fixedGradientFvPatchField<Type>(*this)
00104             );
00105         }
00106 
00107         //- Construct as copy setting internal field reference
00108         fixedGradientFvPatchField
00109         (
00110             const fixedGradientFvPatchField<Type>&,
00111             const DimensionedField<Type, volMesh>&
00112         );
00113 
00114         //- Construct and return a clone setting internal field reference
00115         virtual tmp<fvPatchField<Type> > clone
00116         (
00117             const DimensionedField<Type, volMesh>& iF
00118         ) const
00119         {
00120             return tmp<fvPatchField<Type> >
00121             (
00122                 new fixedGradientFvPatchField<Type>(*this, iF)
00123             );
00124         }
00125 
00126 
00127     // Member functions
00128 
00129         // Return defining fields
00130 
00131             //- Return gradient at boundary
00132             virtual Field<Type>& gradient()
00133             {
00134                 return gradient_;
00135             }
00136 
00137             virtual const Field<Type>& gradient() const
00138             {
00139                 return gradient_;
00140             }
00141 
00142 
00143         // Mapping functions
00144 
00145             //- Map (and resize as needed) from self given a mapping object
00146             virtual void autoMap
00147             (
00148                 const fvPatchFieldMapper&
00149             );
00150 
00151             //- Reverse map the given fvPatchField onto this fvPatchField
00152             virtual void rmap
00153             (
00154                 const fvPatchField<Type>&,
00155                 const labelList&
00156             );
00157 
00158 
00159         // Evaluation functions
00160 
00161             //- Return gradient at boundary
00162             virtual tmp<Field<Type> > snGrad() const
00163             {
00164                 return gradient_;
00165             }
00166 
00167             //- Evaluate the patch field
00168             virtual void evaluate
00169             (
00170                 const Pstream::commsTypes commsType=Pstream::blocking
00171             );
00172 
00173             //- Return the matrix diagonal coefficients corresponding to the
00174             //  evaluation of the value of this patchField with given weights
00175             virtual tmp<Field<Type> > valueInternalCoeffs
00176             (
00177                 const tmp<scalarField>&
00178             ) const;
00179 
00180             //- Return the matrix source coefficients corresponding to the
00181             //  evaluation of the value of this patchField with given weights
00182             virtual tmp<Field<Type> > valueBoundaryCoeffs
00183             (
00184                 const tmp<scalarField>&
00185             ) const;
00186 
00187             //- Return the matrix diagonal coefficients corresponding to the
00188             //  evaluation of the gradient of this patchField
00189             virtual tmp<Field<Type> > gradientInternalCoeffs() const;
00190 
00191             //- Return the matrix source coefficients corresponding to the
00192             //  evaluation of the gradient of this patchField
00193             virtual tmp<Field<Type> > gradientBoundaryCoeffs() const;
00194 
00195 
00196         //- Write
00197         virtual void write(Ostream&) const;
00198 };
00199 
00200 
00201 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00202 
00203 } // End namespace Foam
00204 
00205 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00206 
00207 #ifdef NoRepository
00208 #   include <finiteVolume/fixedGradientFvPatchField.C>
00209 #endif
00210 
00211 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00212 
00213 #endif
00214 
00215 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines