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 coordinateSystemcs () const
 Return coordinate system. More...
 
const polyPatchIDpatchID () 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

Definition at line 55 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 35 of file enginePiston.C.

References Foam::refCast().

Here is the call graph for this function:

◆ enginePiston() [2/2]

enginePiston ( const polyMesh mesh,
const dictionary dict 
)

Construct from dictionary.

Definition at line 53 of file enginePiston.C.

◆ ~enginePiston()

~enginePiston ( )
default

Destructor.

Member Function Documentation

◆ cs()

const coordinateSystem & cs ( ) const
inline

Return coordinate system.

Definition at line 123 of file enginePiston.H.

◆ patchID()

const polyPatchID & patchID ( ) const
inline

Return ID of piston patch.

Definition at line 129 of file enginePiston.H.

◆ minLayer()

scalar minLayer ( ) const
inline

Definition at line 136 of file enginePiston.H.

◆ maxLayer()

scalar maxLayer ( ) const
inline

Definition at line 141 of file enginePiston.H.

◆ writeDict()

void writeDict ( Ostream os) const

Write dictionary.

Definition at line 73 of file enginePiston.C.

References token::BEGIN_BLOCK, token::END_BLOCK, token::END_STATEMENT, Foam::endl(), Foam::nl, and os().

Here is the call graph for this function:

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