src/OpenFOAM/meshes/lduMesh/lduPrimitiveMesh.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::lduPrimitiveMesh
  27
  28 Description
  29     Simplest contrete lduMesh which stores the addressing needed bu lduMatrix.
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef lduPrimitiveMesh_H
  34 #define lduPrimitiveMesh_H
  35
  36 #include "lduMesh.H"
  37 #include "labelList.H"
  38
  39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  40
  41 namespace Foam
  42 {
  43
  44 /*---------------------------------------------------------------------------*\
  45                        Class lduPrimitiveMesh Declaration
  46 \*---------------------------------------------------------------------------*/
  47
  48 class lduPrimitiveMesh
  49 :
  50     public lduMesh,
  51     public lduAddressing
  52 {
  53     // Private data
  54
  55         //- Lower addressing
  56         labelList lowerAddr_;
  57
  58         //- Upper addressing
  59         labelList upperAddr_;
  60
  61         //- Patch to internal addressing
  62         labelListList patchAddr_;
  63
  64         //- List of pointers for each patch
  65         //  with only those pointing to interfaces being set
  66         lduInterfacePtrsList interfaces_;
  67
  68         //- Patch field evaluation schedule.
  69         //  Note this does must be held as a copy.  HJ, 20/Feb/2009
  70         lduSchedule patchSchedule_;
  71
  72
  73     // Private Member Functions
  74
  75         //- Disallow default bitwise copy construct
  76         lduPrimitiveMesh(const lduPrimitiveMesh&);
  77
  78         //- Disallow default bitwise assignment
  79         void operator=(const lduPrimitiveMesh&);
  80
  81
  82 public:
  83
  84     // Constructors
  85
  86         //- Construct from components as copies
  87         //  Interfaces are added upon construction.  HJ, 20/Feb/2009
  88         lduPrimitiveMesh
  89         (
  90             const label nCells,
  91             const unallocLabelList& l,
  92             const unallocLabelList& u
  93         )
  94         :
  95             lduAddressing(nCells),
  96             lowerAddr_(l),
  97             upperAddr_(u)
  98         {}
  99
 100
 101         //- Construct from components and re-use storage as specified.
 102         lduPrimitiveMesh
 103         (
 104             const label nCells,
 105             labelList& l,
 106             labelList& u,
 107             bool reUse
 108         )
 109         :
 110             lduAddressing(nCells),
 111             lowerAddr_(l, reUse),
 112             upperAddr_(u, reUse)
 113         {}
 114
 115
 116     // Destructor
 117
 118         virtual ~lduPrimitiveMesh()
 119         {}
 120
 121
 122     // Member Functions
 123
 124         //- Add interfaces.  Constructor helper
 125         void addInterfaces
 126         (
 127             const lduInterfacePtrsList& interfaces,
 128             const labelListList& pa,
 129             const lduSchedule& ps
 130         )
 131         {
 132             interfaces_ = interfaces;
 133             patchAddr_ = pa;
 134             patchSchedule_ = ps;
 135         }
 136
 137         //- Return number of interfaces
 138         virtual label nPatches() const
 139         {
 140             return patchAddr_.size();
 141         }
 142
 143
 144         // Access
 145
 146             //- Return ldu addressing
 147             virtual const lduAddressing& lduAddr() const
 148             {
 149                 return *this;
 150             }
 151
 152             //- Return a list of pointers for each patch
 153             //  with only those pointing to interfaces being set
 154             virtual lduInterfacePtrsList interfaces() const
 155             {
 156                 return interfaces_;
 157             }
 158
 159             //- Return Lower addressing
 160             virtual const unallocLabelList& lowerAddr() const
 161             {
 162                 return lowerAddr_;
 163             }
 164
 165             //- Return Upper addressing
 166             virtual const unallocLabelList& upperAddr() const
 167             {
 168                 return upperAddr_;
 169             }
 170
 171             //- Return patch addressing
 172             virtual const unallocLabelList& patchAddr(const label i) const
 173             {
 174                 return patchAddr_[i];
 175             }
 176
 177             //- Return patch evaluation schedule
 178             virtual const lduSchedule& patchSchedule() const
 179             {
 180                 return patchSchedule_;
 181             }
 182 };
 183
 184
 185 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 186
 187 } // End namespace Foam
 188
 189 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 190
 191 #endif
 192
 193 // ************************************************************************* //