FreeFOAM The Cross-Platform CFD Toolkit
enginePiston Class Reference

Foam::enginePiston. More...

#include <engine/enginePiston.H>


Detailed Description

List of all members.

Public Member Functions

 enginePiston (const polyMesh &mesh, const word &pistonPatchName, const autoPtr< coordinateSystem > &pistonCS, const scalar minLayer, const scalar maxLayer)
 Construct from components.
 enginePiston (const polyMesh &mesh, const dictionary &dict)
 Construct from dictionary.
const coordinateSystemcs () const
 Return coordinate system.
const polyPatchIDpatchID () const
 Return ID of piston patch.
scalar minLayer () const
scalar maxLayer () const
void writeDict (Ostream &) const
 Write dictionary.

Constructor & Destructor Documentation

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 ( const polyMesh mesh,
const dictionary dict 
)

Construct from dictionary.

Definition at line 54 of file enginePiston.C.


Member Function Documentation

const coordinateSystem& cs ( ) const
inline

Return coordinate system.

Definition at line 121 of file enginePiston.H.

const polyPatchID& patchID ( ) const
inline

Return ID of piston patch.

Definition at line 127 of file enginePiston.H.

scalar minLayer ( ) const
inline

Definition at line 134 of file enginePiston.H.

scalar maxLayer ( ) const
inline

Definition at line 139 of file enginePiston.H.

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(), polyPatchID::name(), and Foam::nl.


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