src/decompositionMethods/scotchDecomp/engineScotchDecomp/engineScotchDecomp.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::engineScotchDecomp
  26
  27 Description
  28     Domain decomposition for internal combustion engine simulations with
  29     topological changes.
  30
  31     The algorithm attempts to be as general as possible and operates in the
  32     following steps:
  33     - identify piston region and peform a decomposition biased towards the
  34     piston axis.  This aims to preserve load balancing when cell layers
  35     are added
  36     - identify static regions and decompose them separately
  37
  38 Author
  39     Hrvoje Jasak, Wikki Ltd.  All rights reserved.
  40
  41 SourceFiles
  42     engineScotchDecomp.C
  43
  44 \*---------------------------------------------------------------------------*/
  45
  46 #ifndef engineScotchDecomp_H
  47 #define engineScotchDecomp_H
  48
  49 #include "scotchDecomp.H"
  50 #include "Switch.H"
  51
  52 namespace Foam
  53 {
  54
  55 /*---------------------------------------------------------------------------*\
  56                        Class engineScotchDecomp Declaration
  57 \*---------------------------------------------------------------------------*/
  58
  59 class engineScotchDecomp
  60 :
  61     public scotchDecomp
  62 {
  63     // Private data
  64
  65         //- Dictionary
  66         dictionary dict_;
  67
  68         //- Sliding patch pairs
  69         List<Pair<word> > slidingPatchPairs_;
  70
  71         //- Use expanded area around sliding patches
  72         Switch expandSliding_;
  73
  74
  75     // Private Member Functions
  76
  77         //- Disallow default bitwise copy construct
  78         engineScotchDecomp(const engineScotchDecomp&);
  79
  80         //- Disallow default bitwise assignment
  81         void operator=(const engineScotchDecomp&);
  82
  83
  84         //- Check and print error message
  85         static void check(const int, const char*);
  86
  87         label decompose
  88         (
  89             const List<int>& adjncy,
  90             const List<int>& xadj,
  91             const scalarField& cWeights,
  92             List<int>& finalDecomp
  93         );
  94
  95
  96 public:
  97
  98     //- Runtime type information
  99     TypeName("engineScotch");
 100
 101
 102     // Constructors
 103
 104         //- Construct given the decomposition dictionary and mesh
 105         engineScotchDecomp
 106         (
 107             const dictionary& decompositionDict,
 108             const polyMesh& mesh
 109         );
 110
 111
 112     // Destructor
 113
 114         virtual ~engineScotchDecomp()
 115         {}
 116
 117
 118     // Member Functions
 119
 120         virtual bool parallelAware() const
 121         {
 122             return false;
 123         }
 124
 125         //- Decompose cells with weights
 126         virtual labelList decompose
 127         (
 128             const pointField& points,
 129             const scalarField& pointWeights
 130         );
 131
 132         //- Decompose cells with weights with explicitly provided connectivity
 133         virtual labelList decompose
 134         (
 135             const labelListList& globalCellCells,
 136             const pointField& cc,
 137             const scalarField& cWeights
 138         )
 139         {
 140             return decompose(cc, cWeights);
 141         }
 142 };
 143
 144
 145 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 146
 147 } // End namespace Foam
 148
 149 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 150
 151 #endif
 152
 153 // ************************************************************************* //