OpenFOAM logo
Open Source CFD Toolkit

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