Manage time in terms of engine RPM and crank-angle. More...
Public Member Functions | |
| engineTime (const word &name, const fileName &rootPath, const fileName &caseName, const fileName &systemName="system", const fileName &constantName="constant", const fileName &dictName="engineGeometry") | |
| Construct from objectRegistry arguments. More... | |
| virtual | ~engineTime () |
| Destructor. More... | |
| scalar | degToTime (const scalar theta) const |
| Convert degrees to seconds (for given engine speed in RPM) More... | |
| scalar | timeToDeg (const scalar t) const |
| Convert seconds to degrees (for given engine speed in RPM) More... | |
| scalar | pistonPosition (const scalar theta) const |
| Calculate the piston position from the engine geometry. More... | |
| const IOdictionary & | engineDict () const |
| Return the engine geometry dictionary. More... | |
| const dimensionedScalar & | rpm () const |
| Return the engines current operating RPM. More... | |
| const dimensionedScalar & | conRodLength () const |
| Return the engines connecting-rod length. More... | |
| const dimensionedScalar & | bore () const |
| Return the engines bore. More... | |
| const dimensionedScalar & | stroke () const |
| Return the engines stroke. More... | |
| const dimensionedScalar & | clearance () const |
| Return the engines clearance-gap. More... | |
| scalar | theta () const |
| Return current crank-angle. More... | |
| scalar | thetaRevolution () const |
| Return current crank-angle translated to a single revolution. More... | |
| scalar | deltaTheta () const |
| Return crank-angle increment. More... | |
| dimensionedScalar | pistonPosition () const |
| Return current piston position. More... | |
| dimensionedScalar | pistonDisplacement () const |
| Return piston displacement for current time step. More... | |
| dimensionedScalar | pistonSpeed () const |
| Return piston speed for current time step. More... | |
| virtual scalar | userTimeToTime (const scalar theta) const |
| Convert the user-time (CA deg) to real-time (s). More... | |
| virtual scalar | timeToUserTime (const scalar t) const |
| Convert the real-time (s) into user-time (CA deg) More... | |
| virtual void | readDict () |
| Read the control dictionary and set the write controls etc. More... | |
| virtual bool | read () |
| Read the controlDict and set all the parameters. More... | |
 Public Member Functions inherited from Time | |
