src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/LocalInteraction/patchInteractionDataList.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::patchInteractionDataList
  26
  27 Description
  28     List container for patchInteractionData class
  29
  30 \*---------------------------------------------------------------------------*/
  31
  32 #ifndef patchInteractionDataList_H
  33 #define patchInteractionDataList_H
  34
  35 #include "patchInteractionData.H"
  36 #include "polyMesh.H"
  37 #include "dictionary.H"
  38 #include "labelList.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44 /*---------------------------------------------------------------------------*\
  45                   Class patchInteractionDataList Declaration
  46 \*---------------------------------------------------------------------------*/
  47
  48 class patchInteractionDataList
  49 :
  50     public List<patchInteractionData>
  51 {
  52 private:
  53
  54     // Private data
  55
  56         //- List of patch IDs for each patch group
  57         labelListList patchGroupIDs_;
  58
  59
  60 public:
  61
  62     // Constructor
  63
  64         //- Construct null
  65         patchInteractionDataList();
  66
  67         //- Construct copy
  68         patchInteractionDataList(const patchInteractionDataList& pidl);
  69
  70         //- Construct from Istream
  71         patchInteractionDataList(const polyMesh& mesh, const dictionary& dict);
  72
  73
  74     // Member functions
  75
  76         //- Return label of group containing patch id
  77         //  Returns -1 if patch id is not present
  78         label applyToPatch(const label id) const;
  79 };
  80
  81
  82 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  83
  84 } // End namespace Foam
  85
  86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  87
  88 #endif
  89
  90 // ************************************************************************* //