OpenFOAM logo
Open Source CFD Toolkit

fixedValueFaPatchField.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     fixedValueFaPatchField
00027 
00028 Description
00029 
00030 SourceFiles
00031     fixedValueFaPatchField.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef fixedValueFaPatchField_H
00036 #define fixedValueFaPatchField_H
00037 
00038 #include "faPatchField.H"
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 /*---------------------------------------------------------------------------*\
00046                            Class fixedValueFaPatch Declaration
00047 \*---------------------------------------------------------------------------*/
00048 
00049 template<class Type>
00050 class fixedValueFaPatchField
00051 :
00052     public faPatchField<Type>
00053 {
00054 
00055 public:
00056 
00057     //- Runtime type information
00058     TypeName("fixedValue");
00059 
00060 
00061     // Constructors
00062 
00063         //- Construct from patch and internal field
00064         fixedValueFaPatchField
00065         (
00066             const faPatch&,
00067             const Field<Type>&
00068         );
00069 
00070         //- Construct from patch, internal field and dictionary
00071         fixedValueFaPatchField
00072         (
00073             const faPatch&,
00074             const Field<Type>&,
00075             const dictionary&
00076         );
00077 
00078         //- Construct by mapping the given fixedValueFaPatchField<Type>
00079         //  onto a new patch
00080         fixedValueFaPatchField
00081         (
00082             const fixedValueFaPatchField<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 fixedValueFaPatchField<Type>(*this)
00094             );
00095         }
00096 
00097         //- Construct as copy setting internal field reference
00098         fixedValueFaPatchField
00099         (
00100             const fixedValueFaPatchField<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 fixedValueFaPatchField<Type>(*this, iF)
00110             );
00111         }
00112 
00113 
00114     // Member functions
00115 
00116         // Access
00117 
00118             //- Return true if this patch field fixes a value.
00119             //  Needed to check if a level has to be specified while solving
00120             //  Poissons equations.
00121             virtual bool fixesValue() const
00122             {
00123                 return true;
00124             }
00125 
00126 
00127         // Evaluation functions
00128 
00129             //- Return the matrix diagonal coefficients corresponding to the
00130             //  evaluation of the value of this patchField with given weights
00131             virtual tmp<Field<Type> > valueInternalCoeffs
00132             (
00133                 const tmp<scalarField>&
00134             ) const;
00135 
00136             //- Return the matrix source coefficients corresponding to the
00137             //  evaluation of the value of this patchField with given weights
00138             virtual tmp<Field<Type> > valueBoundaryCoeffs
00139             (
00140                 const tmp<scalarField>&
00141             ) const;
00142 
00143             //- Return the matrix diagonal coefficients corresponding to the
00144             //  evaluation of the gradient of this patchField
00145             virtual tmp<Field<Type> > gradientInternalCoeffs() const;
00146 
00147             //- Return the matrix source coefficients corresponding to the
00148             //  evaluation of the gradient of this patchField
00149             virtual tmp<Field<Type> > gradientBoundaryCoeffs() const;
00150 
00151 
00152         //- Write
00153         virtual void write(Ostream&) const;
00154 
00155 
00156     // Member operators
00157 
00158         virtual void operator=(const UList<Type>&) {}
00159 
00160         virtual void operator=(const faPatchField<Type>&) {}
00161         virtual void operator+=(const faPatchField<Type>&) {}
00162         virtual void operator-=(const faPatchField<Type>&) {}
00163         virtual void operator*=(const faPatchField<scalar>&) {}
00164         virtual void operator/=(const faPatchField<scalar>&) {}
00165 
00166         virtual void operator+=(const Field<Type>&) {}
00167         virtual void operator-=(const Field<Type>&) {}
00168 
00169         virtual void operator*=(const Field<scalar>&) {}
00170         virtual void operator/=(const Field<scalar>&) {}
00171 
00172         virtual void operator=(const Type&) {}
00173         virtual void operator+=(const Type&) {}
00174         virtual void operator-=(const Type&) {}
00175         virtual void operator*=(const scalar) {}
00176         virtual void operator/=(const scalar) {}
00177 };
00178 
00179 
00180 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00181 
00182 } // End namespace Foam
00183 
00184 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00185 
00186 #ifdef NoRepository
00187 #   include "fixedValueFaPatchField.C"
00188 #endif
00189 
00190 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00191 
00192 #endif
00193 
00194 // ************************************************************************* //
For further information go to www.openfoam.org