OpenFOAM logo
Open Source CFD Toolkit

uniformFixedValueFvPatchField.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     uniformFixedValueFvPatchField
00027 
00028 Description
00029 
00030 SourceFiles
00031     uniformFixedValueFvPatchField.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef uniformFixedValueFvPatchField_H
00036 #define uniformFixedValueFvPatchField_H
00037 
00038 #include "Random.H"
00039 #include "fixedValueFvPatchFields.H"
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 /*---------------------------------------------------------------------------*\
00047                      Class uniformFixedValueFvPatch Declaration
00048 \*---------------------------------------------------------------------------*/
00049 
00050 template<class Type>
00051 class uniformFixedValueFvPatchField
00052 :
00053     public fixedValueFvPatchField<Type>
00054 {
00055     // Private data
00056 
00057         Type uniformValue_;
00058 
00059 
00060 public:
00061 
00062     //- Runtime type information
00063     TypeName("uniformFixedValue");
00064 
00065 
00066     // Constructors
00067 
00068         //- Construct from patch and internal field
00069         uniformFixedValueFvPatchField
00070         (
00071             const fvPatch&,
00072             const Field<Type>&
00073         );
00074 
00075         //- Construct from patch, internal field and dictionary
00076         uniformFixedValueFvPatchField
00077         (
00078             const fvPatch&,
00079             const Field<Type>&,
00080             const dictionary&
00081         );
00082 
00083         //- Construct by mapping given uniformFixedValueFvPatchField
00084         //  onto a new patch
00085         uniformFixedValueFvPatchField
00086         (
00087             const uniformFixedValueFvPatchField<Type>&,
00088             const fvPatch&,
00089             const Field<Type>&,
00090             const fvPatchFieldMapper&
00091         );
00092 
00093         //- Construct and return a clone
00094         virtual tmp<fvPatchField<Type> > clone() const
00095         {
00096             return tmp<fvPatchField<Type> >
00097             (
00098                 new uniformFixedValueFvPatchField<Type>(*this)
00099             );
00100         }
00101 
00102         //- Construct as copy setting internal field reference
00103         uniformFixedValueFvPatchField
00104         (
00105             const uniformFixedValueFvPatchField<Type>&,
00106             const Field<Type>&
00107         );
00108 
00109         //- Construct and return a clone setting internal field reference
00110         virtual tmp<fvPatchField<Type> > clone(const Field<Type>& iF) const
00111         {
00112             return tmp<fvPatchField<Type> >
00113             (
00114                 new uniformFixedValueFvPatchField<Type>(*this, iF)
00115             );
00116         }
00117 
00118 
00119     // Member functions
00120 
00121         // Access
00122 
00123             //- Return the fluctuation scale
00124             const Type& uniformValue() const
00125             {
00126                 return uniformValue_;
00127             }
00128 
00129             //- Return reference to the fluctuation scale to allow adjustment
00130             Type& uniformValue()
00131             {
00132                 return uniformValue_;
00133             }
00134 
00135 
00136         // Mapping functions
00137 
00138             //- Map (and resize as needed) from self given a mapping object
00139             virtual void autoMap
00140             (
00141                 const fvPatchFieldMapper&
00142             );
00143 
00144 
00145         //- Write
00146         virtual void write(Ostream&) const;
00147 };
00148 
00149 
00150 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00151 
00152 } // End namespace Foam
00153 
00154 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00155 
00156 #ifdef NoRepository
00157 #   include "uniformFixedValueFvPatchField.C"
00158 #endif
00159 
00160 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00161 
00162 #endif
00163 
00164 // ************************************************************************* //
For further information go to www.openfoam.org