src/OpenFOAM/meshes/lduMesh/lduMesh.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::lduMesh
  27
  28 Description
  29     Abstract base class for meshes which provide LDU addressing for the
  30     construction of lduMatrix and LDU-solvers.
  31
  32 \*---------------------------------------------------------------------------*/
  33
  34 #ifndef lduMesh_H
  35 #define lduMesh_H
  36
  37 #include "lduAddressing.H"
  38 #include "lduInterfacePtrsList.H"
  39 #include "typeInfo.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 class objectRegistry;
  47
  48 /*---------------------------------------------------------------------------*\
  49                            Class lduMesh Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class lduMesh
  53 {
  54
  55 public:
  56
  57     //- Runtime type information
  58     TypeName("lduMesh");
  59
  60
  61     // Constructors
  62
  63     // Destructor
  64
  65         virtual ~lduMesh()
  66         {}
  67
  68
  69     // Member Functions
  70
  71         // Access
  72
  73             //- Return the object registry
  74             virtual const objectRegistry& thisDb() const;
  75
  76             //- Return ldu addressing
  77             virtual const lduAddressing& lduAddr() const = 0;
  78
  79             //- Return a list of pointers for each patch
  80             //  with only those pointing to interfaces being set
  81             virtual lduInterfacePtrsList interfaces() const = 0;
  82 };
  83
  84
  85 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  86
  87 } // End namespace Foam
  88
  89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  90
  91 #endif
  92
  93 // ************************************************************************* //