src/parallel/decompose/decompositionMethods/geomDecomp/geomDecomp.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-2010 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
  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::geomDecomp
  26
  27 Description
  28     Geometrical domain decomposition
  29
  30 SourceFiles
  31     geomDecomp.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef geomDecomp_H
  36 #define geomDecomp_H
  37
  38 #include "decompositionMethod.H"
  39 #include "Vector.H"
  40
  41 namespace Foam
  42 {
  43
  44 /*---------------------------------------------------------------------------*\
  45                            Class geomDecomp Declaration
  46 \*---------------------------------------------------------------------------*/
  47
  48 class geomDecomp
  49 :
  50     public decompositionMethod
  51 {
  52
  53 protected:
  54
  55     // Protected data
  56
  57         const dictionary& geomDecomDict_;
  58
  59         Vector<label> n_;
  60         scalar delta_;
  61         tensor rotDelta_;
  62
  63 public:
  64
  65     // Constructors
  66
  67         //- Construct given the decomposition dictionary
  68         //  and the derived type name
  69         geomDecomp
  70         (
  71             const dictionary& decompositionDict,
  72             const word& derivedType
  73         );
  74
  75         //- Return for every coordinate the wanted processor number.
  76         virtual labelList decompose
  77         (
  78             const pointField& points,
  79             const scalarField& pointWeights
  80         ) = 0;
  81
  82         //- Like decompose but with uniform weights on the points
  83         virtual labelList decompose(const pointField&) = 0;
  84
  85 };
  86
  87
  88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  89
  90 } // End namespace Foam
  91
  92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  93
  94 #endif
  95
  96 // ************************************************************************* //