OpenFOAM logo
Open Source CFD Toolkit

emptyPolyPatch.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     emptyPolyPatch
00027 
00028 Description
00029     Empty front and back plane patch.  Used for 2-D geometries.
00030 
00031 SourceFiles
00032     emptyPolyPatch.C
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef emptyPolyPatch_H
00037 #define emptyPolyPatch_H
00038 
00039 #include "polyPatch.H"
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 /*---------------------------------------------------------------------------*\
00047                       Class emptyPolyPatch Declaration
00048 \*---------------------------------------------------------------------------*/
00049 
00050 class emptyPolyPatch
00051 :
00052     public polyPatch
00053 {
00054 public:
00055 
00056     //- Runtime type information
00057     TypeName("empty");
00058 
00059 
00060     // Constructors
00061 
00062         //- Construct from components
00063         emptyPolyPatch
00064         (
00065             const word& name,
00066             const label size,
00067             const label start,
00068             const label index,
00069             const polyBoundaryMesh& bm
00070         );
00071 
00072         //- Construct from Istream
00073         emptyPolyPatch(Istream&, const label index, const polyBoundaryMesh&);
00074 
00075         //- Construct from dictionary
00076         emptyPolyPatch
00077         (
00078             const word& name,
00079             const dictionary& dict,
00080             const label index,
00081             const polyBoundaryMesh& bm
00082         );
00083 
00084         //- Construct as copy, resetting the boundary mesh
00085         emptyPolyPatch(const emptyPolyPatch&, const polyBoundaryMesh&);
00086 
00087         //- Construct given the original patch and resetting the
00088         //  face list and boundary mesh information
00089         emptyPolyPatch
00090         (
00091             const emptyPolyPatch& pp,
00092             const polyBoundaryMesh& bm,
00093             const label index,
00094             const label newSize,
00095             const label newStart
00096         );
00097 
00098         //- Construct and return a clone, resetting the boundary mesh
00099         virtual autoPtr<polyPatch> clone(const polyBoundaryMesh& bm) const
00100         {
00101             return autoPtr<polyPatch>(new emptyPolyPatch(*this, bm));
00102         }
00103 
00104         //- Construct and return a clone, resetting the face list
00105         //  and boundary mesh
00106         virtual autoPtr<polyPatch> clone
00107         (
00108             const polyBoundaryMesh& bm,
00109             const label index,
00110             const label newSize,
00111             const label newStart
00112         ) const
00113         {
00114             return autoPtr<polyPatch>
00115             (
00116                 new emptyPolyPatch(*this, bm, index, newSize, newStart)
00117             );
00118         }
00119 };
00120 
00121 
00122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00123 
00124 } // End namespace Foam
00125 
00126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00127 
00128 #endif
00129 
00130 // ************************************************************************* //
For further information go to www.openfoam.org