patchInteractionData Class Reference

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

Collaboration diagram for patchInteractionData:

Public Member Functions
	patchInteractionData ()
	Construct null. More...
const word &	interactionTypeName () const
	Return const access to the interaction type name. More...
const word &	patchName () const
	Return const access to the patch name. More...
scalar	e () const
	Return const access to the elasticity coefficient. More...
scalar	mu () const
	Return const access to the restitution coefficient. More...

Private Attributes
word	interactionTypeName_
	Interaction type name. More...
word	patchName_
	Patch name. More...
scalar	e_
	Elasticity coefficient. More...
scalar	mu_
	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 55 of file patchInteractionData.H.

Constructor & Destructor Documentation

patchInteractionData()

patchInteractionData

(

)

Construct null.

Definition at line 32 of file patchInteractionData.C.

Member Function Documentation

interactionTypeName()

const Foam::word & interactionTypeName

(

)

const

Return const access to the interaction type name.

Definition at line 43 of file patchInteractionData.C.

patchName()

const Foam::word & patchName

(

)

const

Return const access to the patch name.

Definition at line 49 of file patchInteractionData.C.

e()

Foam::scalar e

(

)

const

Return const access to the elasticity coefficient.

Definition at line 55 of file patchInteractionData.C.

mu()

Foam::scalar mu

(

)

const

Return const access to the restitution coefficient.

Definition at line 61 of file patchInteractionData.C.

Friends And Related Function Documentation

operator>>

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

friend

Istream operator.

Field Documentation

interactionTypeName_

word interactionTypeName_

private

Interaction type name.

Definition at line 60 of file patchInteractionData.H.

patchName_

word patchName_

private

Patch name.

Definition at line 63 of file patchInteractionData.H.

e_

scalar e_

private

Elasticity coefficient.

Definition at line 66 of file patchInteractionData.H.

mu_

scalar mu_

private

Restitution coefficient.

Definition at line 69 of file patchInteractionData.H.

---

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