Public Member Functions | Friends | List of all members
patchInteractionData Class Reference

Helper class for the LocalInteraction patch interaction model. More...

Public Member Functions

 patchInteractionData ()
 Default construct. More...
 
const word & interactionTypeName () const noexcept
 The interaction type name. More...
 
const wordRe & patchName () const noexcept
 The patch name(s) More...
 
scalar e () const noexcept
 The elasticity coefficient. More...
 
scalar mu () const noexcept
 The restitution coefficient. More...
 

Friends

Istream & operator>> (Istream &is, patchInteractionData &pid)
 Istream operator. More...
 

Detailed Description

Helper class for the LocalInteraction patch interaction model.

Definition at line 47 of file patchInteractionData.H.

Constructor & Destructor Documentation

◆ patchInteractionData()

patchInteractionData ( )

Default construct.

Definition at line 28 of file patchInteractionData.C.

Member Function Documentation

◆ interactionTypeName()

const word& interactionTypeName ( ) const
inlinenoexcept

The interaction type name.

Definition at line 87 of file patchInteractionData.H.

◆ patchName()

const wordRe& patchName ( ) const
inlinenoexcept

The patch name(s)

Definition at line 95 of file patchInteractionData.H.

◆ e()

scalar e ( ) const
inlinenoexcept

The elasticity coefficient.

Definition at line 103 of file patchInteractionData.H.

◆ mu()

scalar mu ( ) const
inlinenoexcept

The restitution coefficient.

Definition at line 111 of file patchInteractionData.H.

Friends And Related Function Documentation

◆ operator>>

Istream& operator>> ( Istream &  is,
patchInteractionData &  pid 
)
friend

Istream operator.

The documentation for this class was generated from the following files: