IO-registered version of lumpedPointMovement. More...
Public Member Functions | |
| TypeNameNoDebug ("lumpedPointMovement") | |
| Runtime type information. More... | |
| lumpedPointIOMovement (const IOobject &io, label ownerId=-1) | |
| Construct from IOobject, optionally with some owner information. More... | |
| virtual | ~lumpedPointIOMovement ()=default |
| Destructor. More... | |
| bool | readData (Istream &is) |
| The readData member function used by regIOobject. More... | |
| bool | writeData (Ostream &os) const |
| The writeData member function required by regIOobject. More... | |
 Public Member Functions inherited from lumpedPointMovement | |
| lumpedPointMovement () | |
| Default construct. More... | |
| lumpedPointMovement (const dictionary &dict, label ownerId=-1) | |
| Construct from dictionary, optionally with some owner information. More... | |
| virtual | ~lumpedPointMovement ()=default |
| Destructor. More... | |
| void | readDict (const dictionary &dict) |
| Update settings from dictionary. More... | |
| bool | empty () const |
| If no number of lumped points (locations) were specified. More... | |
| label | size () const |
| The number of lumped points (number of locations) More... | |
| label | ownerId () const |
| An owner Id, if needed for bookkeeping purposes. More... | |
| void | ownerId (label id) |
| Change the owner id, if needed for bookkeeping purposes. More... | |
| const externalFileCoupler & | coupler () const |
| Communication control. More... | |
| externalFileCoupler & | coupler () |
| Communication control. More... | |
| bool | couplingPending (const label timeIndex) const |
| Check if coupling is pending (according to the calcFrequency) More... | |
| void | couplingCompleted (const label timeIndex) const |
| Register that coupling is completed at this calcFrequency. More... | |
| const lumpedPointState & | state0 () const |
| The initial state (positions/rotations) More... | |
| const lumpedPointState & | state () const |
| The current state (positions/rotations) More... | |
| const point & | origin () const |
| The offset for lumped points, used on input. More... | |
| void | scalePoints (lumpedPointState &state) const |
| Scale the lumped points (on input). More... | |
| scalar | relax () const |
| The relaxation factor when changing states. More... | |
| scalar & | relax () |
| The relaxation factor when changing states. More... | |
| const word & | inputName () const |
| The input (state) file name. More... | |
| const word & | outputName () const |
| The output (forces) file name. More... | |
| const word & | logName () const |
| The log file name. More... | |
| lumpedPointState::inputFormatType | inputFormat () const |
| The input (state) file format. More... | |
| lumpedPointMovement::outputFormatType | outputFormat () const |
| The output (forces) file format. More... | |
| quaternion::eulerOrder | rotationOrder () const |
| The Euler-angle rotation order. More... | |
| bool | degrees () const |
| Rotation angles in degrees. More... | |
| bool | hasPatchControl (const label patchIndex) const |
| Check if patch control exists for specified patch. More... | |
| bool | hasPatchControl (const polyPatch &pp) const |
| Check if patch control exists for specified patch. More... | |
| bool | hasInterpolator (const pointPatch &fpatch) const |
| Check if patch control exists for specified patch. More... | |
| void | checkPatchControl (const polyPatch &pp) const |
| Check if patch control exists for specified patch. More... | |
| void | setPatchControl (const polyPatch &pp, const wordList &ctrlNames, const pointField &points0) |
| Define pressure-zones mapping for faces in the specified patches. More... | |
| void | setMapping (const polyMesh &mesh, const labelUList &patchIds, const pointField &points0) |
| Define pressure-zones mapping for faces in the specified patches. More... | |
| void | setInterpolator (const pointPatch &fpatch, const pointField &points0) |
| Check if patch control exists for specified patch. More... | |
| bool | hasMapping () const |
| True if the pressure-zones mapping has already been performed. More... | |
| bool | hasInterpolator (const label patchIndex) const |
| Check if patch interpolator exists for specified patch. More... | |
| List< scalar > | areas (const polyMesh &pmesh) const |
| The areas for each pressure-zone. More... | |
| bool | forcesAndMoments (const polyMesh &pmesh, List< vector > &forces, List< vector > &moments) const |
| The forces and moments acting on each pressure-zone. More... | |
| tmp< pointField > | pointsDisplacement (const pointPatch &fpatch, const pointField &points0) const |
| Displace points according to the current state. More... | |
| tmp< pointField > | pointsDisplacement (const lumpedPointState &state, const pointPatch &fpatch, const pointField &points0) const |
| Displace points according to specified state. More... | |
| tmp< pointField > | pointsPosition (const lumpedPointState &state, const pointPatch &fpatch, const pointField &points0) const |
| The points absolute position according to specified state. More... | |
| void | writeDict (Ostream &os) const |
| Write axis, locations, division as a dictionary. More... | |
| bool | writeData (Ostream &os, const UList< vector > &forces, const UList< vector > &moments, const outputFormatType fmt=outputFormatType::PLAIN, const Tuple2< scalar, scalar > *timesWritten=nullptr) const |
| Write points, forces, moments. Only call from the master process. More... | |
| bool | writeData (const UList< vector > &forces, const UList< vector > &moments=List< vector >(), const Tuple2< scalar, scalar > *timesWritten=nullptr) const |
| Write points, forces, moments. More... | |
| bool | readState () |
| Read state from file, applying relaxation as requested. More... | |
| void | writeStateVTP (const lumpedPointState &state, const fileName &file) const |
| Write state as VTK PolyData format. More... | |
| void | writeStateVTP (const fileName &file) const |
| Write state as VTK PolyData format. More... | |
| void | writeForcesAndMomentsVTP (const fileName &file, const UList< vector > &forces, const UList< vector > &moments) const |
| Write forces on points as VTK PolyData format. More... | |
| void | writeZonesVTP (const fileName &file, const polyMesh &mesh, const pointField &points0) const |
| Write pressure-zones geometry, write as VTK PolyData format. More... | |
| void | writeVTP (const fileName &file, const polyMesh &mesh, const pointField &points0) const |
| Write displaced geometry according to the current state,. More... | |
| void | writeVTP (const fileName &file, const lumpedPointState &state, const polyMesh &mesh, const pointField &points0) const |
| Write displaced geometry according to the specified state,. More... | |
| Public Member Functions inherited from regIOobject | |
| TypeName ("regIOobject") | |
| Runtime type information. More... | |
| regIOobject (const IOobject &io, const bool isTimeObject=false) | |
| regIOobject (const regIOobject &rio) | |
| Copy construct. More... | |
| regIOobject (const regIOobject &rio, bool registerCopy) | |
| regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
| regIOobject (const IOobject &io, const regIOobject &rio) | |
| Copy construct with new IO parameters. More... | |
| virtual | ~regIOobject () |
| Destructor. More... | |
| bool | checkIn () |
| Add object to registry, if not already registered. More... | |
| bool | checkOut () |
| Remove all file watches and remove object from registry. More... | |
| virtual void | addWatch () |
| Add file watch on object (if registered and READ_IF_MODIFIED) More... | |
| bool | ownedByRegistry () const |
| Is this object owned by the registry? More... | |
| bool | store () |
| void | release (const bool unregister=false) |
| 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 as up-to-date. More... | |
| virtual void | rename (const word &newName) |
| Rename. More... | |
| const dictionary * | findMetaData () const noexcept |
| Return pointer to meta-data or nullptr. More... | |
| dictionary & | getMetaData () noexcept |
| Get or create meta-data. More... | |
| void | removeMetaData () |
| Remove meta-data. More... | |
| virtual void | updateMetaData () |
| Update internal meta-data (eg, prior to writing) More... | |
| virtual fileName | filePath () const |
| Return complete path + object name if the file exists. More... | |
| bool | headerOk () |
| Read and check header info. More... | |
| Istream & | readStream (const word &, const bool valid=true) |
| Return Istream and check object type against that given. More... | |
| void | close () |
| Close Istream. More... | |
| virtual bool | read () |
| Read object. More... | |
| virtual label | addWatch (const fileName &) |
| Add file watch for fileName on object if not yet watched. More... | |
| const labelList & | watchIndices () const |
| Return file-monitoring handles. More... | |
| labelList & | watchIndices () |
| Return file-monitoring handles. More... | |
| virtual bool | modified () const |
| virtual bool | readIfModified () |
| Read object if modified (as set by call to modified) More... | |
| virtual bool | writeObject (IOstreamOption streamOpt, const bool valid) const |
| Write using stream options. More... | |
| virtual bool | write (const bool valid=true) const |
| Write using setting from DB. More... | |
| virtual bool | global () const |
| Is object global. More... | |
| void | operator= (const IOobject &io) |
| Copy assignment. More... | |
| virtual bool | writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const |
| Write using given format, version and compression. More... | |
| Public Member Functions inherited from IOobject | |
| TypeName ("IOobject") | |
| Declare type-name, virtual type (with debug switch) More... | |
| IOobject (const IOobject &)=default | |
| Copy construct. More... | |
| virtual | ~IOobject ()=default |
| Destructor. More... | |
| IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
| 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, bool globalObject=false) | |
| 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, bool globalObject=false) | |
| Construct from path, registry, io options. More... | |
| IOobject (const IOobject &io, const objectRegistry ®istry) | |
| Copy construct, resetting registry. More... | |
| IOobject (const IOobject &io, const word &name) | |
| Copy construct, resetting name. More... | |
| IOobject (const IOobject &io, readOption, writeOption) | |
| Copy construct, resetting io options. More... | |
| autoPtr< IOobject > | clone () const |
| Clone. More... | |
| autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
| Clone resetting registry. More... | |
| const objectRegistry & | db () const noexcept |
| Return the local objectRegistry. More... | |
| const Time & | time () const |
| Return Time associated with the objectRegistry. More... | |
| const word & | name () const noexcept |
| Return name. More... | |
| const word & | headerClassName () const noexcept |
| Return name of the class name read from header. More... | |
| word & | headerClassName () noexcept |
| Return non-constant access to the class name read from header. More... | |
| const string & | note () const noexcept |
| Return the optional note. More... | |
| string & | note () noexcept |
| Return non-constant access to the optional note. More... | |
| bool | registerObject () const noexcept |
| Should object created with this IOobject be registered? More... | |
| bool | registerObject (bool on) noexcept |
| Change registration preference, return previous value. More... | |
| bool | globalObject () const noexcept |
| Is object same for all processors? More... | |
| bool | globalObject (bool on) noexcept |
| Change global-object status, return previous value. More... | |
| unsigned | labelByteSize () const noexcept |
| The sizeof (label) in bytes, possibly read from the header. More... | |
| unsigned | scalarByteSize () const noexcept |
| The sizeof (scalar) in bytes, possibly read from the header. More... | |
| bool | isHeaderClassName (const word &clsName) const |
| Test if headerClassName() equals the given class name. More... | |
| template<class Type > | |
| bool | isHeaderClassName () const |
| Test if headerClassName() equals Type::typeName. More... | |
| readOption | readOpt () const noexcept |
| The read option. More... | |
| readOption | readOpt (readOption opt) noexcept |
| Change the read option, return previous value. More... | |
| writeOption | writeOpt () const noexcept |
| The write option. More... | |
| writeOption | writeOpt (writeOption opt) noexcept |
| Change the write option, return previous value. More... | |
| 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 noexcept |
| fileName & | instance () noexcept |
| const fileName & | local () const noexcept |
| fileName | path () const |
| The complete path. More... | |
| fileName | path (const word &instance, const fileName &local=fileName::null) const |
| The complete path with alternative instance and local. More... | |
| fileName | objectPath () const |
| The complete path + object name. More... | |
| fileName | objectRelPath () const |
| The object path relative to the root. More... | |
| fileName | localFilePath (const word &typeName, const bool search=true) const |
| Helper for filePath that searches locally. More... | |
| fileName | globalFilePath (const word &typeName, const bool search=true) const |
| Helper for filePath that searches up if in parallel. More... | |
| IOstreamOption | parseHeader (const dictionary &headerDict) |
| bool | readHeader (Istream &is) |
| bool | readHeader (dictionary &headerDict, Istream &is) |
| template<class Type > | |
| bool | typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true) |
| Read header (uses typeFilePath to find file) and check its info. More... | |
| template<class Type > | |
| void | warnNoRereading () const |
| Helper: warn that type does not support re-reading. More... | |
| bool | writeHeader (Ostream &os) const |
| Write header with current type() More... | |
| bool | writeHeader (Ostream &os, const word &objectType) const |
| Write header with override of type. More... | |
| void | writeHeader (dictionary &dict, IOstreamOption streamOpt) const |
| void | writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const |
| bool | good () const noexcept |
| bool | bad () const noexcept |
| InfoProxy< IOobject > | info () const |
| Return info proxy. More... | |
| void | operator= (const IOobject &io) |
| readOption & | readOpt () noexcept |
| Access to the read option. More... | |
| writeOption & | writeOpt () noexcept |
| Access to the write option. More... | |
| bool & | registerObject () noexcept |
| Access to the register object option. More... | |
| bool & | globalObject () noexcept |
| Access to the global object option. More... | |
| template<> | |
| bool | isHeaderClassName () const |
Specialization for void always returns true (no headerClassName check). More... | |
| template<class StringType > | |
| Foam::word | groupName (StringType base, const word &group) |
Static Public Member Functions | |
| static lumpedPointIOMovement * | getMovementObject (const objectRegistry &obr) |
| Find the movement object or nullptr if not found. More... | |
| static autoPtr< lumpedPointIOMovement > | New (const objectRegistry &obr, label ownerId=-1) |
| Static Public Member Functions inherited from regIOobject | |
| template<class Type > | |
| static Type & | store (Type *p) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (autoPtr< Type > &ptr) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (autoPtr< Type > &&ptr) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (refPtr< Type > &ptr) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (refPtr< Type > &&ptr) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (tmp< Type > &ptr) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (tmp< Type > &&ptr) |
| Transfer pointer ownership to its registry. More... | |
| Static Public Member Functions inherited from IOobject | |
| static bool | bannerEnabled () noexcept |
| Status of output file banner. More... | |
| static bool | bannerEnabled (bool on) noexcept |
| Enable/disable an output file banner. More... | |
| static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
| Split path into instance, local, name components. More... | |
| template<class StringType > | |
| static word | groupName (StringType base, const word &group) |
| Create dot-delimited name.group string. More... | |
| static word | group (const word &name) |
| Return group (extension part of name) More... | |
| static word | member (const word &name) |
| Return member (name without the extension) More... | |
| static word | scopedName (const std::string &scope, const word &name) |
| Create scope:name or scope_name string. More... | |
| static IOobject | selectIO (const IOobject &io, const fileName &altFile, const word &ioName="") |
| Return the IOobject, but also consider an alternative file name. More... | |
| static Ostream & | writeBanner (Ostream &os, const bool noSyntaxHint=false) |
| Write the standard OpenFOAM file/dictionary banner. More... | |
| static Ostream & | writeDivider (Ostream &os) |
| Write the standard file section divider. More... | |
| static Ostream & | writeEndDivider (Ostream &os) |
| Write the standard end file divider. More... | |
Additional Inherited Members | |
| Public Types inherited from lumpedPointMovement | |
| enum | outputFormatType { PLAIN, DICTIONARY } |
| Output format types. More... | |
| enum | scalingType { LENGTH = 0, FORCE, MOMENT } |
| Output format types. More... | |
| Public Types inherited from IOobject | |
| enum | objectState : char { GOOD, BAD } |
| Enumeration defining the valid states of an IOobject. More... | |
| enum | readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ } |
| Enumeration defining the read options. More... | |
| enum | writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 } |
| Enumeration defining the write options. More... | |
| enum | fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster } |
| Enumeration defining the file checking options. More... | |
| Static Public Attributes inherited from lumpedPointMovement | |
| static const Enum< outputFormatType > | formatNames |
| Names for the output format types. More... | |
| static const Enum< scalingType > | scalingNames |
| Names for the scaling types. More... | |
| static int | debug |
| Debug switch. More... | |
| static const word | canonicalName |
| The canonical name ("lumpedPointMovement") for the dictionary. More... | |
| Static Public Attributes inherited from IOobject | |
| static const Enum< fileCheckTypes > | fileCheckTypesNames |
| Names for the fileCheckTypes. More... | |
| static char | scopeSeparator |
| Character for scoping object names (':' or '_') More... | |
| static fileCheckTypes | fileModificationChecking |
| Type of file modification checking. More... | |
| static float | fileModificationSkew |
| Time skew (seconds) for file modification checks. More... | |
| static int | maxFileModificationPolls |
| Max number of times to poll for file modification changes. More... | |
| Protected Member Functions inherited from regIOobject | |
| bool | readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName) |
| Helper: check readOpt flags and read if necessary. More... | |
| Protected Member Functions inherited from IOobject | |
| void | setBad (const string &s) |
| Set the object state to bad. More... | |
| Static Protected Member Functions inherited from IOobject | |
| static void | writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr) |
| static void | writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr) |
| Static Protected Attributes inherited from regIOobject | |
| static bool | masterOnlyReading = false |
| To flag master-only reading of objects. More... | |
IO-registered version of lumpedPointMovement.
Definition at line 52 of file lumpedPointIOMovement.H.
|
explicit |
Construct from IOobject, optionally with some owner information.
Definition at line 77 of file lumpedPointIOMovement.C.
References IOobject::MUST_READ, and IOobject::MUST_READ_IF_MODIFIED.
|
virtualdefault |
Destructor.
| TypeNameNoDebug | ( | "lumpedPointMovement" | ) |
Runtime type information.
|
static |
Find the movement object or nullptr if not found.
Definition at line 42 of file lumpedPointIOMovement.C.
References lumpedPointMovement::canonicalName, and objectRegistry::getObjectPtr().
Referenced by lumpedPointDisplacementPointPatchVectorField::movement(), and lumpedPointDisplacementPointPatchVectorField::~lumpedPointDisplacementPointPatchVectorField().
|
static |
Create a movement object in the registry by reading system dictionary
Definition at line 53 of file lumpedPointIOMovement.C.
References lumpedPointMovement::canonicalName, TimePaths::caseSystem(), IOobject::MUST_READ, autoPtr< T >::New(), IOobject::NO_WRITE, and objectRegistry::time().
Referenced by lumpedPointDisplacementPointPatchVectorField::movement().
The readData member function used by regIOobject.
Reimplemented from regIOobject.
Definition at line 106 of file lumpedPointIOMovement.C.
References IOstream::check(), dict, and FUNCTION_NAME.
The writeData member function required by regIOobject.
Implements regIOobject.
Definition at line 116 of file lumpedPointIOMovement.C.
References IOstream::good(), and os().
1.8.17 