OpenFOAM logo
Open Source CFD Toolkit

mixedFvPatchField.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     mixedFvPatchField
00027 
00028 Description
00029 
00030 SourceFiles
00031     mixedFvPatchField.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef mixedFvPatchField_H
00036 #define mixedFvPatchField_H
00037 
00038 #include "fvPatchField.H"
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 /*---------------------------------------------------------------------------*\
00046                            Class mixedFvPatch Declaration
00047 \*---------------------------------------------------------------------------*/
00048 
00049 template<class Type>
00050 class mixedFvPatchField
00051 :
00052     public fvPatchField<Type>
00053 {
00054     // Private data
00055 
00056         //- Value field
00057         Field<Type> refValue_;
00058 
00059         //- Normal gradient field
00060         Field<Type> refGrad_;
00061 
00062         //- Fraction (0-1) of value used for boundary condition
00063         scalarField valueFraction_;
00064 
00065 
00066 public:
00067 
00068     //- Runtime type information
00069     TypeName("mixed");
00070 
00071 
00072     // Constructors
00073 
00074         //- Construct from patch and internal field
00075         mixedFvPatchField
00076         (
00077             const fvPatch&,
00078             const Field<Type>&
00079         );
00080 
00081         //- Construct from patch, internal field and dictionary
00082         mixedFvPatchField
00083         (
00084             const fvPatch&,
00085             const Field<Type>&,
00086             const dictionary&
00087         );
00088 
00089         //- Construct by mapping the given mixedFvPatchField onto a new patch
00090         mixedFvPatchField
00091         (
00092             const mixedFvPatchField<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> >(new mixedFvPatchField<Type>(*this));
00102         }
00103 
00104         //- Construct as copy setting internal field reference
00105         mixedFvPatchField
00106         (
00107             const mixedFvPatchField<Type>&,
00108             const Field<Type>&
00109         );
00110 
00111         //- Construct and return a clone setting internal field reference
00112         virtual tmp<fvPatchField<Type> > clone(const Field<Type>& iF) const
00113         {
00114             return tmp<fvPatchField<Type> >
00115             (
00116                 new mixedFvPatchField<Type>(*this, iF)
00117             );
00118         }
00119 
00120 
00121     // Member functions
00122 
00123         // Access
00124 
00125             //- Return true if this patch field fixes a value.
00126             //  Needed to check if a level has to be specified while solving
00127             //  Poissons equations.
00128             virtual bool fixesValue() const
00129             {
00130                 return true;
00131             }
00132 
00133 
00134         // Return defining fields
00135 
00136             virtual Field<Type>& refValue()
00137             {
00138                 return refValue_;
00139             }
00140 
00141             virtual const Field<Type>& refValue() const
00142             {
00143                 return refValue_;
00144             }
00145 
00146             virtual Field<Type>& refGrad()
00147             {
00148                 return refGrad_;
00149             }
00150 
00151             virtual const Field<Type>& refGrad() const
00152             {
00153                 return refGrad_;
00154             }
00155 
00156             virtual scalarField& valueFraction()
00157             {
00158                 return valueFraction_;
00159             }
00160 
00161             virtual const scalarField& valueFraction() const
00162             {
00163                 return valueFraction_;
00164             }
00165 
00166 
00167         // Mapping functions
00168 
00169             //- Map (and resize as needed) from self given a mapping object
00170             virtual void autoMap
00171             (
00172                 const fvPatchFieldMapper&
00173             );
00174 
00175             //- Reverse map the given fvPatchField onto this fvPatchField
00176             virtual void rmap
00177             (
00178                 const fvPatchField<Type>&,
00179                 const labelList&
00180             );
00181 
00182 
00183         // Evaluation functions
00184 
00185             //- Return gradient at boundary
00186             virtual tmp<Field<Type> > snGrad() const;
00187 
00188             //- Evaluate the patch field
00189             virtual void evaluate();
00190 
00191             //- Return the matrix diagonal coefficients corresponding to the
00192             //  evaluation of the value of this patchField with given weights
00193             virtual tmp<Field<Type> > valueInternalCoeffs
00194             (
00195                 const tmp<scalarField>&
00196             ) const;
00197 
00198             //- Return the matrix source coefficients corresponding to the
00199             //  evaluation of the value of this patchField with given weights
00200             virtual tmp<Field<Type> > valueBoundaryCoeffs
00201             (
00202                 const tmp<scalarField>&
00203             ) const;
00204 
00205             //- Return the matrix diagonal coefficients corresponding to the
00206             //  evaluation of the gradient of this patchField
00207             virtual tmp<Field<Type> > gradientInternalCoeffs() const;
00208 
00209             //- Return the matrix source coefficients corresponding to the
00210             //  evaluation of the gradient of this patchField
00211             virtual tmp<Field<Type> > gradientBoundaryCoeffs() const;
00212 
00213 
00214         //- Write
00215         virtual void write(Ostream&) const;
00216 
00217 
00218     // Member operators
00219 
00220         virtual void operator=(const UList<Type>&) {}
00221 
00222         virtual void operator=(const fvPatchField<Type>&) {}
00223         virtual void operator+=(const fvPatchField<Type>&) {}
00224         virtual void operator-=(const fvPatchField<Type>&) {}
00225         virtual void operator*=(const fvPatchField<scalar>&) {}
00226         virtual void operator/=(const fvPatchField<scalar>&) {}
00227 
00228         virtual void operator+=(const Field<Type>&) {}
00229         virtual void operator-=(const Field<Type>&) {}
00230 
00231         virtual void operator*=(const Field<scalar>&) {}
00232         virtual void operator/=(const Field<scalar>&) {}
00233 
00234         virtual void operator=(const Type&) {}
00235         virtual void operator+=(const Type&) {}
00236         virtual void operator-=(const Type&) {}
00237         virtual void operator*=(const scalar) {}
00238         virtual void operator/=(const scalar) {}
00239 };
00240 
00241 
00242 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00243 
00244 } // End namespace Foam
00245 
00246 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00247 
00248 #ifdef NoRepository
00249 #   include "mixedFvPatchField.C"
00250 #endif
00251 
00252 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00253 
00254 #endif
00255 
00256 // ************************************************************************* //
For further information go to www.openfoam.org