src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/LocalInteraction/patchInteractionData.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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::patchInteractionData
  27
  28 Description
  29     Helper class for the LocalInteraction patch interaction model
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef patchInteractionData_H
  34 #define patchInteractionData_H
  35
  36 #include "Istream.H"
  37
  38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  39
  40 namespace Foam
  41 {
  42 /*---------------------------------------------------------------------------*\
  43                     Class patchInteractionData Declaration
  44 \*---------------------------------------------------------------------------*/
  45
  46 // Forward declaration of classes
  47 class patchInteractionData;
  48
  49 // Forward declaration of friend functions
  50 Istream& operator>>
  51 (
  52     Istream& is,
  53     patchInteractionData& pid
  54 );
  55
  56
  57 class patchInteractionData
  58 {
  59     // Private data
  60
  61         //- Interaction type name
  62         word interactionTypeName_;
  63
  64         //- Patch name
  65         word patchName_;
  66
  67         //- Elasticity coefficient
  68         scalar e_;
  69
  70         //- Restitution coefficient
  71         scalar mu_;
  72
  73
  74 public:
  75
  76     // Constructor
  77
  78         //- Construct null
  79         patchInteractionData();
  80
  81
  82     // Member functions
  83
  84         // Access
  85
  86             //- Return const access to the interaction type name
  87             const word& interactionTypeName() const;
  88
  89             //- Return const access to the patch name
  90             const word& patchName() const;
  91
  92             //- Return const access to the elasticity coefficient
  93             scalar e() const;
  94
  95             //- Return const access to the restitution coefficient
  96             scalar mu() const;
  97
  98
  99         // I-O
 100
 101             //- Istream operator
 102             friend Istream& operator>>
 103             (
 104                 Istream& is,
 105                 patchInteractionData& pid
 106             );
 107 /*            {
 108                 is.check
 109                 (
 110                     "Istream& operator>>"
 111                     "(Istream&, patchInteractionData&)"
 112                 );
 113
 114                 const dictionaryEntry entry(dictionary::null, is);
 115
 116                 pid.patchName_ = entry.keyword();
 117                 entry.lookup("type") >> pid.interactionTypeName_;
 118                 pid.e_ = entry.lookupOrDefault<scalar>("e", 1.0);
 119                 pid.mu_ = entry.lookupOrDefault<scalar>("mu", 0.0);
 120
 121                 if
 122                 (
 123                     PatchInteractionModel<CloudType>::wordToInteractionType
 124                     (
 125                         pid.interactionTypeName_
 126                     )
 127                 == PatchInteractionModel<CloudType>::itOther)
 128                 {
 129                     FatalErrorIn
 130                     (
 131                         "friend Istream& operator>>"
 132                         "("
 133                             "Istream&, "
 134                             "patchInteractionData&"
 135                         ")"
 136                     )   << "Unknown patch interaction type "
 137                         << pid.interactionTypeName_
 138                         << ". Valid selections are:"
 139                         << PatchInteractionModel<CloudType>::
 140                         interactionTypeNames_
 141                         << endl << abort(FatalError);
 142                 }
 143
 144                 return is;
 145             }
 146 */};
 147
 148
 149 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 150
 151 } // End namespace Foam
 152
 153 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 154
 155 #endif
 156
 157 // ************************************************************************* //