initial commit for version 1.5.x patch release
[OpenFOAM-1.5.x.git] / src / OpenFOAM / matrices / lduMatrix / lduAddressing / lduSchedule / lduSchedule.H
blobdaa33217f92ea99dd9329e334821bd15d0cf269e
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-2008 OpenCFD Ltd.
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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 the
13     Free Software Foundation; either version 2 of the License, or (at your
14     option) any later version.
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.
21     You should have received a copy of the GNU General Public License
22     along with OpenFOAM; if not, write to the Free Software Foundation,
23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 Class
26     Foam::lduScheduleEntry
28 Description
29     Struct to hold the patch index and the initialisation flag for
30     the patch schedule
32 \*---------------------------------------------------------------------------*/
34 #ifndef lduSchedule_H
35 #define lduSchedule_H
37 #include "List.H"
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 namespace Foam
44 // Forward declaration of friend functions and operators
46 class lduScheduleEntry;
47 Ostream& operator<<(Ostream& os, const lduScheduleEntry& lb);
50 /*---------------------------------------------------------------------------*\
51                       Class lduSchedule Declaration
52 \*---------------------------------------------------------------------------*/
54 struct lduScheduleEntry
56     label patch;
57     bool init;
59     friend bool operator!=
60     (
61         const lduScheduleEntry& lb1,
62         const lduScheduleEntry& lb2
63     )
64     {
65         return true;
66     }
68     friend Ostream& operator<<(Ostream& os, const lduScheduleEntry& lb)
69     {
70         os  << lb.patch << token::SPACE << lb.init;
71         return os;
72     }
76 typedef List<lduScheduleEntry> lduSchedule;
79 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
81 } // End namespace Foam
83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
85 #endif
87 // ************************************************************************* //