OpenFOAM logo
Open Source CFD Toolkit

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