src/OpenFOAM/matrices/lduMatrix/lduAddressing/lduSchedule/lduSchedule.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::lduScheduleEntry
  26
  27 Description
  28     Struct to hold the patch index and the initialisation flag for
  29     the patch schedule
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef lduSchedule_H
  34 #define lduSchedule_H
  35
  36 #include "List.H"
  37
  38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  39
  40 namespace Foam
  41 {
  42
  43 // Forward declaration of friend functions and operators
  44
  45 struct lduScheduleEntry;
  46 Ostream& operator<<(Ostream& os, const lduScheduleEntry& lb);
  47
  48
  49 /*---------------------------------------------------------------------------*\
  50                       Class lduSchedule Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 struct lduScheduleEntry
  54 {
  55     label patch;
  56     bool init;
  57
  58     friend bool operator!=
  59     (
  60         const lduScheduleEntry& lb1,
  61         const lduScheduleEntry& lb2
  62     )
  63     {
  64         return true;
  65     }
  66
  67     friend Ostream& operator<<(Ostream& os, const lduScheduleEntry& lb)
  68     {
  69         os  << lb.patch << token::SPACE << lb.init;
  70         return os;
  71     }
  72 };
  73
  74
  75 typedef List<lduScheduleEntry> lduSchedule;
  76
  77
  78 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  79
  80 } // End namespace Foam
  81
  82 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  83
  84 #endif
  85
  86 // ************************************************************************* //