enginePiston Class Reference

Foam::enginePiston. More...

Collaboration diagram for enginePiston:

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...
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...

Private Member Functions
	enginePiston (const enginePiston &)
	Disallow default bitwise copy construct. More...
void	operator= (const enginePiston &)
	Disallow default bitwise assignment. More...

Private Attributes
const polyMesh &	mesh_
	Reference to engine mesh. More...
const engineTime &	engineDB_
	Reference to engine database. More...
polyPatchID	patchID_
	Piston patch. More...
autoPtr< coordinateSystem >	csPtr_
	Coordinate system. More...
const scalar	minLayer_
	Min layer thickness. More...
const scalar	maxLayer_
	Max layer thickness. More...

Detailed Description

Foam::enginePiston.

Source files

• enginePiston.H
• enginePiston.C

Definition at line 53 of file enginePiston.H.

Constructor & Destructor Documentation

enginePiston() [1/3]

enginePiston ( const enginePiston &  )

private

Disallow default bitwise copy construct.

enginePiston() [2/3]

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

Construct from components.

Definition at line 35 of file enginePiston.C.

enginePiston() [3/3]

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

Construct from dictionary.

Definition at line 54 of file enginePiston.C.

Member Function Documentation

operator=()

void operator= ( const enginePiston &  )

private

Disallow default bitwise assignment.

cs()

const coordinateSystem& cs ( ) const

inline

Return coordinate system.

Definition at line 120 of file enginePiston.H.

References enginePiston::csPtr_.

patchID()

const polyPatchID& patchID ( ) const

inline

Return ID of piston patch.

Definition at line 126 of file enginePiston.H.

References enginePiston::patchID_.

minLayer()

scalar minLayer ( ) const

inline

Definition at line 133 of file enginePiston.H.

References enginePiston::minLayer_.

maxLayer()

scalar maxLayer ( ) const

inline

Definition at line 138 of file enginePiston.H.

References enginePiston::maxLayer_.

writeDict()

void writeDict

(

Ostream &

os

)

const

Write dictionary.

Definition at line 80 of file enginePiston.C.

References token::BEGIN_BLOCK, token::END_BLOCK, token::END_STATEMENT, Foam::endl(), enginePiston::maxLayer_, enginePiston::minLayer_, DynamicID::name(), Foam::nl, and enginePiston::patchID_.

Here is the call graph for this function:

Field Documentation

mesh_

const polyMesh& mesh_

private

Reference to engine mesh.

Definition at line 58 of file enginePiston.H.

engineDB_

const engineTime& engineDB_

private

Reference to engine database.

Definition at line 61 of file enginePiston.H.

patchID_

polyPatchID patchID_

private

Piston patch.

Definition at line 64 of file enginePiston.H.

Referenced by enginePiston::patchID(), and enginePiston::writeDict().

csPtr_

autoPtr<coordinateSystem> csPtr_

private

Coordinate system.

Definition at line 67 of file enginePiston.H.

Referenced by enginePiston::cs().

minLayer_

const scalar minLayer_

private

Min layer thickness.

Definition at line 73 of file enginePiston.H.

Referenced by enginePiston::minLayer(), and enginePiston::writeDict().

maxLayer_

const scalar maxLayer_

private

Max layer thickness.

Definition at line 76 of file enginePiston.H.

Referenced by enginePiston::maxLayer(), and enginePiston::writeDict().

---

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

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