Public Member Functions | Static Public Member Functions | List of all members
lumpedPointIOMovement Class Reference

IO-registered version of lumpedPointMovement. More...

Inheritance diagram for lumpedPointIOMovement:
Inheritance graph
[legend]
Collaboration diagram for lumpedPointIOMovement:
Collaboration graph
[legend]

Public Member Functions

 TypeNameNoDebug ("lumpedPointMovement")
 
 lumpedPointIOMovement (const IOobject &io, label ownerId=-1)
 
virtual ~lumpedPointIOMovement ()=default
 
bool readData (Istream &is)
 
bool writeData (Ostream &os) const
 
- Public Member Functions inherited from lumpedPointMovement
 lumpedPointMovement ()
 
 lumpedPointMovement (const dictionary &dict, label ownerId=-1)
 
virtual ~lumpedPointMovement ()=default
 
void readDict (const dictionary &dict)
 
bool empty () const
 
label size () const
 
label ownerId () const
 
void ownerId (label id)
 
const externalFileCouplercoupler () const
 
externalFileCouplercoupler ()
 
bool couplingPending (const label timeIndex) const
 
void couplingCompleted (const label timeIndex) const
 
const lumpedPointStatestate0 () const
 
const lumpedPointStatestate () const
 
const pointorigin () const
 
void scalePoints (lumpedPointState &state) const
 
scalar relax () const
 
scalar & relax ()
 
const wordinputName () const
 
const wordoutputName () const
 
const wordlogName () const
 
lumpedPointState::inputFormatType inputFormat () const
 
lumpedPointMovement::outputFormatType outputFormat () const
 
quaternion::eulerOrder rotationOrder () const
 
bool degrees () const
 
bool hasPatchControl (const label patchIndex) const
 
bool hasPatchControl (const polyPatch &pp) const
 
bool hasInterpolator (const pointPatch &fpatch) const
 
void checkPatchControl (const polyPatch &pp) const
 
void setPatchControl (const polyPatch &pp, const wordList &ctrlNames, const pointField &points0)
 
void setMapping (const polyMesh &mesh, const labelUList &patchIds, const pointField &points0)
 
void setInterpolator (const pointPatch &fpatch, const pointField &points0)
 
bool hasMapping () const
 
bool hasInterpolator (const label patchIndex) const
 
List< scalar > areas (const polyMesh &pmesh) const
 
bool forcesAndMoments (const polyMesh &pmesh, List< vector > &forces, List< vector > &moments) const
 
tmp< pointFieldpointsDisplacement (const pointPatch &fpatch, const pointField &points0) const
 
tmp< pointFieldpointsDisplacement (const lumpedPointState &state, const pointPatch &fpatch, const pointField &points0) const
 
tmp< pointFieldpointsPosition (const lumpedPointState &state, const pointPatch &fpatch, const pointField &points0) const
 
void writeDict (Ostream &os) const
 
bool writeData (Ostream &os, const UList< vector > &forces, const UList< vector > &moments, const outputFormatType fmt=outputFormatType::PLAIN, const Tuple2< scalar, scalar > *timesWritten=nullptr) const
 
bool writeData (const UList< vector > &forces, const UList< vector > &moments=List< vector >(), const Tuple2< scalar, scalar > *timesWritten=nullptr) const
 
bool readState ()
 
void writeStateVTP (const lumpedPointState &state, const fileName &file) const
 
void writeStateVTP (const fileName &file) const
 
void writeForcesAndMomentsVTP (const fileName &file, const UList< vector > &forces, const UList< vector > &moments) const
 
void writeZonesVTP (const fileName &file, const polyMesh &mesh, const pointField &points0) const
 
void writeVTP (const fileName &file, const polyMesh &mesh, const pointField &points0) const
 
void writeVTP (const fileName &file, const lumpedPointState &state, const polyMesh &mesh, const pointField &points0) const
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 
 regIOobject (const IOobject &io, const bool isTimeObject=false)
 
 regIOobject (const regIOobject &rio)
 
 regIOobject (const regIOobject &rio, bool registerCopy)
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 
 regIOobject (const IOobject &io, const regIOobject &rio)
 
virtual ~regIOobject ()
 
bool checkIn ()
 
bool checkOut ()
 
virtual void addWatch ()
 
bool ownedByRegistry () const
 
bool store ()
 
void release (const bool unregister=false)
 
label eventNo () const
 
label & eventNo ()
 
bool upToDate (const regIOobject &) const
 
bool upToDate (const regIOobject &, const regIOobject &) const
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
 
void setUpToDate ()
 
virtual void rename (const word &newName)
 
const dictionaryfindMetaData () const noexcept
 
dictionarygetMetaData () noexcept
 
void removeMetaData ()
 
virtual void updateMetaData ()
 
virtual fileName filePath () const
 
bool headerOk ()
 
IstreamreadStream (const word &, const bool valid=true)
 
void close ()
 
virtual bool read ()
 
virtual label addWatch (const fileName &)
 
const labelListwatchIndices () const
 
labelListwatchIndices ()
 
virtual bool modified () const
 
virtual bool readIfModified ()
 
virtual bool writeObject (IOstreamOption streamOpt, const bool valid) const
 
virtual bool write (const bool valid=true) const
 
virtual bool global () const
 
void operator= (const IOobject &io)
 
virtual bool writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 
 IOobject (const IOobject &)=default
 
virtual ~IOobject ()=default
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 
 IOobject (const IOobject &io, const word &name)
 
 IOobject (const IOobject &io, readOption, writeOption)
 
autoPtr< IOobjectclone () const
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 
const objectRegistrydb () const noexcept
 
const Timetime () const
 
const wordname () const noexcept
 
