src/parallel/decompose/decompositionMethods/structuredDecomp/structuredDecomp.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::structuredDecomp
  26
  27 Description
  28     Decomposition given using consecutive application of decomposers.
  29
  30 SourceFiles
  31     structuredDecomp.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef structuredDecomp_H
  36 #define structuredDecomp_H
  37
  38 #include "decompositionMethod.H"
  39
  40 namespace Foam
  41 {
  42
  43 /*---------------------------------------------------------------------------*\
  44                            Class structuredDecomp Declaration
  45 \*---------------------------------------------------------------------------*/
  46
  47 class structuredDecomp
  48 :
  49     public decompositionMethod
  50 {
  51     // Private data
  52
  53         dictionary methodDict_;
  54
  55         autoPtr<decompositionMethod> method_;
  56
  57         wordList patches_;
  58
  59
  60     // Private Member Functions
  61
  62         //- Disallow default bitwise copy construct and assignment
  63         void operator=(const structuredDecomp&);
  64         structuredDecomp(const structuredDecomp&);
  65
  66
  67 public:
  68
  69     //- Runtime type information
  70     TypeName("structured");
  71
  72
  73     // Constructors
  74
  75         //- Construct given the decomposition dictionary
  76         structuredDecomp(const dictionary& decompositionDict);
  77
  78
  79     //- Destructor
  80     virtual ~structuredDecomp()
  81     {}
  82
  83
  84     // Member Functions
  85
  86         //- Is method parallel aware (i.e. does it synchronize domains across
  87         //  proc boundaries)
  88         virtual bool parallelAware() const;
  89
  90         //- Return for every coordinate the wanted processor number. Use the
  91         //  mesh connectivity (if needed)
  92         virtual labelList decompose
  93         (
  94             const polyMesh& mesh,
  95             const pointField& points,
  96             const scalarField& pointWeights
  97         );
  98
  99         //- Return for every coordinate the wanted processor number. Explicitly
 100         //  provided connectivity - does not use mesh_.
 101         virtual labelList decompose
 102         (
 103             const labelListList& globalCellCells,
 104             const pointField& cc,
 105             const scalarField& cWeights
 106         );
 107 };
 108
 109
 110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 111
 112 } // End namespace Foam
 113
 114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 115
 116 #endif
 117
 118 // ************************************************************************* //