src/multiSolver/timeCluster/timeClusterList.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::timeClusterList
  26
  27 Description
  28     List of timeClusters with some additional functions
  29
  30 SourceFiles
  31     timeClusterList.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef timeClusterList_H
  36 #define timeClusterList_H
  37
  38 #include "timeCluster.H"
  39 #include "labelList.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                         Class timeClusterList Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class timeClusterList
  51 :
  52     public List<timeCluster>
  53 {
  54
  55 public:
  56
  57     // Static data members
  58
  59         static const char* const typeName;
  60
  61     // Constructors
  62
  63         //- Null constructor
  64         timeClusterList();
  65
  66         //- Construct with given size.
  67         explicit timeClusterList(const label);
  68
  69         //- Construct from a timeCluster.
  70         timeClusterList(const timeCluster&);
  71
  72         //- Construct with given size and value for all elements.
  73         timeClusterList(const label, const timeCluster&);
  74
  75         //- Construct as a sublist of another timeClusterList. This is not
  76         //  like the SubList in that this is not a new class, rather it is only
  77         //  producing a new copy that contains the specified entries.
  78         timeClusterList(const labelList&, const timeClusterList&);
  79
  80         //- Construct from Istream.
  81         timeClusterList(Istream&);
  82
  83     // Member functions
  84
  85         //- Sort by global time
  86         void globalSort();
  87
  88         //- Append another timeClusterList on the end of this one
  89         void append(const timeClusterList& tclIn);
  90
  91         //- Append a timeCluster on the end of this list
  92         void append(const timeCluster& tcIn);
  93
  94         //- Remove timeClusters with empty instantLists return false if all are
  95         //  empty
  96         bool purgeEmpties();
  97
  98         //- Return a sublist using the specified indexes
  99         timeClusterList selectiveSubList(const labelList&) const;
 100
 101 };
 102
 103 } // End namespace Foam
 104
 105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 106
 107 #endif
 108
 109 // ************************************************************************* //