OpenFOAM logo
Open Source CFD Toolkit

inletOutletFvPatchField.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     inletOutletFvPatchField
00027 
00028 Description
00029 
00030 SourceFiles
00031     inletOutletFvPatchField.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef inletOutletFvPatchField_H
00036 #define inletOutletFvPatchField_H
00037 
00038 #include "mixedFvPatchField.H"
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 /*---------------------------------------------------------------------------*\
00046                      Class inletOutletFvPatch Declaration
00047 \*---------------------------------------------------------------------------*/
00048 
00049 template<class Type>
00050 class inletOutletFvPatchField
00051 :
00052     public mixedFvPatchField<Type>
00053 {
00054 
00055 protected:
00056 
00057     // Protected data
00058 
00059         word phiName_;
00060 
00061 
00062 public:
00063 
00064     //- Runtime type information
00065     TypeName("inletOutlet");
00066 
00067 
00068     // Constructors
00069 
00070         //- Construct from patch and internal field
00071         inletOutletFvPatchField
00072         (
00073             const fvPatch&,
00074             const Field<Type>&
00075         );
00076 
00077         //- Construct from patch, internal field and dictionary
00078         inletOutletFvPatchField
00079         (
00080             const fvPatch&,
00081             const Field<Type>&,
00082             const dictionary&
00083         );
00084 
00085         //- Construct by mapping given inletOutletFvPatchField onto a new patch
00086         inletOutletFvPatchField
00087         (
00088             const inletOutletFvPatchField<Type>&,
00089             const fvPatch&,
00090             const Field<Type>&,
00091             const fvPatchFieldMapper&
00092         );
00093 
00094         //- Construct and return a clone
00095         virtual tmp<fvPatchField<Type> > clone() const
00096         {
00097             return tmp<fvPatchField<Type> >
00098             (
00099                 new inletOutletFvPatchField<Type>(*this)
00100             );
00101         }
00102 
00103         //- Construct as copy setting internal field reference
00104         inletOutletFvPatchField
00105         (
00106             const inletOutletFvPatchField<Type>&,
00107             const Field<Type>&
00108         );
00109 
00110         //- Construct and return a clone setting internal field reference
00111         virtual tmp<fvPatchField<Type> > clone(const Field<Type>& iF) const
00112         {
00113             return tmp<fvPatchField<Type> >
00114             (
00115                 new inletOutletFvPatchField<Type>(*this, iF)
00116             );
00117         }
00118 
00119 
00120     // Member functions
00121 
00122         //- Update the coefficients associated with the patch field
00123         virtual void updateCoeffs();
00124 
00125         //- Write
00126         virtual void write(Ostream&) const;
00127 };
00128 
00129 
00130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00131 
00132 } // End namespace Foam
00133 
00134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00135 
00136 #ifdef NoRepository
00137 #   include "inletOutletFvPatchField.C"
00138 #endif
00139 
00140 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00141 
00142 #endif
00143 
00144 // ************************************************************************* //
For further information go to www.openfoam.org