const wordheaderClassName () const noexcept
 
wordheaderClassName () noexcept
 
const stringnote () const noexcept
 
stringnote () noexcept
 
bool registerObject () const noexcept
 
bool registerObject (bool on) noexcept
 
bool globalObject () const noexcept
 
bool globalObject (bool on) noexcept
 
unsigned labelByteSize () const noexcept
 
unsigned scalarByteSize () const noexcept
 
bool isHeaderClassName (const word &clsName) const
 
template<class Type >
bool isHeaderClassName () const
 
readOption readOpt () const noexcept
 
readOption readOpt (readOption opt) noexcept
 
writeOption writeOpt () const noexcept
 
writeOption writeOpt (writeOption opt) noexcept
 
word group () const
 
word member () const
 
const fileNamerootPath () const
 
const fileNamecaseName () const
 
const fileNameinstance () const noexcept
 
fileNameinstance () noexcept
 
const fileNamelocal () const noexcept
 
fileName path () const
 
fileName path (const word &instance, const fileName &local=fileName::null) const
 
fileName objectPath () const
 
fileName objectRelPath () const
 
fileName localFilePath (const word &typeName, const bool search=true) const
 
fileName globalFilePath (const word &typeName, const bool search=true) const
 
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)
 
template<class Type >
void warnNoRereading () const
 
bool writeHeader (Ostream &os) const
 
bool writeHeader (Ostream &os, const word &objectType) const
 
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< IOobjectinfo () const
 
void operator= (const IOobject &io)
 
readOptionreadOpt () noexcept
 
writeOptionwriteOpt () noexcept
 
boolregisterObject () noexcept
 
boolglobalObject () noexcept
 
template<>
bool isHeaderClassName () const
 
template<class StringType >
Foam::word groupName (StringType base, const word &group)
 

Static Public Member Functions

static lumpedPointIOMovementgetMovementObject (const objectRegistry &obr)
 
static autoPtr< lumpedPointIOMovementNew (const objectRegistry &obr, label ownerId=-1)
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *p)
 
template<class Type >
static Type & store (autoPtr< Type > &ptr)
 
template<class Type >
static Type & store (autoPtr< Type > &&ptr)
 
template<class Type >
static Type & store (refPtr< Type > &ptr)
 
template<class Type >
static Type & store (refPtr< Type > &&ptr)
 
template<class Type >
static Type & store (tmp< Type > &ptr)
 
template<class Type >
static Type & store (tmp< Type > &&ptr)
 
- Static Public Member Functions inherited from IOobject
static bool bannerEnabled () noexcept
 
static bool bannerEnabled (bool on) noexcept
 
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 
template<class StringType >
static word groupName (StringType base, const word &group)
 
static word group (const word &name)
 
static word member (const word &name)
 
static word scopedName (const std::string &scope, const word &name)
 
static IOobject selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
 
static OstreamwriteBanner (Ostream &os, const bool noSyntaxHint=false)
 
static OstreamwriteDivider (Ostream &os)
 
static OstreamwriteEndDivider (Ostream &os)
 

Additional Inherited Members

- Public Types inherited from lumpedPointMovement
enum  outputFormatType { PLAIN, DICTIONARY }
 
enum  scalingType { LENGTH = 0, FORCE, MOMENT }
 
- Public Types inherited from IOobject
enum  objectState : char { GOOD, BAD }
 
enum  readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
 
enum  writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }
 
enum  fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }
 
- Static Public Attributes inherited from lumpedPointMovement
static const Enum< outputFormatTypeformatNames
 
static const Enum< scalingTypescalingNames
 
static int debug
 
static const word canonicalName
 
- Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypesfileCheckTypesNames
 
static char scopeSeparator
 
static fileCheckTypes fileModificationChecking
 
static float fileModificationSkew
 
static int maxFileModificationPolls
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
 
- Protected Member Functions inherited from IOobject
void setBad (const string &s)
 
- 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
 

Detailed Description

IO-registered version of lumpedPointMovement.

Source files

Definition at line 48 of file lumpedPointIOMovement.H.

Constructor & Destructor Documentation

◆ lumpedPointIOMovement()

lumpedPointIOMovement ( const IOobject io,
label  ownerId = -1 
)
explicit

Definition at line 70 of file lumpedPointIOMovement.C.

References IOobject::MUST_READ, and IOobject::MUST_READ_IF_MODIFIED.

◆ ~lumpedPointIOMovement()

virtual ~lumpedPointIOMovement ( )
virtualdefault

Member Function Documentation

◆ TypeNameNoDebug()

TypeNameNoDebug ( "lumpedPointMovement"  )

◆ getMovementObject()

Foam::lumpedPointIOMovement * getMovementObject ( const objectRegistry obr)
static

◆ New()

Foam::autoPtr< Foam::lumpedPointIOMovement > New ( const objectRegistry obr,
label  ownerId = -1 
)
static

Definition at line 46 of file lumpedPointIOMovement.C.

References lumpedPointMovement::canonicalName, TimePaths::caseSystem(), IOobject::MUST_READ, autoPtr::New(), IOobject::NO_WRITE, and objectRegistry::time().

Referenced by lumpedPointDisplacementPointPatchVectorField::movement().

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

◆ readData()

bool readData ( Istream is)
virtual

Reimplemented from regIOobject.

Definition at line 99 of file lumpedPointIOMovement.C.

References IOstream::check(), dict, and FUNCTION_NAME.

Here is the call graph for this function:

◆ writeData()

bool writeData ( Ostream os) const
virtual

Implements regIOobject.

Definition at line 109 of file lumpedPointIOMovement.C.

References IOstream::good(), and os().

Here is the call graph for this function:

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