engine Class Reference

A userTime based on engine crank-angle degrees. More...

Inheritance diagram for engine:
Collaboration diagram for engine:

Public Member Functions

 TypeName ("engine")
 Runtime type information. More...
 
 engine (const dictionary &controlDict)
 Construct from controlDict. More...
 
virtual ~engine ()
 Destructor. More...
 
const dimensionedScalarrpm () const
 Return the RPM. More...
 
virtual scalar userTimeToTime (const scalar theta) const
 Return the theta crank-angle is s. More...
 
virtual scalar timeToUserTime (const scalar t) const
 Return the time t in crank-angle. More...
 
virtual word unit () const
 Return real-time unit (s) More...
 
virtual bool read (const dictionary &controlDict)
 Read the controlDict and set all the parameters. More...
 
- Public Member Functions inherited from userTime
 TypeName ("userTime")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, userTime, dictionary,(const dictionary &controlDict),(controlDict))
 Declare runtime constructor selection table. More...
 
 userTime (const dictionary &controlDict)
 Construct from controlDict. More...
 
virtual ~userTime ()
 Destructor. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from userTime
static autoPtr< userTimeNew (const dictionary &controlDict)
 
static const dictionarydict (const dictionary &controlDict)
 Return the userTime sub-dictionary. More...
 

Detailed Description

A userTime based on engine crank-angle degrees.

Source files

Definition at line 51 of file engineTime.H.

Constructor & Destructor Documentation

◆ engine()

engine ( const dictionary controlDict)

Construct from controlDict.

Definition at line 43 of file engineTime.C.

References engine::read().

Here is the call graph for this function:

◆ ~engine()

~engine ( )
virtual

Destructor.

Definition at line 54 of file engineTime.C.

Member Function Documentation

◆ TypeName()

TypeName ( "engine"  )

Runtime type information.

◆ rpm()

const Foam::dimensionedScalar & rpm ( ) const

Return the RPM.

Definition at line 60 of file engineTime.C.

References engine::userTimeToTime().

Here is the call graph for this function:

◆ userTimeToTime()

Foam::scalar userTimeToTime ( const scalar  theta) const
virtual

Return the theta crank-angle is s.

Implements userTime.

Definition at line 67 of file engineTime.C.

References dimensioned< Type >::value().

Referenced by engine::rpm().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ timeToUserTime()

Foam::scalar timeToUserTime ( const scalar  t) const
virtual

Return the time t in crank-angle.

Implements userTime.

Definition at line 75 of file engineTime.C.

References dimensioned< Type >::value().

Here is the call graph for this function:

◆ unit()

Foam::word unit ( ) const
virtual

Return real-time unit (s)

Implements userTime.

Definition at line 81 of file engineTime.C.

◆ read()

bool read ( const dictionary controlDict)
virtual

Read the controlDict and set all the parameters.

Implements userTime.

Definition at line 87 of file engineTime.C.

References userTime::dict(), and dimensioned< Type >::read().

Referenced by engine::engine().

Here is the call graph for this function:
Here is the caller graph for this function:

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