patchInteractionData.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 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::patchInteractionData
26 
27 Description
28  Helper class for the LocalInteraction patch interaction model
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef patchInteractionData_H
33 #define patchInteractionData_H
34 
35 #include "Istream.H"
36 
37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
38 
39 namespace Foam
40 {
41 /*---------------------------------------------------------------------------*\
42  Class patchInteractionData Declaration
43 \*---------------------------------------------------------------------------*/
44 
45 // Forward declaration of classes
46 class patchInteractionData;
47 
48 // Forward declaration of friend functions
49 Istream& operator>>
50 (
51  Istream& is,
52  patchInteractionData& pid
53 );
54 
55 
57 {
58  // Private data
59 
60  //- Interaction type name
61  word interactionTypeName_;
62 
63  //- Patch name
64  word patchName_;
65 
66  //- Elasticity coefficient
67  scalar e_;
68 
69  //- Restitution coefficient
70  scalar mu_;
71 
72 
73 public:
74 
75  // Constructor
76 
77  //- Construct null
79 
80 
81  // Member functions
82 
83  // Access
84 
85  //- Return const access to the interaction type name
86  const word& interactionTypeName() const;
87 
88  //- Return const access to the patch name
89  const word& patchName() const;
90 
91  //- Return const access to the elasticity coefficient
92  scalar e() const;
93 
94  //- Return const access to the restitution coefficient
95  scalar mu() const;
96 
97 
98  // I-O
99 
100  //- Istream operator
101  friend Istream& operator>>
102  (
103  Istream& is,
105  );
106 };
107 
108 
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 
111 } // End namespace Foam
112 
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114 
115 #endif
116 
117 // ************************************************************************* //
const word & patchName() const
Return const access to the patch name.
Helper class for the LocalInteraction patch interaction model.
const word & interactionTypeName() const
Return const access to the interaction type name.
scalar mu() const
Return const access to the restitution coefficient.
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
scalar e() const
Return const access to the elasticity coefficient.
A class for handling words, derived from string.
Definition: word.H:59
patchInteractionData()
Construct null.
pid_t pid()
Return the PID of this process.
Definition: POSIX.C:72
Namespace for OpenFOAM.