Convergence control based on the 6-DoF motion state. More...
Public Member Functions | |
TypeName ("sixDoFRigidBodyControl") | |
Runtime type information. More... | |
sixDoFRigidBodyControl (const word &name, const Time &runTime, const dictionary &dict) | |
Construct from Time and dictionary. More... | |
sixDoFRigidBodyControl (const sixDoFRigidBodyControl &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual | ~sixDoFRigidBodyControl () |
Destructor. More... | |
virtual bool | read (const dictionary &) |
Read the sixDoFRigidBodyControl data. More... | |
virtual bool | execute () |
Execute, currently does nothing. More... | |
void | operator= (const sixDoFRigidBodyControl &)=delete |
Disallow default bitwise assignment. More... | |
Public Member Functions inherited from sixDoFRigidBodyState | |
TypeName ("sixDoFRigidBodyState") | |
Runtime type information. More... | |
sixDoFRigidBodyState (const word &name, const Time &runTime, const dictionary &dict) | |
Construct from Time and dictionary. More... | |
sixDoFRigidBodyState (const sixDoFRigidBodyState &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual | ~sixDoFRigidBodyState () |
Destructor. More... | |
vector | velocity () const |
Return the current body velocity. More... | |
vector | angularVelocity () const |
Return the current body angular velocity. More... | |
virtual bool | write () |
Write the sixDoFRigidBodyState. More... | |
void | operator= (const sixDoFRigidBodyState &)=delete |
Disallow default bitwise assignment. More... | |
Public Member Functions inherited from fvMeshFunctionObject | |
TypeName ("fvMeshFunctionObject") | |
Runtime type information. More... | |
fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict) | |
Construct from Time and dictionary. More... | |
fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict) | |
Construct from the region objectRegistry and dictionary. More... | |
fvMeshFunctionObject (const fvMeshFunctionObject &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual | ~fvMeshFunctionObject () |
Destructor. More... | |
void | operator= (const fvMeshFunctionObject &)=delete |
Disallow default bitwise assignment. More... | |
Public Member Functions inherited from regionFunctionObject | |
TypeName ("regionFunctionObject") | |
Runtime type information. More... | |
regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict) | |
Construct from Time and dictionary. More... | |
regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict) | |
Construct from the region objectRegistry and dictionary. More... | |
regionFunctionObject (const regionFunctionObject &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual | ~regionFunctionObject () |
Destructor. More... | |
void | operator= (const regionFunctionObject &)=delete |
Disallow default bitwise assignment. More... | |
Public Member Functions inherited from functionObject | |
ClassName ("functionObject") | |
virtual const word & | type () const =0 |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict)) | |
functionObject (const word &name) | |
Construct from components. More... | |
autoPtr< functionObject > | clone () const |
Return clone. More... | |
functionObject (const functionObject &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual | ~functionObject () |
Destructor. More... | |
const word & | name () const |
Return the name of this functionObject. More... | |
virtual bool | executeAtStart () const |
Return true if the functionObject should be executed at the start. More... | |
virtual bool | end () |
Called when Time::run() determines that the time-loop exits. More... | |
virtual bool | setTimeStep () |
Called by Time::setDeltaT(). Allows the functionObject to override. More... | |
virtual scalar | timeToNextWrite () |
Called by Time::adjustTimeStep(). Allows the functionObject to. More... | |
virtual void | updateMesh (const mapPolyMesh &mpm) |
Update for changes of mesh. More... | |
virtual void | movePoints (const polyMesh &mesh) |
Update for changes of mesh. More... | |
void | operator= (const functionObject &)=delete |
Disallow default bitwise assignment. More... | |
Public Member Functions inherited from logFiles | |
logFiles (const objectRegistry &obr, const word &prefix) | |
Construct from objectRegistry and prefix. More... | |
logFiles (const logFiles &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual | ~logFiles () |
Destructor. More... | |
const wordList & | names () const |
Return const access to the names. More... | |
PtrList< OFstream > & | files () |
Return access to the files. More... | |
OFstream & | file () |
Return access to the file (if only 1) More... | |
OFstream & | file (const label i) |
Return file 'i'. More... | |
void | operator= (const logFiles &)=delete |
Disallow default bitwise assignment. More... | |
Public Member Functions inherited from writeFile | |
writeFile (const objectRegistry &obr, const word &prefix) | |
Construct from objectRegistry and prefix. More... | |
writeFile (const writeFile &)=delete | |
Disallow default bitwise copy construction. More... | |
~writeFile () | |
Destructor. More... | |
void | initStream (Ostream &os) const |
Initialise the output stream for writing. More... | |
fileName | baseFileDir () const |
Return the base directory for output. More... | |
fileName | baseTimeDir () const |
Return the base directory for the current time value. More... | |
Omanip< int > | valueWidth (const label offset=0) const |
Return the value width when writing to stream with optional offset. More... | |
void | writeCommented (Ostream &os, const string &str) const |
Write a commented string to stream. More... | |
void | writeTabbed (Ostream &os, const string &str) const |
Write a tabbed string to stream. More... | |
void | writeHeader (Ostream &os, const string &str) const |
Write a commented header to stream. More... | |
void | writeTime (Ostream &os) const |
Write the current time to stream. More... | |
template<class Type > | |
void | writeHeaderValue (Ostream &os, const string &property, const Type &value) const |
Write a (commented) header property and value pair. More... | |
label | charWidth () const |
Return width of character stream output. More... | |
void | operator= (const writeFile &)=delete |
Disallow default bitwise assignment. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from functionObject | |
static autoPtr< functionObject > | New (const word &name, const Time &, const dictionary &) |
Select from dictionary, based on its "type" entry. More... | |
Public Attributes inherited from functionObject | |
Switch | log |
Switch write log to Info. More... | |
Switch | executeAtStart_ |
Switch write log to Info. More... | |
Static Public Attributes inherited from functionObject | |
static bool | postProcess |
Global post-processing mode switch. More... | |
Static Public Attributes inherited from writeFile | |
static const word | outputPrefix |
Directory prefix. More... | |
static label | addChars = 8 |
Additional characters for writing. More... | |
Protected Member Functions inherited from sixDoFRigidBodyState | |
virtual void | writeFileHeader (const label i=0) |
overloaded writeFileHeader from writeFile More... | |
Protected Member Functions inherited from regionFunctionObject | |
template<class ObjectType > | |
bool | foundObject (const word &fieldName) const |
Find field in the objectRegistry. More... | |
template<class ObjectType > | |
const ObjectType & | lookupObject (const word &fieldName) const |
Lookup object from the objectRegistry. More... | |
template<class ObjectType > | |
ObjectType & | lookupObjectRef (const word &fieldName) |
Lookup non-const object reference from the objectRegistry. More... | |
template<class ObjectType > | |
bool | store (const tmp< ObjectType > &tfield) |
Store the given field in the objectRegistry. More... | |
template<class ObjectType > | |
bool | store (const word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false) |
Store the given field in the objectRegistry under the given name. More... | |
bool | writeObject (const word &fieldName) |
Write field if present in objectRegistry. More... | |
bool | clearObject (const word &fieldName) |
Clear field from the objectRegistry if present. More... | |
Protected Member Functions inherited from logFiles | |
virtual void | createFiles () |
Create the output file. More... | |
virtual void | resetNames (const wordList &names) |
Reset the list of names from a wordList. More... | |
virtual void | resetName (const word &name) |
Reset the list of names to a single name entry. More... | |
Protected Attributes inherited from fvMeshFunctionObject | |
const fvMesh & | mesh_ |
Reference to the fvMesh. More... | |
Protected Attributes inherited from regionFunctionObject | |
const Time & | time_ |
Reference to the Time. More... | |
const objectRegistry & | obr_ |
Reference to the region objectRegistry. More... | |
Protected Attributes inherited from logFiles | |
wordList | names_ |
File names. More... | |
PtrList< OFstream > | filePtrs_ |
File pointer. More... | |
Protected Attributes inherited from writeFile | |
const objectRegistry & | fileObr_ |
Reference to the region objectRegistry. More... | |
const word | prefix_ |
Prefix. More... | |
Convergence control based on the 6-DoF motion state.
The body linear and angular velocities are averaged over a specified time window and compared to specified velocity convergence criteria and the run stopped after writing the current time results, if the criteria are met.
Example of function object specification:
sixDoFRigidBodyControl { type sixDoFRigidBodyControl; libs ("libsixDoFRigidBodyState.so"); angleFormat degrees; window 1; convergedVelocity (1e-2 1e-2 1e-2); convergedAngularVelocity (5 5 5); }
Note the units of the convergedAngularVelocity
are specified by the angleFormat
entry.
Property | Description | Required | Default value |
---|---|---|---|
type | Type name: sixDoFRigidBodyControl | yes | |
angleFormat | Degrees or radians | no | radian |
window | Averaging window | yes | |
convergedVelocity | Linear velocity convergence criterion | yes | |
convergedAngularVelocity | Angular velocity convergence criterion | yes |
Definition at line 115 of file sixDoFRigidBodyControl.H.
sixDoFRigidBodyControl | ( | const word & | name, |
const Time & | runTime, | ||
const dictionary & | dict | ||
) |
Construct from Time and dictionary.
Definition at line 51 of file sixDoFRigidBodyControl.C.
References Foam::read().
|
delete |
Disallow default bitwise copy construction.
|
virtual |
Destructor.
Definition at line 69 of file sixDoFRigidBodyControl.C.
TypeName | ( | "sixDoFRigidBodyControl" | ) |
Runtime type information.
|
virtual |
Read the sixDoFRigidBodyControl data.
Reimplemented from sixDoFRigidBodyState.
Definition at line 75 of file sixDoFRigidBodyControl.C.
References dictionary::lookup(), and sixDoFRigidBodyState::read().
|
virtual |
Execute, currently does nothing.
Reimplemented from sixDoFRigidBodyState.
Definition at line 87 of file sixDoFRigidBodyControl.C.
References Foam::cmptMag(), Foam::min(), and Time::writeNow.
|
delete |
Disallow default bitwise assignment.