enginePiston Class Reference

Foam::enginePiston. More...

Public Member Functions
	enginePiston (const polyMesh &mesh, const word &pistonPatchName, const autoPtr< coordinateSystem > &pistonCS, const scalar minLayer, const scalar maxLayer)
	Construct from components. More...
	enginePiston (const polyMesh &mesh, const dictionary &dict)
	Construct from dictionary. More...
	~enginePiston ()=default
	Destructor. More...
const coordinateSystem &	cs () const
	Return coordinate system. More...
const polyPatchID &	patchID () const
	Return ID of piston patch. More...
scalar	minLayer () const
scalar	maxLayer () const
void	writeDict (Ostream &) const
	Write dictionary. More...

Detailed Description

Foam::enginePiston.

Source files

• enginePiston.H
• enginePiston.C

Definition at line 51 of file enginePiston.H.

Constructor & Destructor Documentation

enginePiston() [1/2]

enginePiston	(	const polyMesh &	mesh,
		const word &	pistonPatchName,
		const autoPtr< coordinateSystem > &	pistonCS,
		const scalar	minLayer,
		const scalar	maxLayer
	)

Construct from components.

Definition at line 29 of file enginePiston.C.

enginePiston() [2/2]

enginePiston	(	const polyMesh &	mesh,
		const dictionary &	dict
	)

Construct from dictionary.

Definition at line 47 of file enginePiston.C.

~enginePiston()

~enginePiston ( )

default

Destructor.

Member Function Documentation

cs()

const coordinateSystem& cs ( ) const

inline

Return coordinate system.

Definition at line 143 of file enginePiston.H.

patchID()

const polyPatchID& patchID ( ) const

inline

Return ID of piston patch.

Definition at line 151 of file enginePiston.H.

minLayer()

scalar minLayer ( ) const

inline

Definition at line 158 of file enginePiston.H.

maxLayer()

scalar maxLayer ( ) const

inline

Definition at line 163 of file enginePiston.H.

writeDict()

void writeDict

(

Ostream &

os

)

const

Write dictionary.

Definition at line 66 of file enginePiston.C.

References token::BEGIN_BLOCK, token::END_BLOCK, token::END_STATEMENT, Foam::endl(), DynamicID< ObjectType >::name(), Foam::nl, and os().

Here is the call graph for this function:

---

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

• src/engine/enginePiston/enginePiston.H
• src/engine/enginePiston/enginePiston.C