FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

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-2010 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
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your 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, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::inletOutletFvPatchField
00026 
00027 Description
00028     Foam::inletOutletFvPatchField
00029 
00030 SourceFiles
00031     inletOutletFvPatchField.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef inletOutletFvPatchField_H
00036 #define inletOutletFvPatchField_H
00037 
00038 #include <finiteVolume/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 DimensionedField<Type, volMesh>&
00075         );
00076 
00077         //- Construct from patch, internal field and dictionary
00078         inletOutletFvPatchField
00079         (
00080             const fvPatch&,
00081             const DimensionedField<Type, volMesh>&,
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 DimensionedField<Type, volMesh>&,
00091             const fvPatchFieldMapper&
00092         );
00093 
00094         //- Construct as copy
00095         inletOutletFvPatchField
00096         (
00097             const inletOutletFvPatchField<Type>&
00098         );
00099 
00100         //- Construct and return a clone
00101         virtual tmp<fvPatchField<Type> > clone() const
00102         {
00103             return tmp<fvPatchField<Type> >
00104             (
00105                 new inletOutletFvPatchField<Type>(*this)
00106             );
00107         }
00108 
00109         //- Construct as copy setting internal field reference
00110         inletOutletFvPatchField
00111         (
00112             const inletOutletFvPatchField<Type>&,
00113             const DimensionedField<Type, volMesh>&
00114         );
00115 
00116         //- Construct and return a clone setting internal field reference
00117         virtual tmp<fvPatchField<Type> > clone
00118         (
00119             const DimensionedField<Type, volMesh>& iF
00120         ) const
00121         {
00122             return tmp<fvPatchField<Type> >
00123             (
00124                 new inletOutletFvPatchField<Type>(*this, iF)
00125             );
00126         }
00127 
00128 
00129     // Member functions
00130 
00131         //- Update the coefficients associated with the patch field
00132         virtual void updateCoeffs();
00133 
00134         //- Write
00135         virtual void write(Ostream&) const;
00136 
00137 
00138     // Member operators
00139 
00140         virtual void operator=(const fvPatchField<Type>& pvf);
00141 };
00142 
00143 
00144 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00145 
00146 } // End namespace Foam
00147 
00148 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00149 
00150 #ifdef NoRepository
00151 #   include <finiteVolume/inletOutletFvPatchField.C>
00152 #endif
00153 
00154 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00155 
00156 #endif
00157 
00158 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines