src/OpenFOAM/meshes/lduMesh/lduMesh.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::lduMesh
  26
  27 Description
  28     Abstract base class for meshes which provide LDU addressing for the
  29     construction of lduMatrix and LDU-solvers.
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef lduMesh_H
  34 #define lduMesh_H
  35
  36 #include "lduAddressing.H"
  37 #include "lduInterfacePtrsList.H"
  38 #include "typeInfo.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 class objectRegistry;
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class lduMesh Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class lduMesh
  52 {
  53
  54 public:
  55
  56     //- Runtime type information
  57     TypeName("lduMesh");
  58
  59
  60     // Constructors
  61
  62     //- Destructor
  63     virtual ~lduMesh()
  64     {}
  65
  66
  67     // Member Functions
  68
  69         // Access
  70
  71             //- Return the object registry
  72             virtual const objectRegistry& thisDb() const;
  73
  74             //- Return ldu addressing
  75             virtual const lduAddressing& lduAddr() const = 0;
  76
  77             //- Return a list of pointers for each patch
  78             //  with only those pointing to interfaces being set
  79             virtual lduInterfacePtrsList interfaces() const = 0;
  80 };
  81
  82
  83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  84
  85 } // End namespace Foam
  86
  87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  88
  89 #endif
  90
  91 // ************************************************************************* //