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

lduMesh.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::lduMesh
00026 
00027 Description
00028     Abstract base class for meshes which provide LDU addressing for the
00029     construction of lduMatrix and LDU-solvers.
00030 
00031 \*---------------------------------------------------------------------------*/
00032 
00033 #ifndef lduMesh_H
00034 #define lduMesh_H
00035 
00036 #include <OpenFOAM/lduAddressing.H>
00037 #include <OpenFOAM/lduInterfacePtrsList.H>
00038 #include <OpenFOAM/typeInfo.H>
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 class objectRegistry;
00046 
00047 /*---------------------------------------------------------------------------*\
00048                            Class lduMesh Declaration
00049 \*---------------------------------------------------------------------------*/
00050 
00051 class lduMesh
00052 {
00053 
00054 public:
00055 
00056     //- Runtime type information
00057     TypeName("lduMesh");
00058 
00059 
00060     // Constructors
00061 
00062     // Destructor
00063 
00064         virtual ~lduMesh()
00065         {}
00066 
00067 
00068     // Member Functions
00069 
00070         // Access
00071 
00072             //- Return the object registry
00073             virtual const objectRegistry& thisDb() const;
00074 
00075             //- Return ldu addressing
00076             virtual const lduAddressing& lduAddr() const = 0;
00077 
00078             //- Return a list of pointers for each patch
00079             //  with only those pointing to interfaces being set
00080             virtual lduInterfacePtrsList interfaces() const = 0;
00081 };
00082 
00083 
00084 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00085 
00086 } // End namespace Foam
00087 
00088 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00089 
00090 #endif
00091 
00092 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines