applications/utilities/mesh/conversion/starToFoam/coupledFacePair.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::coupledFacePair
  27
  28 Description
  29     Data associated with a pair of coupled faces
  30
  31 SourceFiles
  32     coupledFacePair.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef coupledFacePair_H
  37 #define coupledFacePair_H
  38
  39 #include "label.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                            Class coupledFacePair Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class coupledFacePair
  51 {
  52     // Private data
  53
  54         //- STAR couple ID
  55         label coupleID_;
  56
  57         //- Master cell (lower cell label)
  58         label masterCellID_;
  59
  60         //- Master face (lower cell label)
  61         label masterFaceID_;
  62
  63         //- Slave cell (higher cell label)
  64         label slaveCellID_;
  65
  66         //- Slave face (higher cell label)
  67         label slaveFaceID_;
  68
  69         //- Integral or arbitrary flag
  70         bool integralMatch_;
  71
  72
  73 public:
  74
  75
  76     // Constructors
  77
  78         //- Construct from components
  79         coupledFacePair
  80         (
  81             const label coupleNo,              // STAR couple ID
  82             const label mC, const label mF,    // master cell and face
  83             const label sC, const label sF,    // slave cell and face
  84             const label integral
  85         );
  86
  87
  88     // Member Functions
  89
  90         //- Return STAR couple ID
  91         label coupleID() const
  92         {
  93             return coupleID_;
  94         }
  95
  96         //- Return master cell
  97         label masterCell() const
  98         {
  99             return masterCellID_;
 100         }
 101
 102         //- Return master face
 103         label masterFace() const
 104         {
 105             return masterFaceID_;
 106         }
 107
 108         //- Return slave cell
 109         label slaveCell() const
 110         {
 111             return slaveCellID_;
 112         }
 113
 114         //- Return slave face
 115         label slaveFace() const
 116         {
 117             return slaveFaceID_;
 118         }
 119
 120         //- Is this an integral match?
 121         bool integralMatch() const
 122         {
 123             return integralMatch_;
 124         }
 125
 126     // IOstream Operators
 127
 128         friend Ostream& operator<<(Ostream&, const coupledFacePair&);
 129 };
 130
 131
 132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 133
 134 } // End namespace Foam
 135
 136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 137
 138 #endif
 139
 140 // ************************************************************************* //