OpenFOAM logo
Open Source CFD Toolkit

faBoundaryMesh.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     faBoundaryMesh
00027 
00028 Description
00029     Finite area boundary mesh
00030 
00031 SourceFiles
00032     faBoundaryMesh.C
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef faBoundaryMesh_H
00037 #define faBoundaryMesh_H
00038 
00039 #include "faPatchList.H"
00040 #include "wordList.H"
00041 #include "pointField.H"
00042 #include "regIOobject.H"
00043 
00044 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00045 
00046 namespace Foam
00047 {
00048 
00049 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00050 
00051 class faMesh;
00052 
00053 /*---------------------------------------------------------------------------*\
00054                       Class faBoundaryMesh Declaration
00055 \*---------------------------------------------------------------------------*/
00056 
00057 class faBoundaryMesh
00058 :
00059     public faPatchList,
00060     public regIOobject
00061 {
00062     // private data
00063 
00064         //- Reference to mesh
00065         const faMesh& mesh_;
00066 
00067         //- Disallow construct as copy
00068         faBoundaryMesh(const faBoundaryMesh&);
00069 
00070         //- Disallow assignment
00071         void operator=(const faBoundaryMesh&);
00072 
00073 
00074 public:
00075 
00076     //- Runtime type information
00077     TypeName("faBoundaryMesh");
00078 
00079 
00080     // Constructors
00081 
00082         //- Construct from dictionary
00083         faBoundaryMesh
00084         (
00085             const IOobject& io,
00086             const faMesh& fam
00087         );
00088 
00089         //- Construct given size
00090         faBoundaryMesh
00091         (
00092             const IOobject& io,
00093             const faMesh& fam,
00094             const label size
00095         );
00096 
00097 
00098     // Destructor - default
00099 
00100 
00101     // Member functions
00102 
00103         //- Calculate the geometry for the patches (transformation tensors etc.)
00104         void calcGeometry();
00105 
00106         //- Return the mesh reference
00107         const faMesh& mesh() const;
00108 
00109         //- Return a list of patch types
00110         wordList types() const;
00111 
00112         //- Return a list of patch geometric types
00113 //         wordList geometricTypes() const;
00114 
00115         //- Return a list of patch names
00116         wordList names() const;
00117 
00118         //- Find patch index given a name
00119         label findPatchID(const word& patchName) const;
00120 
00121         //- Return patch index for a given edge label
00122         label whichPatch(const label edgeIndex) const;
00123 
00124         //- Check boundary definition
00125         bool checkDefinition(const bool report = false) const;
00126 
00127 
00128         //- Correct faBoundaryMesh after moving points
00129         void movePoints(const pointField&);
00130 
00131         //- writeData member function required by regIOobject
00132         bool writeData(Ostream&) const;
00133 
00134 
00135     // Ostream operator
00136 
00137         friend Ostream& operator<<(Ostream&, const faBoundaryMesh&);
00138 };
00139 
00140 
00141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00142 
00143 } // End namespace Foam
00144 
00145 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00146 
00147 #endif
00148 
00149 // ************************************************************************* //
For further information go to www.openfoam.org