| TypeName ("time") | |
| Time (const word &name, const argList &args, const word &systemName="system", const word &constantName="constant") | |
| Construct given name of dictionary to read and argument list. More... | |
| Time (const word &name, const fileName &rootPath, const fileName &caseName, const word &systemName="system", const word &constantName="constant", const bool enableFunctionObjects=true) | |
| Construct given name of dictionary to read, rootPath and casePath. More... | |
| Time (const dictionary &dict, const fileName &rootPath, const fileName &caseName, const word &systemName="system", const word &constantName="constant", const bool enableFunctionObjects=true) | |
| Construct given dictionary, rootPath and casePath. More... | |
| Time (const fileName &rootPath, const fileName &caseName, const word &systemName="system", const word &constantName="constant", const bool enableFunctionObjects=true) | |
| Construct given endTime, rootPath and casePath. More... | |
| virtual | ~Time () |
| Destructor. More... | |
| const fileName & | rootPath () const |
| Return root path. More... | |
| const fileName & | caseName () const |
| Return case name. More... | |
| fileName | path () const |
| Return path. More... | |
| const dictionary & | controlDict () const |
| virtual const fileName & | dbDir () const |
| Local directory path of this objectRegistry relative to the time. More... | |
| fileName | timePath () const |
| Return current time path. More... | |
| IOstream::streamFormat | writeFormat () const |
| Default write format. More... | |
| IOstream::versionNumber | writeVersion () const |
| Default write version number. More... | |
| IOstream::compressionType | writeCompression () const |
| Default write compression. More... | |
| const word & | graphFormat () const |
| Default graph format. More... | |
| const Switch & | runTimeModifiable () const |
| Supports re-reading. More... | |
| void | readModifiedObjects () |
| Read the objects that have been modified. More... | |
| label | addWatch (const fileName &) const |
| Add watching of a file. Returns handle. More... | |
| bool | removeWatch (const label) const |
| Remove watch on a file (using handle) More... | |
| const fileName & | getFile (const label) const |
| Get name of file being watched (using handle) More... | |
| fileMonitor::fileState | getState (const label) const |
| Get current state of file (using handle) More... | |
| void | setUnmodified (const label) const |
| Set current state of file (using handle) to unmodified. More... | |
| word | findInstance (const fileName &dir, const word &name=word::null, const IOobject::readOption rOpt=IOobject::MUST_READ, const word &stopInstance=word::null) const |
| Return the location of "dir" containing the file "name". More... | |
| instantList | times () const |
| Search the case for valid time directories. More... | |
| word | findInstancePath (const instant &) const |
| Search the case for the time directory path. More... | |
| instant | findClosestTime (const scalar) const |
| Search the case for the time closest to the given time. More... | |
| virtual bool | writeTimeDict () const |
| Write time dictionary to the <time>/uniform directory. More... | |
| virtual bool | writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType) const |
| Write using given format, version and compression. More... | |
| bool | writeNow () |
| Write the objects now (not at end of iteration) and continue. More... | |
| bool | writeAndEnd () |
| Write the objects now (not at end of iteration) and end the run. More... | |
| void | writeOnce () |
| Write the objects once (one shot) and continue the run. More... | |
| virtual word | timeName () const |
| Return current time name. More... | |
| virtual label | startTimeIndex () const |
| Return start time index. More... | |
| virtual dimensionedScalar | startTime () const |
| Return start time. More... | |
| virtual dimensionedScalar | endTime () const |
| Return end time. More... | |
| const functionObjectList & | functionObjects () const |
| Return the list of function objects. More... | |
| const dlLibraryTable & | libs () const |
| External access to the loaded libraries. More... | |
| dlLibraryTable & | libs () |
| External access to the loaded libraries. More... | |
| bool | subCycling () const |
| Return true if time currently being sub-cycled, otherwise false. More... | |
| const TimeState & | prevTimeState () const |
| Return previous TimeState if time is being sub-cycled. More... | |
| virtual bool | run () const |
| Return true if run should continue,. More... | |
| virtual bool | loop () |
| Return true if run should continue and if so increment time. More... | |
| virtual bool | end () const |
| Return true if end of run,. More... | |
| virtual bool | stopAt (const stopAtControls) const |
| Adjust the current stopAtControl. Note that this value. More... | |
| virtual void | setTime (const Time &) |
| Reset the time and time-index to those of the given time. More... | |
| virtual void | setTime (const instant &, const label newIndex) |
| Reset the time and time-index. More... | |
| virtual void | setTime (const dimensionedScalar &, const label newIndex) |
| Reset the time and time-index. More... | |
| virtual void | setTime (const scalar, const label newIndex) |
| Reset the time and time-index. More... | |
| virtual void | setEndTime (const dimensionedScalar &) |
| Reset end time. More... | |
| virtual void | setEndTime (const scalar) |
| Reset end time. More... | |
| virtual void | setDeltaT (const dimensionedScalar &, const bool adjustDeltaT=true) |
| Reset time step. More... | |
| virtual void | setDeltaT (const scalar, const bool adjustDeltaT=true) |
| Reset time step. More... | |
| virtual TimeState | subCycle (const label nSubCycles) |
| Set time to sub-cycle for the given number of steps. More... | |
| virtual void | endSubCycle () |
| Reset time after sub-cycling back to previous TimeState. More... | |
| functionObjectList & | functionObjects () |
| Return non-const access to the list of function objects. More... | |
| virtual Time & | operator+= (const dimensionedScalar &) |
| Set deltaT to that specified and increment time via operator++() More... | |
| virtual Time & | operator+= (const scalar) |
| Set deltaT to that specified and increment time via operator++() More... | |
| virtual Time & | operator++ () |
| Prefix increment,. More... | |
| virtual Time & | operator++ (int) |
| Postfix increment, this is identical to the prefix increment. More... | |
| Public Member Functions inherited from clock | |
| clock () | |
| Null constructor which stores the start time. More... | |
| time_t | elapsedClockTime () const |
| Returns wall-clock time from clock instantiation. More... | |
| time_t | clockTimeIncrement () const |
| Returns wall-clock time from last call of clockTimeIncrement() More... | |
| Public Member Functions inherited from cpuTime | |
| cpuTime () | |
| Construct with the current clock time. More... | |
| double | elapsedCpuTime () const |
| Return CPU time (in seconds) from the start. More... | |
| double | cpuTimeIncrement () const |
| Return CPU time (in seconds) since last call to cpuTimeIncrement() More... | |
| Public Member Functions inherited from TimePaths | |
| TimePaths (const fileName &rootPath, const fileName &caseName, const word &systemName, const word &constantName) | |
| Construct given database name, rootPath and casePath. More... | |
| TimePaths (const bool processorCase, const fileName &rootPath, const fileName &globalCaseName, const fileName &caseName, const word &systemName, const word &constantName) | |
| Construct given database name, rootPath and casePath. More... | |
| bool | processorCase () const |
| Return true if this is a processor case. More... | |
| const fileName & | rootPath () const |
| Return root path. More... | |
| const fileName & | globalCaseName () const |
| Return global case name. More... | |
| const fileName & | caseName () const |
| Return case name. More... | |
| const word & | system () const |
| Return system name. More... | |
| fileName | caseSystem () const |
| Return system name for the case. More... | |
| const word & | constant () const |
| Return constant name. More... | |
| fileName | caseConstant () const |
| Return constant name for the case. More... | |
| fileName | path () const |
| Return path. More... | |
| fileName | systemPath () const |
| Return system path. More... | |
| fileName | constantPath () const |
| Return constant path. More... | |
| Public Member Functions inherited from objectRegistry | |
| TypeName ("objectRegistry") | |
| Declare type name for this IOobject. More... | |
| objectRegistry (const Time &db, const label nIoObjects=128) | |
| Construct the time objectRegistry given an initial estimate. More... | |
| objectRegistry (const IOobject &io, const label nIoObjects=128) | |
| Construct a sub-registry given an IObject to describe the registry. More... | |
| virtual | ~objectRegistry () |
| Destructor. More... | |
| const Time & | time () const |
| Return time. More... | |
| const objectRegistry & | parent () const |
| Return the parent objectRegistry. More... | |
| wordList | names () const |
| Return the list of names of the IOobjects. More... | |
| wordList | sortedNames () const |
| Return the sorted list of names of the IOobjects. More... | |
| wordList | names (const word &className) const |
| Return the list of names of IOobjects of given class name. More... | |
| wordList | sortedNames (const word &className) const |
| Return the sorted list of names of IOobjects of given class name. More... | |
| template<class Type > | |
| wordList | names () const |
| Return the list of names of the IOobjects of given type. More... | |
| template<class Type > | |
| wordList | names (const wordRe &name) const |
| Return the list of objects whose name matches the input regExp. More... | |
| template<class Type > | |
| wordList | names (const wordReList &name) const |
| Return the list of objects whose name matches the input regExp. More... | |
| const objectRegistry & | subRegistry (const word &name, const bool forceCreate=false) const |
| Lookup and return a const sub-objectRegistry. Optionally create. More... | |
| template<class Type > | |
| HashTable< const Type * > | lookupClass (const bool strict=false) const |
| Lookup and return all objects of the given Type. More... | |
| template<class Type > | |
| HashTable< Type * > | lookupClass (const bool strict=false) |
| Lookup and return all objects of the given Type. More... | |
| template<class Type > | |
| bool | foundObject (const word &name) const |
| Is the named Type found? More... | |
| template<class Type > | |
| const Type & | lookupObject (const word &name) const |
| Lookup and return the object of the given Type. More... | |
| label | getEvent () const |
| Return new event number. More... | |
| virtual void | rename (const word &newName) |
| Rename. More... | |
| bool | checkIn (regIOobject &) const |
| Add an regIOobject to registry. More... | |
| bool | checkOut (regIOobject &) const |
| Remove an regIOobject from registry. More... | |
| virtual bool | modified () const |
| Return true if any of the object's files have been modified. More... | |
| void | readModifiedObjects () |
| Read the objects that have been modified. More... | |
| virtual bool | readIfModified () |
| Read object if modified. More... | |
| virtual bool | writeData (Ostream &) const |
| writeData function required by regIOobject but not used More... | |
| template<class Type > | |
| Foam::wordList | names () const |
| template<class Type > | |
| Foam::wordList | names (const wordRe &name) const |
| template<class Type > | |
| Foam::wordList | names (const wordReList &patterns) const |
| template<class Type > | |
| Foam::HashTable< const Type * > | lookupClass (const bool strict) const |
| template<class Type > | |
| Foam::HashTable< Type * > | lookupClass (const bool strict) |
| Public Member Functions inherited from regIOobject | |
| TypeName ("regIOobject") | |
| Runtime type information. More... | |
| regIOobject (const IOobject &, const bool isTime=false) | |
| Construct from IOobject. Optional flag for if IOobject is the. More... | |
| regIOobject (const regIOobject &) | |
| Construct as copy. More... | |
| regIOobject (const regIOobject &, bool registerCopy) | |
| Construct as copy, transferring registry registration to copy. More... | |
| regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
| Construct as copy with new name, transfering registry registration. More... | |
| regIOobject (const IOobject &, const regIOobject &) | |
| Construct as copy with new IO parameters. More... | |
| virtual | ~regIOobject () |
| Destructor. More... | |
| bool | checkIn () |
| Add object to registry. More... | |
| bool | checkOut () |
| Remove object from registry. More... | |
| bool | ownedByRegistry () const |
| Is this object owned by the registry? More... | |
| void | store () |
| Transfer ownership of this object to its registry. More... | |
| void | release () |
| Release ownership of this object from its registry. More... | |
| label | eventNo () const |
| Event number at last update. More... | |
| label & | eventNo () |
| Event number at last update. More... | |
| bool | upToDate (const regIOobject &) const |
| Return true if up-to-date with respect to given object. More... | |
| bool | upToDate (const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More... | |
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More... | |
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More... | |
| void | setUpToDate () |
| Set up to date (obviously) More... | |
| Istream & | readStream (const word &) |
| Return Istream and check object type against that given. More... | |
| void | close () |
| Close Istream. More... | |
| virtual bool | readData (Istream &) |
| Virtual readData function. More... | |
| label | watchIndex () const |
| Return file-monitoring handle. More... | |
| label & | watchIndex () |
| Return file-monitoring handle. More... | |
| virtual bool | write () const |
| Write using setting from DB. More... | |
| void | operator= (const IOobject &) |
| Public Member Functions inherited from IOobject | |
| TypeName ("IOobject") | |
| Runtime type information. More... | |
| IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
| Construct from name, instance, registry, io options. More... | |
| IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
| Construct from name, instance, local, registry, io options. More... | |
| IOobject (const fileName &path, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
| Construct from path, registry, io options. More... | |
| Foam::autoPtr< IOobject > | clone () const |
| Clone. More... | |
| virtual | ~IOobject () |
| Destructor. More... | |
| const Time & | time () const |
| Return time. More... | |
| const objectRegistry & | db () const |
| Return the local objectRegistry. More... | |
| const word & | name () const |
| Return name. More... | |
| const word & | headerClassName () const |
| Return name of the class name read from header. More... | |
| string & | note () |
| Return non-constant access to the optional note. More... | |
| const string & | note () const |
| Return the optional note. More... | |
| bool & | registerObject () |
| Register object created from this IOobject with registry if true. More... | |
| bool | registerObject () const |
| Register object created from this IOobject with registry if true. More... | |
| readOption | readOpt () const |
| readOption & | readOpt () |
| writeOption | writeOpt () const |
| writeOption & | writeOpt () |
| word | group () const |
| Return group (extension part of name) More... | |
| word | member () const |
| Return member (name without the extension) More... | |
| const fileName & | rootPath () const |
| const fileName & | caseName () const |
| const fileName & | instance () const |
| fileName & | instance () |
| const fileName & | local () const |
| fileName | path () const |
| Return complete path. More... | |
| fileName | path (const word &instance, const fileName &local="") const |
| Return complete path with alternative instance and local. More... | |
| fileName | objectPath () const |
| Return complete path + object name. More... | |
| fileName | filePath () const |
| Return complete path + object name if the file exists. More... | |
| bool | readHeader (Istream &) |
| Read header. More... | |
| bool | headerOk () |
| Read and check header info. More... | |
| bool | writeHeader (Ostream &) const |
| Write header. More... | |
| bool | writeHeader (Ostream &, const word &objectType) const |
| Write header. Allow override of type. More... | |
| bool | good () const |
| bool | bad () const |
| InfoProxy< IOobject > | info () const |
| Return info proxy. More... | |
| void | operator= (const IOobject &) |
| template<class Name > | |
| Foam::word | groupName (Name name, const word &group) |
| Public Member Functions inherited from HashTable< regIOobject * > | |
| bool | set (const word &, const regIOobject *&newElmt) |
| Assign a new hashedEntry, overwriting existing entries. More... | |
| HashTable (const label size=128) | |
| Construct given initial table size. More... | |
| HashTable (Istream &, const label size=128) | |
| Construct from Istream. More... | |
| HashTable (const HashTable< regIOobject *, word, string::hash > &) | |
| Construct as copy. More... | |
| HashTable (const Xfer< HashTable< regIOobject *, word, string::hash >> &) | |
| Construct by transferring the parameter contents. More... | |
| ~HashTable () | |
| Destructor. More... | |
| label | capacity () const |
| The size of the underlying table. More... | |
| label | size () const |
| Return number of elements in table. More... | |
| bool | empty () const |
| Return true if the hash table is empty. More... | |
| bool | found (const word &) const |
| Return true if hashedEntry is found in table. More... | |
| iterator | find (const word &) |
| Find and return an iterator set at the hashedEntry. More... | |
| const_iterator | find (const word &) const |
| Find and return an const_iterator set at the hashedEntry. More... | |
| List< word > | toc () const |
| Return the table of contents. More... | |
| List< word > | sortedToc () const |
| Return the table of contents as a sorted list. More... | |
| Ostream & | printInfo (Ostream &) const |
| Print information. More... | |
| bool | insert (const word &, const regIOobject *&newElmt) |
| Insert a new hashedEntry. More... | |
| bool | erase (const iterator &) |
| Erase a hashedEntry specified by given iterator. More... | |
| bool | erase (const word &) |
| Erase a hashedEntry specified by the given key. More... | |
| label | erase (const UList< word > &) |
| Remove entries given by the listed keys from this HashTable. More... | |
| label | erase (const HashTable< AnyType, word, AnyHash > &) |
| Remove entries given by the given keys from this HashTable. More... | |
| void | resize (const label newSize) |
| Resize the hash table for efficiency. More... | |
| void | clear () |
| Clear all entries from table. More... | |
| void | clearStorage () |
| Clear the table entries and the table itself. More... | |
| void | shrink () |
| Shrink the allocated table to approx. twice number of elements. More... | |
| void | transfer (HashTable< regIOobject *, word, string::hash > &) |
| Transfer the contents of the argument table into this table. More... | |
| Xfer< HashTable< regIOobject *, word, string::hash > > | xfer () |
| Transfer contents to the Xfer container. More... | |
| regIOobject *& | operator[] (const word &) |
| Find and return a hashedEntry. More... | |
| const regIOobject *& | operator[] (const word &) const |
| Find and return a hashedEntry. More... | |
| regIOobject *& | operator() (const word &) |
| Find and return a hashedEntry, create it null if not present. More... | |
| void | operator= (const HashTable< regIOobject *, word, string::hash > &) |
| Assignment. More... | |
| bool | operator== (const HashTable< regIOobject *, word, string::hash > &) const |
| Equality. Hash tables are equal if the keys and values are equal. More... | |
| bool | operator!= (const HashTable< regIOobject *, word, string::hash > &) const |
| The opposite of the equality operation. Takes linear time. More... | |
| iterator | begin () |
| Iterator set to the beginning of the HashTable. More... | |
| const_iterator | begin () const |
| const_iterator set to the beginning of the HashTable More... | |
| const_iterator | cbegin () const |
| const_iterator set to the beginning of the HashTable More... | |
| Public Member Functions inherited from HashTableCore | |
| HashTableCore () | |
| Construct null. More... | |
| ClassName ("HashTable") | |
| Define template name and debug. More... | |
| Public Member Functions inherited from TimeState | |
| TimeState () | |
| virtual | ~TimeState () |
| Destructor. More... | |
| scalar | timeOutputValue () const |
| Return current time value. More... | |
| label | timeIndex () const |
| Return current time index. More... | |
| scalar | deltaTValue () const |
| Return time step value. More... | |
| scalar | deltaT0Value () const |
| Return old time step value. More... | |
| dimensionedScalar | deltaT () const |
| Return time step. More... | |
| dimensionedScalar | deltaT0 () const |
| Return old time step. More... | |
| bool | writeTime () const |
| Return true if this is a write time. More... | |
| bool | outputTime () const |
| Return true if this is a write time. More... | |
| Public Member Functions inherited from dimensioned< scalar > | |
| dimensioned (const word &, const dimensionSet &, const scalar) | |
| Construct given a name, a value and its dimensionSet. More... | |
| dimensioned (const word &, const dimensioned< scalar > &) | |
| Construct from a dimensioned<Type> changing the name. More... | |
| dimensioned (const scalar &t) | |
| Construct given a value (creates dimensionless value). More... | |
| dimensioned (Istream &) | |
| Construct from Istream. More... | |
| dimensioned (const word &, Istream &) | |
| Construct from an Istream with a given name. More... | |
| dimensioned (const word &, const dimensionSet &, Istream &) | |
| Construct from an Istream with a given name and dimensions. More... | |
| dimensioned (const word &, const dimensionSet &, const dictionary &) | |
| Construct from dictionary lookup with a given name and dimensions. More... | |
| dimensioned () | |
| Null constructor. More... | |
| const word & | name () const |
| Return const reference to name. More... | |
| word & | name () |
| Return non-const reference to name. More... | |
| const dimensionSet & | dimensions () const |
| Return const reference to dimensions. More... | |
| dimensionSet & | dimensions () |
| Return non-const reference to dimensions. More... | |
| const scalar & | value () const |
| Return const reference to value. More... | |
| scalar & | value () |
| Return non-const reference to value. More... | |
| dimensioned< cmptType > | component (const direction) const |
| Return a component as a dimensioned<cmptType> More... | |
| void | replace (const direction, const dimensioned< cmptType > &) |
| Return a component with a dimensioned<cmptType> More... | |
| dimensioned< scalar > | T () const |
| Return transpose. More... | |
| void | read (const dictionary &) |
| Update the value of dimensioned<Type> More... | |
| Istream & | read (Istream &is, const dictionary &) |
| Read value from stream and units from dictionary. More... | |
| Istream & | read (Istream &is, const HashTable< dimensionedScalar > &) |
| Read value from stream and units from table. More... | |
| Istream & | read (Istream &is) |
| Read value from stream and units from system table. More... | |
| bool | readIfPresent (const dictionary &) |
| Update the value of dimensioned<Type> if found in the dictionary. More... | |
| dimensioned< cmptType > | operator[] (const direction) const |
| Return a component as a dimensioned<cmptType> More... | |
| void | operator+= (const dimensioned< scalar > &) |
| void | operator-= (const dimensioned< scalar > &) |
| void | operator*= (const scalar) |
| void | operator/= (const scalar) |
Additional Inherited Members | |
| Public Types inherited from Time | |
| enum | writeControls { wcTimeStep, wcRunTime, wcAdjustableRunTime, wcClockTime, wcCpuTime } |
| Write control options. More... | |
| enum | stopAtControls { saEndTime, saNoWriteNow, saWriteNow, saNextWrite } |
| Stop-run control options. More... | |
| enum | fmtflags { general = 0, fixed = ios_base::fixed, scientific = ios_base::scientific } |
| Supported time directory name formats. More... | |
| Public Types inherited from regIOobject | |
| enum | fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster } |
| Types of communications. More... | |
| Public Types inherited from IOobject | |
| enum | objectState { GOOD, BAD } |
| Enumeration defining the valid states of an IOobject. More... | |
| enum | readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ } |
| Enumeration defining the read options. More... | |
| enum | writeOption { AUTO_WRITE = 0, NO_WRITE = 1 } |
| Enumeration defining the write options. More... | |
| Public Types inherited from HashTable< regIOobject * > | |
| typedef regIOobject * | value_type |
| Type of values the HashTable contains. More... | |
| typedef regIOobject *& | reference |
| Type that can be used for storing into HashTable::value_type. More... | |
| typedef const regIOobject *& | const_reference |
| Type that can be used for storing into constant. More... | |
| typedef label | size_type |
| The type that can represent the size of a HashTable. More... | |
| Public Types inherited from dimensioned< scalar > | |
| typedef pTraits< scalar >::cmptType | cmptType |
| Component type. More... | |
| Static Public Member Functions inherited from Time | |
| static label | findClosestTimeIndex (const instantList &, const scalar, const word &constantName="constant") |
| Search instantList for the time index closest to the given time. More... | |
| static word | timeName (const scalar, const int precision=precision_) |
| Return time name of given scalar time. More... | |
| static instantList | findTimes (const fileName &, const word &constantName="constant") |
| Search a given directory for valid time directories. More... | |
| Static Public Member Functions inherited from clock | |
| static time_t | getTime () |
| Get the current clock time in seconds. More... | |
| static const struct tm | rawDate () |
| Return the current wall-clock date as a raw struct. More... | |
| static string | dateTime () |
| Return the current wall-clock date/time as a string. More... | |
| static string | date () |
| Return the current wall-clock date as a string. More... | |
| static string | clockTime () |
| Return the current wall-clock time as a string. More... | |
| Static Public Member Functions inherited from regIOobject | |
| template<class Type > | |
| static Type & | store (Type *) |
| Transfer ownership of the given object pointer to its registry. More... | |
| template<class Type > | |
| static Type & | store (autoPtr< Type > &) |
| Transfer ownership of the given object pointer to its registry. More... | |
| Static Public Member Functions inherited from IOobject | |
| static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
| Split path into instance, local, name components. More... | |
| template<class Name > | |
| static word | groupName (Name name, const word &group) |
| template<class Stream > | |
| static Stream & | writeBanner (Stream &os, bool noHint=false) |
| Write the standard OpenFOAM file/dictionary banner. More... | |
| template<class Stream > | |
| static Stream & | writeDivider (Stream &os) |
| Write the standard file section divider. More... | |
| template<class Stream > | |
| static Stream & | writeEndDivider (Stream &os) |
| Write the standard end file divider. More... | |
| Static Public Member Functions inherited from HashTableCore | |
| static label | canonicalSize (const label) |
| Return a canonical (power-of-two) size. More... | |
| static iteratorEnd | cend () |
| iteratorEnd set to beyond the end of any HashTable More... | |
| static iteratorEnd | end () |
| iteratorEnd set to beyond the end of any HashTable More... | |
| Static Public Member Functions inherited from dimensioned< scalar > | |
| static dimensioned< scalar > | lookupOrDefault (const word &, const dictionary &, const dimensionSet &dims=dimless, const scalar &defaultValue=pTraits< scalar >::zero) |
| Construct from dictionary, with default dimensions and value. More... | |
| static dimensioned< scalar > | lookupOrDefault (const word &, const dictionary &, const scalar &defaultValue=pTraits< scalar >::zero) |
| Construct from dictionary dimensionless with value. More... | |
| static dimensioned< scalar > | lookupOrAddToDict (const word &, dictionary &, const dimensionSet &dims=dimless, const scalar &defaultValue=pTraits< scalar >::zero) |
| Construct from dictionary, with default value. More... | |
| static dimensioned< scalar > | lookupOrAddToDict (const word &, dictionary &, const scalar &defaultValue=pTraits< scalar >::zero) |
| Construct from dictionary, dimensionless with default value. More... | |
| Static Public Attributes inherited from Time | |
| static word | controlDictName |
| The default control dictionary name (normally "controlDict") More... | |
| Static Public Attributes inherited from regIOobject | |
| static const NamedEnum< fileCheckTypes, 4 > | fileCheckTypesNames |
| static int | fileModificationSkew |
| static fileCheckTypes | fileModificationChecking |
| Static Public Attributes inherited from HashTableCore | |
| static const label | maxTableSize |
| Maximum allowable table size. More... | |
| Protected Member Functions inherited from Time | |
| void | adjustDeltaT () |
| Adjust the time step so that writing occurs at the specified time. More... | |
| void | setControls () |
| Set the controls from the current controlDict. More... | |
| Protected Member Functions inherited from IOobject | |
| Istream * | objectStream () |
| Construct and return an IFstream for the object. More... | |
| Istream * | objectStream (const fileName &) |
| Construct and return an IFstream for the object given the. More... | |
| void | setBad (const string &) |
| Set the object state to bad. More... | |
| Protected Attributes inherited from Time | |
| label | startTimeIndex_ |
| scalar | startTime_ |
| scalar | endTime_ |
| stopAtControls | stopAt_ |
| writeControls | writeControl_ |
| scalar | writeInterval_ |
| label | purgeWrite_ |
| FIFOStack< word > | previousWriteTimes_ |
| bool | writeOnce_ |
| bool | subCycling_ |
| Is the time currently being sub-cycled? More... | |
| autoPtr< TimeState > | prevTimeState_ |
| If time is being sub-cycled this is the previous TimeState. More... | |
| sigWriteNow | sigWriteNow_ |
| Enable one-shot writing upon signal. More... | |
| sigStopAtWriteNow | sigStopAtWriteNow_ |
| Enable write and clean exit upon signal. More... | |
| Protected Attributes inherited from TimeState | |
| label | timeIndex_ |
| scalar | deltaT_ |
| scalar | deltaTSave_ |
| scalar | deltaT0_ |
| bool | deltaTchanged_ |
| label | writeTimeIndex_ |
| bool | writeTime_ |
| Static Protected Attributes inherited from Time | |
| static const NamedEnum< stopAtControls, 4 > | stopAtControlNames_ |
| static const NamedEnum< writeControls, 5 > | writeControlNames_ |
| static fmtflags | format_ |
| Time directory name format. More... | |
| static int | precision_ |
| Time directory name precision. More... | |
| static const int | maxPrecision_ |
| Maximum time directory name precision. More... | |
| Static Protected Attributes inherited from regIOobject | |
| static bool | masterOnlyReading = false |
| To flag master-only reading of objects. More... | |
Manage time in terms of engine RPM and crank-angle.
When engineTime is in effect, the userTime is reported in degrees crank-angle instead of in seconds. The RPM to be used is specified in constant/engineGeometry. If only a time conversion is required, the geometric engine parameters can be dropped or set to zero.
For example,
rpm rpm [0 0 -1 0 0] 2000;
conRodLength conRodLength [0 1 0 0 0] 0.0;
bore bore [0 1 0 0 0] 0.0;
stroke stroke [0 1 0 0 0] 0.0;
clearance clearance [0 1 0 0 0] 0.0;
Definition at line 68 of file engineTime.H.
| engineTime | ( | const word & | name, |
| const fileName & | rootPath, | ||
| const fileName & | caseName, | ||
| const fileName & | systemName = "system", |
||
| const fileName & | constantName = "constant", |
||
| const fileName & | dictName = "engineGeometry" |
||
| ) |
Construct from objectRegistry arguments.
Definition at line 50 of file engineTime.C.
References engineTime::degToTime(), TimeState::deltaT0_, TimeState::deltaT_, TimeState::deltaTSave_, dictionary::readIfPresent(), Time::startTime_, and dimensioned< scalar >::value().
|
inlinevirtual |
Destructor.
Definition at line 113 of file engineTime.H.
References engineTime::degToTime(), engineTime::pistonPosition(), engineTime::theta(), and engineTime::timeToDeg().
| Foam::scalar degToTime | ( | const scalar | theta | ) | const |
Convert degrees to seconds (for given engine speed in RPM)
Definition at line 125 of file engineTime.C.
References dimensioned< Type >::value().
Referenced by engineTime::engineTime(), engineTime::userTimeToTime(), and engineTime::~engineTime().
| Foam::scalar timeToDeg | ( | const scalar | t | ) | const |
Convert seconds to degrees (for given engine speed in RPM)
Definition at line 132 of file engineTime.C.
References dimensioned< Type >::value().
Referenced by engineTime::deltaTheta(), engineTime::theta(), engineTime::timeToUserTime(), and engineTime::~engineTime().
| Foam::scalar pistonPosition | ( | const scalar | theta | ) | const |
Calculate the piston position from the engine geometry.
and given crank angle.
Definition at line 171 of file engineTime.C.
References Foam::cos(), Foam::degToRad(), Foam::sin(), Foam::sqr(), Foam::sqrt(), and dimensioned< Type >::value().
|
inline |
Return the engine geometry dictionary.
Definition at line 135 of file engineTime.H.
Referenced by fvMotionSolverEngineMesh::fvMotionSolverEngineMesh(), and layeredEngineMesh::layeredEngineMesh().
|
inline |
Return the engines current operating RPM.
Definition at line 141 of file engineTime.H.
|
inline |
Return the engines connecting-rod length.
Definition at line 147 of file engineTime.H.
|
inline |
Return the engines bore.
Definition at line 153 of file engineTime.H.
|
inline |
Return the engines stroke.
Definition at line 159 of file engineTime.H.
|
inline |
Return the engines clearance-gap.
Definition at line 165 of file engineTime.H.
References engineTime::deltaTheta(), engineTime::pistonDisplacement(), engineTime::pistonPosition(), engineTime::pistonSpeed(), engineTime::read(), engineTime::readDict(), engineTime::theta(), engineTime::thetaRevolution(), engineTime::timeToUserTime(), and engineTime::userTimeToTime().
| Foam::scalar theta | ( | ) | const |
Return current crank-angle.
Definition at line 139 of file engineTime.C.
References engineTime::timeToDeg(), and dimensioned< scalar >::value().
Referenced by engineTime::clearance(), engineValve::curLift(), engineValve::curVelocity(), engineValve::isOpen(), engineTime::pistonDisplacement(), engineTime::pistonPosition(), engineTime::thetaRevolution(), and engineTime::~engineTime().
| Foam::scalar thetaRevolution | ( | ) | const |
Return current crank-angle translated to a single revolution.
(value between -180 and 180 with 0 = top dead centre)
Definition at line 147 of file engineTime.C.
References engineTime::theta().
Referenced by engineTime::clearance().
| Foam::scalar deltaTheta | ( | ) | const |
Return crank-angle increment.
Definition at line 165 of file engineTime.C.
References TimeState::deltaTValue(), and engineTime::timeToDeg().
Referenced by engineTime::clearance(), engineValve::curVelocity(), and engineTime::pistonDisplacement().
| Foam::dimensionedScalar pistonPosition | ( | ) | const |
Return current piston position.
Definition at line 190 of file engineTime.C.
References Foam::dimLength, and engineTime::theta().
Referenced by engineTime::clearance(), engineTime::pistonDisplacement(), and engineTime::~engineTime().
| Foam::dimensionedScalar pistonDisplacement | ( | ) | const |
Return piston displacement for current time step.
Definition at line 201 of file engineTime.C.
References engineTime::deltaTheta(), Foam::dimLength, engineTime::pistonPosition(), engineTime::theta(), and dimensioned< scalar >::value().
Referenced by engineTime::clearance(), layeredEngineMesh::move(), fvMotionSolverEngineMesh::move(), and engineTime::pistonSpeed().
| Foam::dimensionedScalar pistonSpeed | ( | ) | const |
Return piston speed for current time step.
Definition at line 212 of file engineTime.C.
References TimeState::deltaTValue(), Foam::dimVelocity, engineTime::pistonDisplacement(), and dimensioned< scalar >::value().
Referenced by engineTime::clearance().
|
virtual |
Convert the user-time (CA deg) to real-time (s).
Reimplemented from TimeState.
Definition at line 223 of file engineTime.C.
References engineTime::degToTime().
Referenced by engineTime::clearance().
|
virtual |
Convert the real-time (s) into user-time (CA deg)
Reimplemented from TimeState.
Definition at line 229 of file engineTime.C.
References engineTime::timeToDeg().
Referenced by engineTime::clearance().
|
virtual |
Read the control dictionary and set the write controls etc.
Reimplemented from Time.
Definition at line 103 of file engineTime.C.
References Time::readDict().
Referenced by engineTime::clearance().
|
virtual |
Read the controlDict and set all the parameters.
Reimplemented from Time.
Definition at line 111 of file engineTime.C.
References Time::read().
Referenced by engineTime::clearance().
1.8.11