patchInteractionData Class Reference

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

#include <patchInteractionData.H>

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

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

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.

Referenced by operator>>.

Here is the caller graph for this function:

Member Function Documentation

interactionTypeName()

const word & interactionTypeName ( ) const

inlinenoexcept

The interaction type name.

Definition at line 87 of file patchInteractionData.H.

References Foam::noexcept.

patchName()

const wordRe & patchName ( ) const

inlinenoexcept

The patch name(s).

Definition at line 95 of file patchInteractionData.H.

References Foam::noexcept.

e()

scalar e ( ) const

inlinenoexcept

The elasticity coefficient.

Definition at line 103 of file patchInteractionData.H.

References Foam::noexcept.

mu()

scalar mu ( ) const

inlinenoexcept

The restitution coefficient.

Definition at line 111 of file patchInteractionData.H.

References Foam::noexcept.

Friends And Related Symbol Documentation

operator>>

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

friend

Istream operator.

References patchInteractionData(), and Foam::pid().

---

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

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