src/OpenFOAM/meshes/lduMesh/lduPrimitiveMesh.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   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 not need to be held as a copy because it is invariant
  70         const 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         lduPrimitiveMesh
  88         (
  89             const label nCells,
  90             const unallocLabelList& l,
  91             const unallocLabelList& u,
  92             const labelListList& pa,
  93             lduInterfacePtrsList interfaces,
  94             const lduSchedule& ps
  95         )
  96         :
  97             lduAddressing(nCells),
  98             lowerAddr_(l),
  99             upperAddr_(u),
 100             patchAddr_(pa),
 101             interfaces_(interfaces),
 102             patchSchedule_(ps)
 103         {}
 104
 105
 106         //- Construct from components and  re-use storage as specified.
 107         lduPrimitiveMesh
 108         (
 109             const label nCells,
 110             labelList& l,
 111             labelList& u,
 112             labelListList& pa,
 113             lduInterfacePtrsList interfaces,
 114             const lduSchedule& ps,
 115             bool reUse
 116         )
 117         :
 118             lduAddressing(nCells),
 119             lowerAddr_(l, reUse),
 120             upperAddr_(u, reUse),
 121             patchAddr_(pa, reUse),
 122             interfaces_(interfaces, reUse),
 123             patchSchedule_(ps)
 124         {}
 125
 126
 127     // Destructor
 128
 129         virtual ~lduPrimitiveMesh()
 130         {}
 131
 132
 133     // Member Functions
 134
 135         // Access
 136
 137             //- Return ldu addressing
 138             virtual const lduAddressing& lduAddr() const
 139             {
 140                 return *this;
 141             }
 142
 143             //- Return a list of pointers for each patch
 144             //  with only those pointing to interfaces being set
 145             virtual lduInterfacePtrsList interfaces() const
 146             {
 147                 return interfaces_;
 148             }
 149
 150             //- Return Lower addressing
 151             virtual const unallocLabelList& lowerAddr() const
 152             {
 153                 return lowerAddr_;
 154             }
 155
 156             //- Return Upper addressing
 157             virtual const unallocLabelList& upperAddr() const
 158             {
 159                 return upperAddr_;
 160             }
 161
 162             //- Return patch addressing
 163             virtual const unallocLabelList& patchAddr(const label i) const
 164             {
 165                 return patchAddr_[i];
 166             }
 167
 168             //- Return patch evaluation schedule
 169             virtual const lduSchedule& patchSchedule() const
 170             {
 171                 return patchSchedule_;
 172             }
 173 };
 174
 175
 176 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 177
 178 } // End namespace Foam
 179
 180 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 181
 182 #endif
 183
 184 // ************************************************************************* //