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

cyclicFvsPatchField.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::cyclicFvsPatchField
00026 
00027 Description
00028     Foam::cyclicFvsPatchField
00029 
00030 SourceFiles
00031     cyclicFvsPatchField.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef cyclicFvsPatchField_H
00036 #define cyclicFvsPatchField_H
00037 
00038 #include <finiteVolume/coupledFvsPatchField.H>
00039 #include <finiteVolume/cyclicFvPatch.H>
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 /*---------------------------------------------------------------------------*\
00047                            Class cyclicFvsPatch Declaration
00048 \*---------------------------------------------------------------------------*/
00049 
00050 template<class Type>
00051 class cyclicFvsPatchField
00052 :
00053     public coupledFvsPatchField<Type>
00054 {
00055     // Private data
00056 
00057         //- Local reference cast into the cyclic patch
00058         const cyclicFvPatch& cyclicPatch_;
00059 
00060 
00061 public:
00062 
00063     //- Runtime type information
00064     TypeName(cyclicFvPatch::typeName_());
00065 
00066 
00067     // Constructors
00068 
00069         //- Construct from patch and internal field
00070         cyclicFvsPatchField
00071         (
00072             const fvPatch&,
00073             const DimensionedField<Type, surfaceMesh>&
00074         );
00075 
00076         //- Construct from patch, internal field and dictionary
00077         cyclicFvsPatchField
00078         (
00079             const fvPatch&,
00080             const DimensionedField<Type, surfaceMesh>&,
00081             const dictionary&
00082         );
00083 
00084         //- Construct by mapping given cyclicFvsPatchField onto a new patch
00085         cyclicFvsPatchField
00086         (
00087             const cyclicFvsPatchField<Type>&,
00088             const fvPatch&,
00089             const DimensionedField<Type, surfaceMesh>&,
00090             const fvPatchFieldMapper&
00091         );
00092 
00093         //- Construct as copy
00094         cyclicFvsPatchField
00095         (
00096             const cyclicFvsPatchField<Type>&
00097         );
00098 
00099         //- Construct and return a clone
00100         virtual tmp<fvsPatchField<Type> > clone() const
00101         {
00102             return tmp<fvsPatchField<Type> >
00103             (
00104                 new cyclicFvsPatchField<Type>(*this)
00105             );
00106         }
00107 
00108         //- Construct as copy setting internal field reference
00109         cyclicFvsPatchField
00110         (
00111             const cyclicFvsPatchField<Type>&,
00112             const DimensionedField<Type, surfaceMesh>&
00113         );
00114 
00115         //- Construct and return a clone setting internal field reference
00116         virtual tmp<fvsPatchField<Type> > clone
00117         (
00118             const DimensionedField<Type, surfaceMesh>& iF
00119         ) const
00120         {
00121             return tmp<fvsPatchField<Type> >
00122             (
00123                 new cyclicFvsPatchField<Type>(*this, iF)
00124             );
00125         }
00126 };
00127 
00128 
00129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00130 
00131 } // End namespace Foam
00132 
00133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00134 
00135 #ifdef NoRepository
00136 #   include <finiteVolume/cyclicFvsPatchField.C>
00137 #endif
00138 
00139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00140 
00141 #endif
00142 
00143 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines