OpenFOAM logo
Open Source CFD Toolkit

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