src/finiteVolume/fvMesh/fvMesh.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::fvMesh
  27
  28 Description
  29     Mesh data needed to do the Finite Volume discretisation.
  30
  31     NOTE ON USAGE:
  32     fvMesh contains all the topological and geometric information
  33     related to the mesh.  It is also responsible for keeping the data
  34     up-to-date.  This is done by deleting the cell volume, face area,
  35     cell/face centre, addressing and other derived information as
  36     required and recalculating it as necessary.  The fvMesh therefore
  37     reserves the right to delete the derived information upon every
  38     topological (mesh refinement/morphing) or geometric change (mesh
  39     motion).  It is therefore unsafe to keep local references to the
  40     derived data outside of the time loop.
  41
  42 SourceFiles
  43     fvMesh.C
  44     fvMeshGeometry.C
  45
  46 \*---------------------------------------------------------------------------*/
  47
  48 #ifndef fvMesh_H
  49 #define fvMesh_H
  50
  51 #include "polyMesh.H"
  52 #include "lduMesh.H"
  53 #include "primitiveMesh.H"
  54 #include "fvBoundaryMesh.H"
  55 #include "surfaceInterpolation.H"
  56 #include "DimensionedField.H"
  57 #include "volFieldsFwd.H"
  58 #include "surfaceFieldsFwd.H"
  59 #include "pointFieldsFwd.H"
  60 #include "slicedVolFieldsFwd.H"
  61 #include "slicedSurfaceFieldsFwd.H"
  62
  63 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  64
  65 namespace Foam
  66 {
  67
  68 class fvMeshLduAddressing;
  69 class volMesh;
  70
  71
  72 /*---------------------------------------------------------------------------*\
  73                            Class fvMesh Declaration
  74 \*---------------------------------------------------------------------------*/
  75
  76 class fvMesh
  77 :
  78     public polyMesh,
  79     public lduMesh,
  80     public surfaceInterpolation
  81 {
  82     // Private data
  83
  84         //- Boundary mesh
  85         fvBoundaryMesh boundary_;
  86
  87
  88     // Demand-driven data
  89
  90         mutable fvMeshLduAddressing* lduPtr_;
  91
  92         //- Current time index for cell volumes
  93         //  Note.  The whole mechanism will be replaced once the
  94         //  dimensionedField is created and the dimensionedField
  95         //  will take care of the old-time levels.
  96         mutable label curTimeIndex_;
  97
  98         //- Cell volumes
  99         mutable DimensionedField<scalar, volMesh>* VPtr_;
 100
 101         //- Cell volumes old time level
 102         mutable DimensionedField<scalar, volMesh>* V0Ptr_;
 103
 104         //- Cell volumes old-old time level
 105         mutable DimensionedField<scalar, volMesh>* V00Ptr_;
 106
 107         //- Face area vectors
 108         mutable slicedSurfaceVectorField* SfPtr_;
 109
 110         //- Mag face area vectors
 111         mutable surfaceScalarField* magSfPtr_;
 112
 113         //- Cell centres
 114         mutable slicedVolVectorField* CPtr_;
 115
 116         //- Face centres
 117         mutable slicedSurfaceVectorField* CfPtr_;
 118
 119         //- Face motion fluxes
 120         mutable surfaceScalarField* phiPtr_;
 121
 122
 123     // Private Member Functions
 124
 125        // Make geometric data
 126
 127             void makeSf() const;
 128
 129             //- Make face area magnitudes
 130             void makeMagSf() const;
 131
 132             //- Make mesh motion fluxes
 133             void makePhi() const;
 134
 135             //- Update mesh motion fluxes given swept volumes
 136             void updatePhi(const scalarField& sweptVols) const;
 137
 138             //- Make cell centres
 139             void makeC() const;
 140
 141             //- Make face centres
 142             void makeCf() const;
 143
 144
 145         //- Disallow construct as copy
 146         fvMesh(const fvMesh&);
 147
 148         //- Disallow assignment
 149         void operator=(const fvMesh&);
 150
 151
 152         // Storage management
 153
 154             //- Clear geometry but not the old-time cell volumes
 155             void clearGeomNotOldVol();
 156
 157             //- Clear geometry
 158             void clearGeom();
 159
 160             //- Clear addressing
 161             void clearAddressing();
 162
 163
 164 public:
 165
 166     // Public typedefs
 167
 168         typedef fvMesh Mesh;
 169         typedef fvBoundaryMesh BoundaryMesh;
 170
 171
 172     // Declare name of the class and its debug switch
 173     TypeName("fvMesh");
 174
 175
 176     // Constructors
 177
 178         //- Construct from IOobject
 179         explicit fvMesh(const IOobject& io);
 180
 181         //- Construct from components without boundary.
 182         //  Boundary is added using addFvPatches() member function
 183         fvMesh
 184         (
 185             const IOobject& io,
 186             const Xfer<pointField>& points,
 187             const Xfer<faceList>& faces,
 188             const Xfer<labelList>& allOwner,
 189             const Xfer<labelList>& allNeighbour,
 190             const bool syncPar = true
 191         );
 192
 193         //- Construct without boundary from cells rather than owner/neighbour.
 194         //  Boundary is added using addPatches() member function
 195         fvMesh
 196         (
 197             const IOobject& io,
 198             const Xfer<pointField>& points,
 199             const Xfer<faceList>& faces,
 200             const Xfer<cellList>& cells,
 201             const bool syncPar = true
 202         );
 203
 204
 205     // Destructor
 206
 207         virtual ~fvMesh();
 208
 209
 210     // Member Functions
 211
 212         // Helpers
 213
 214             //- Add boundary patches. Constructor helper
 215             void addFvPatches
 216             (
 217                 const List<polyPatch*>&,
 218                 const bool validBoundary = true
 219             );
 220
 221             //- Update the mesh based on the mesh files saved in time
 222             //  directories
 223             virtual readUpdateState readUpdate();
 224
 225
 226         // Access
 227
 228             //- Return the top-level database
 229             const Time& time() const
 230             {
 231                 return polyMesh::time();
 232             }
 233
 234             //- Return the object registry - resolve conflict polyMesh/lduMesh
 235             virtual const objectRegistry& thisDb() const
 236             {
 237                 return polyMesh::thisDb();
 238             }
 239
 240             //- Return reference to name
 241             //  Note: name() is currently ambiguous due to derivation from
 242             //  surfaceInterpolation
 243             const word& name() const
 244             {
 245                 return polyMesh::name();
 246             }
 247
 248             //- Return reference to boundary mesh
 249             const fvBoundaryMesh& boundary() const;
 250
 251             //- Return ldu addressing
 252             virtual const lduAddressing& lduAddr() const;
 253
 254             //- Return a list of pointers for each patch
 255             //  with only those pointing to interfaces being set
 256             virtual lduInterfacePtrsList interfaces() const
 257             {
 258                 return boundary().interfaces();
 259             }
 260
 261             //- Internal face owner
 262             const unallocLabelList& owner() const
 263             {
 264                 return lduAddr().lowerAddr();
 265             }
 266
 267             //- Internal face neighbour
 268             const unallocLabelList& neighbour() const
 269             {
 270                 return lduAddr().upperAddr();
 271             }
 272
 273
 274             //- Return cell volumes
 275             const DimensionedField<scalar, volMesh>& V() const;
 276
 277             //- Return old-time cell volumes
 278             const DimensionedField<scalar, volMesh>& V0() const;
 279
 280             //- Return old-old-time cell volumes
 281             const DimensionedField<scalar, volMesh>& V00() const;
 282
 283             //- Return sub-cycle cell volumes
 284             tmp<DimensionedField<scalar, volMesh> > Vsc() const;
 285
 286             //- Return sub-cycl old-time cell volumes
 287             tmp<DimensionedField<scalar, volMesh> > Vsc0() const;
 288
 289             //- Return cell face area vectors
 290             const surfaceVectorField& Sf() const;
 291
 292             //- Return cell face area magnitudes
 293             const surfaceScalarField& magSf() const;
 294
 295             //- Return cell face motion fluxes
 296             const surfaceScalarField& phi() const;
 297
 298             //- Return cell centres as volVectorField
 299             const volVectorField& C() const;
 300
 301             //- Return face centres as surfaceVectorField
 302             const surfaceVectorField& Cf() const;
 303
 304
 305         // Edit
 306
 307             //- Clear all geometry and addressing
 308             void clearOut();
 309
 310             //- Update mesh corresponding to the given map
 311             virtual void updateMesh(const mapPolyMesh& mpm);
 312
 313             //- Sync mesh update for topo change on other processors
 314             //  Locally, there is no topological change
 315             virtual void syncUpdateMesh();
 316
 317             //- Move points, returns volumes swept by faces in motion
 318             virtual tmp<scalarField> movePoints(const pointField&);
 319
 320             //- Map all fields in time using given map.
 321             virtual void mapFields(const mapPolyMesh& mpm) const;
 322
 323             //- Map cell volumes in time using given map.
 324             virtual void mapOldVolumes(const mapPolyMesh& mpm);
 325
 326             //- Remove boundary patches. Warning: fvPatchFields hold ref to
 327             //  these fvPatches.
 328             void removeFvBoundary();
 329
 330             //- Return cell face motion fluxes
 331             surfaceScalarField& setPhi();
 332
 333             //- Return old-time cell volumes
 334             DimensionedField<scalar, volMesh>& setV0();
 335
 336
 337         // Write
 338
 339             //- Write the underlying polyMesh and other data
 340             virtual bool writeObjects
 341             (
 342                 IOstream::streamFormat fmt,
 343                 IOstream::versionNumber ver,
 344                 IOstream::compressionType cmp
 345             ) const;
 346
 347             //- Write mesh using IO settings from time
 348             virtual bool write() const;
 349
 350
 351     // Member Operators
 352
 353         bool operator!=(const fvMesh&) const;
 354         bool operator==(const fvMesh&) const;
 355 };
 356
 357
 358 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 359
 360 } // End namespace Foam
 361
 362 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 363
 364 #ifdef NoRepository
 365 #   include "fvPatchFvMeshTemplates.C"
 366 #endif
 367
 368 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 369
 370 #endif
 371
 372 // ************************************************************************* //