crankConnectingRodMotion Class Reference

Crank and connecting-rod motion function for piston engines etc. More...

Inheritance diagram for crankConnectingRodMotion:
Collaboration diagram for crankConnectingRodMotion:

Public Member Functions

 TypeName ("crankConnectingRodMotion")
 
 crankConnectingRodMotion (const word &name, const unitConversions &units, const dictionary &dict)
 Construct from name and dictionary. More...
 
virtual tmp< Function1< scalar > > clone () const
 Construct and return a clone. More...
 
virtual ~crankConnectingRodMotion ()
 Destructor. More...
 
virtual scalar value (const scalar theta) const
 Return position for crank-angle theta in deg. More...
 
virtual tmp< Field< scalar > > value (const scalarField &) const
 Not implemented. More...
 
virtual scalar integral (const scalar, const scalar) const
 Not implemented. More...
 
virtual tmp< Field< scalar > > integral (const scalarField &, const scalarField &) const
 Not implemented. More...
 
virtual void write (Ostream &os, const unitConversions &units) const
 Write data to dictionary stream. More...
 
void operator= (const crankConnectingRodMotion &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from Function1< scalar >
 TypeName ("Function1")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, Function1, dictionary,(const word &name, const Function1s::unitConversions &units, const dictionary &dict),(name, units, dict))
 
 declareRunTimeSelectionTable (autoPtr, Function1, Istream,(const word &name, const Function1s::unitConversions &units, Istream &is),(name, units, is))
 
 Function1 (const word &name)
 Construct from name. More...
 
 Function1 (const Function1< scalar > &f1)
 Copy constructor. More...
 
virtual ~Function1 ()
 Destructor. More...
 
const wordname () const
 Return the name of the entry. More...
 
virtual bool constant () const
 Is this function guaranteed to be constant? More...
 
void operator= (const Function1< scalar > &)
 Assignment. More...
 
- Public Member Functions inherited from refCount
int count () const
 Return the current reference count. More...
 
bool unique () const
 Return true if the reference count is zero. More...
 
void operator++ ()
 Increment the reference count. More...
 
void operator++ (int)
 Increment the reference count. More...
 
void operator-- ()
 Decrement the reference count. More...
 
void operator-- (int)
 Decrement the reference count. More...
 
void operator= (const refCount &)=delete
 Disallow bitwise assignment. More...
 

Additional Inherited Members

- Public Types inherited from Function1< scalar >
typedef scalar returnType
 
- Static Public Member Functions inherited from Function1< scalar >
static autoPtr< Function1< scalar > > New (const word &name, const Function1s::unitConversions &units, const dictionary &dict)
 Select from dictionary. More...
 
static autoPtr< Function1< scalar > > New (const word &name, const unitConversion &xUnits, const unitConversion &valueUnits, const dictionary &dict)
 Select from dictionary. More...
 
static autoPtr< Function1< scalar > > New (const word &name, const Function1s::unitConversions &units, const word &Function1Type, Istream &is)
 Select from Istream. More...
 
static autoPtr< Function1< scalar > > New (const word &name, const unitConversion &xUnits, const unitConversion &valueUnits, const word &Function1Type, Istream &is)
 Select from Istream. More...
 
- Protected Member Functions inherited from refCount
 refCount ()
 Construct null initialising count to 0. More...
 
 refCount (const refCount &)=delete
 Disallow copy. More...
 
- Protected Attributes inherited from Function1< scalar >
const word name_
 Name of entry. More...
 

Detailed Description

Crank and connecting-rod motion function for piston engines etc.

value returns the current piston position as a function of the crank-angle in degrees.

Usage:

    <name>
    {
        type            crankConnectingRodMotion;

        conRodLength    0.2;
        stroke          0.12;
    }
See also
Foam::Function1
Source files

Definition at line 68 of file crankConnectingRodMotion.H.

Constructor & Destructor Documentation

◆ crankConnectingRodMotion()

crankConnectingRodMotion ( const word name,
const unitConversions units,
const dictionary dict 
)

Construct from name and dictionary.

Definition at line 41 of file crankConnectingRodMotion.C.

Referenced by crankConnectingRodMotion::clone().

Here is the caller graph for this function:

◆ ~crankConnectingRodMotion()

Destructor.

Definition at line 56 of file crankConnectingRodMotion.C.

Member Function Documentation

◆ TypeName()

TypeName ( "crankConnectingRodMotion"  )

◆ clone()

virtual tmp<Function1<scalar> > clone ( ) const
inlinevirtual

Construct and return a clone.

Implements Function1< scalar >.

Definition at line 98 of file crankConnectingRodMotion.H.

References crankConnectingRodMotion::crankConnectingRodMotion().

Here is the call graph for this function:

◆ value() [1/2]

Foam::scalar value ( const scalar  theta) const
inlinevirtual

Return position for crank-angle theta in deg.

Implements Function1< scalar >.

Definition at line 31 of file crankConnectingRodMotionI.H.

References Foam::cos(), Foam::degToRad(), Foam::sin(), Foam::sqr(), and Foam::sqrt().

Here is the call graph for this function:

◆ value() [2/2]

Foam::tmp< Foam::Field< Foam::scalar > > value ( const scalarField ) const
inlinevirtual

Not implemented.

Implements Function1< scalar >.

Definition at line 48 of file crankConnectingRodMotionI.H.

References NotImplemented.

◆ integral() [1/2]

Foam::scalar integral ( const  scalar,
const  scalar 
) const
inlinevirtual

Not implemented.

Implements Function1< scalar >.

Definition at line 58 of file crankConnectingRodMotionI.H.

References NotImplemented.

◆ integral() [2/2]

Foam::tmp< Foam::Field< Foam::scalar > > integral ( const scalarField ,
const scalarField  
) const
inlinevirtual

Not implemented.

Implements Function1< scalar >.

Definition at line 70 of file crankConnectingRodMotionI.H.

References NotImplemented.

◆ write()

void write ( Ostream os,
const unitConversions units 
) const
virtual

Write data to dictionary stream.

Implements Function1< scalar >.

Definition at line 62 of file crankConnectingRodMotion.C.

References Foam::Function1s::writeEntry().

Here is the call graph for this function:

◆ operator=()

void operator= ( const crankConnectingRodMotion )
delete

Disallow default bitwise assignment.


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