Public Member Functions | Protected Attributes | List of all members
componentVelocityMotionSolver Class Reference

Virtual base class for velocity motion solver. More...

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

Public Member Functions

 TypeName ("componentVelocityMotionSolver")
 
 componentVelocityMotionSolver (const polyMesh &, const IOdictionary &, const word &type)
 
virtual ~componentVelocityMotionSolver ()
 
pointScalarFieldpointMotionU ()
 
virtual void movePoints (const pointField &)
 
virtual void updateMesh (const mapPolyMesh &)
 
- Public Member Functions inherited from motionSolver
 TypeName ("motionSolver")
 
 declareRunTimeSelectionTable (autoPtr, motionSolver, dictionary,(const polyMesh &mesh, const IOdictionary &dict),(mesh, dict))
 
 motionSolver (const polyMesh &mesh)
 
 motionSolver (const polyMesh &mesh, const IOdictionary &, const word &type)
 
virtual autoPtr< motionSolverclone () const
 
virtual ~motionSolver ()=default
 
const polyMeshmesh () const
 
const dictionarycoeffDict () const
 
virtual tmp< pointFieldnewPoints ()
 
virtual tmp< pointFieldcurPoints () const =0
 
virtual void twoDCorrectPoints (pointField &) const
 
virtual void solve ()=0
 
virtual bool writeObject (IOstreamOption streamOpt, const bool valid) const
 
virtual bool read ()
 
- Public Member Functions inherited from IOdictionary
 IOdictionary (const IOobject &io, const dictionary *fallback=nullptr)
 
 IOdictionary (const IOobject &io, const dictionary &dict)
 
 IOdictionary (const IOobject &io, const word &wantedType, const dictionary *fallback=nullptr)
 
 IOdictionary (const IOobject &io, Istream &is)
 
virtual ~IOdictionary ()=default
 
virtual bool global () const
 
virtual fileName filePath () const
 
- Public Member Functions inherited from baseIOdictionary
 TypeName ("dictionary")
 
 baseIOdictionary (const baseIOdictionary &)=default
 
 baseIOdictionary (baseIOdictionary &&)=default
 
virtual ~baseIOdictionary ()=default
 
 baseIOdictionary (const IOobject &io, const dictionary *fallback=nullptr)
 
 baseIOdictionary (const IOobject &io, const dictionary &dict)
 
 baseIOdictionary (const IOobject &io, Istream &is)
 
const wordname () const
 
virtual bool readData (Istream &)
 
virtual bool writeData (Ostream &) const
 
void operator= (const baseIOdictionary &rhs)
 
void operator= (const dictionary &rhs)
 
- 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 ()
 
bool headerOk ()
 
IstreamreadStream (const word &, const bool valid=true)
 
void close ()
 
virtual label addWatch (const fileName &)
 
const labelListwatchIndices () const
 
labelListwatchIndices ()
 
virtual bool modified () const
 
virtual bool readIfModified ()
 
virtual bool write (const bool valid=true) 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)
 
- Public Member Functions inherited from dictionary
 ClassName ("dictionary")
 
 dictionary ()
 
 dictionary (const fileName &name)
 
 dictionary (const fileName &name, const dictionary &parentDict, Istream &is, bool keepHeader=false)
 
 dictionary (Istream &is)
 
 dictionary (Istream &is, bool keepHeader)
 
 dictionary (const dictionary &parentDict, const dictionary &dict)
 
 dictionary (const dictionary &dict)
 
 dictionary (const dictionary *dict)
 
 dictionary (const dictionary &parentDict, dictionary &&dict)
 
 dictionary (dictionary &&dict)
 
autoPtr< dictionaryclone () const
 
virtual ~dictionary ()
 
const fileNamename () const noexcept
 
fileNamename () noexcept
 
word dictName () const
 
fileName relativeName (const bool caseTag=false) const
 
bool isNullDict () const noexcept
 
const dictionaryparent () const noexcept
 
const dictionarytopDict () const
 
label startLineNumber () const
 
label endLineNumber () const
 
SHA1Digest digest () const
 
tokenList tokens () const
 
bool found (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
entryfindEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 
const entryfindEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
const entryfindScoped (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
dictionaryfindDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 
const dictionaryfindDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
const entrylookupEntry (const word &keyword, enum keyType::option matchOpt) const
 
ITstreamlookup (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T get (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T getOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T getOrAdd (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)
 
template<class T >
bool readEntry (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const
 
template<class T >
bool readIfPresent (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T , class Predicate >
T getCheck (const word &keyword, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T , class Predicate >
T getCheckOrDefault (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T , class Predicate >
T getCheckOrAdd (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX)
 
template<class T , class Predicate >
bool readCheck (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const
 
template<class T , class Predicate >
bool readCheckIfPresent (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 
bool isDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
const dictionarysubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
dictionarysubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 
dictionarysubDictOrAdd (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 
dictionary subOrEmptyDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX, const bool mandatory=false) const
 
const dictionaryoptionalSubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
wordList toc () const
 
wordList sortedToc () const
 
template<class Compare >
wordList sortedToc (const Compare &comp) const
 
List< keyTypekeys (bool patterns=false) const
 
bool substituteKeyword (const word &keyword, bool mergeEntry=false)
 
bool substituteScopedKeyword (const word &keyword, bool mergeEntry=false)
 
entryadd (entry *entryPtr, bool mergeEntry=false)
 
entryadd (const entry &e, bool mergeEntry=false)
 
entryadd (const keyType &k, const word &v, bool overwrite=false)
 
entryadd (const keyType &k, const string &v, bool overwrite=false)
 
entryadd (const keyType &k, const label v, bool overwrite=false)
 
entryadd (const keyType &k, const scalar v, bool overwrite=false)
 
entryadd (const keyType &k, const dictionary &d, bool mergeEntry=false)
 
template<class T >
entryadd (const keyType &k, const T &v, bool overwrite=false)
 
entryset (entry *entryPtr)
 
entryset (const entry &e)
 
entryset (const keyType &k, const dictionary &v)
 
template<class T >
entryset (const keyType &k, const T &v)
 
bool remove (const word &keyword)
 
bool changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool overwrite=false)
 
bool merge (const dictionary &dict)
 
void clear ()
 
void transfer (dictionary &dict)
 
void checkITstream (const ITstream &is, const word &keyword) const
 
bool read (Istream &is)
 
bool read (Istream &is, bool keepHeader)
 
void writeEntry (Ostream &os) const
 
void writeEntry (const keyType &keyword, Ostream &os) const
 
void writeEntries (Ostream &os, const bool extraNewLine=false) const
 
void write (Ostream &os, const bool subDict=true) const
 
const_searcher csearch (const word &keyword, enum keyType::option=keyType::REGEX) const
 
const_searcher search (const word &keyword, enum keyType::option=keyType::REGEX) const
 
searcher search (const word &keyword, enum keyType::option=keyType::REGEX)
 
const_searcher csearchScoped (const word &keyword, enum keyType::option) const
 
const_searcher searchScoped (const word &keyword, enum keyType::option) const
 
searcher searchScoped (const word &keyword, enum keyType::option)
 
const dictionarycfindScopedDict (const fileName &dictPath) const
 
const dictionaryfindScopedDict (const fileName &dictPath) const
 
dictionaryfindScopedDict (const fileName &dictPath)
 
dictionarymakeScopedDict (const fileName &dictPath)
 
const_searcher csearchCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
 
bool foundCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
 
const entryfindCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const
 
const entrylookupEntryCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const
 
ITstreamlookupCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
 
template<class T >
T getCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
 
template<class T >
T getOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option=keyType::REGEX) const
 
template<class T >
bool readCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX, bool mandatory=true) const
 
template<class T >
bool readIfPresentCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX) const
 
void operator= (const dictionary &rhs)
 
void operator+= (const dictionary &rhs)
 
void operator|= (const dictionary &rhs)
 
void operator<<= (const dictionary &rhs)
 
template<class T >
T lookupOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T lookupOrAddDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)
 
template<class T >
T lookupOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 
ITstreamoperator[] (const word &keyword) const
 
bool found (const word &keyword, bool recursive, bool patternMatch=true) const
 
entrylookupEntryPtr (const word &keyword, bool recursive, bool patternMatch)
 
const entrylookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
 
const entrylookupScopedEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
 
const dictionarysubDictPtr (const word &keyword) const
 
dictionarysubDictPtr (const word &keyword)
 
const entrylookupEntry (const word &keyword, bool recursive, bool patternMatch) const
 
ITstreamlookup (const word &keyword, bool recursive, bool patternMatch=true) const
 
template<class T >
T lookupOrDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) const
 
template<class T >
T lookupOrAddDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true)
 
template<class T >
bool readIfPresent (const word &keyword, T &val, bool recursive, bool patternMatch=true) const
 
template<class T >
T lookupType (const word &keyword, bool recursive=false, bool patternMatch=true) const
 
bool getBool (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< bool >(const word&, keyType::option) More...
 
label getLabel (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< label >(const word&, keyType::option) More...
 
scalar getScalar (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< scalar >(const word&, keyType::option) More...
 
string getString (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< string >(const word&, keyType::option) More...
 
word getWord (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< word >(const word&, keyType::option) More...
 
fileName getFileName (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< fileName >(const word&, keyType::option) More...
 
template<class Compare >
Foam::wordList sortedToc (const Compare &comp) const
 
template<class T >
Foam::entryadd (const keyType &k, const T &v, bool overwrite)
 
template<class T >
Foam::entryset (const keyType &k, const T &v)
 
- Public Member Functions inherited from ILList
 ILList ()=default
 
 ILList (T *item)
 
 ILList (Istream &is)
 
 ILList (const ILList< LListBase, T > &lst)
 
 ILList (ILList< LListBase, T > &&lst)
 
template<class CloneArg >
 ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
 
template<class INew >
 ILList (Istream &is, const INew &inew)
 
 ~ILList ()
 
bool eraseHead ()
 
bool erase (T *item)
 
void clear ()
 
void transfer (ILList< LListBase, T > &lst)
 
void operator= (const ILList< LListBase, T > &lst)
 
void operator= (ILList< LListBase, T > &&lst)
 

Protected Attributes

word cmptName_
 
direction cmpt_
 
pointScalarField pointMotionU_
 

Additional Inherited Members

- 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 }
 
- Public Types inherited from dictionary
typedef Searcher< true > const_searcher
 
typedef Searcher< false > searcher
 
- Static Public Member Functions inherited from motionSolver
static autoPtr< motionSolverNew (const polyMesh &)
 
static autoPtr< motionSolverNew (const polyMesh &, const IOdictionary &)
 
- 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)
 
- Static Public Member Functions inherited from dictionary
static int reportOptional () noexcept
 
static int reportOptional (const int level) noexcept
 
static autoPtr< dictionaryNew (Istream &is)
 
- Public Attributes inherited from dictionary
friend const_searcher
 
friend searcher
 
- Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypesfileCheckTypesNames
 
static char scopeSeparator
 
static fileCheckTypes fileModificationChecking
 
static float fileModificationSkew
 
static int maxFileModificationPolls
 
- Static Public Attributes inherited from dictionary
static int writeOptionalEntries
 
static const dictionary null
 
static refPtr< OSstreamreportingOutput
 
- 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 motionSolver
static IOobject stealRegistration (const IOdictionary &dict)
 
- 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

Virtual base class for velocity motion solver.

The boundary displacement is set as a boundary condition on the pointMotionUX pointScalarField.

Source files

Definition at line 52 of file componentVelocityMotionSolver.H.

Constructor & Destructor Documentation

◆ componentVelocityMotionSolver()

componentVelocityMotionSolver ( const polyMesh mesh,
const IOdictionary dict,
const word type 
)

Definition at line 65 of file componentVelocityMotionSolver.C.

◆ ~componentVelocityMotionSolver()

Definition at line 91 of file componentVelocityMotionSolver.C.

Member Function Documentation

◆ TypeName()

TypeName ( "componentVelocityMotionSolver"  )

◆ pointMotionU()

pointScalarField& pointMotionU ( )
inline

◆ movePoints()

void movePoints ( const pointField p)
virtual

Implements motionSolver.

Definition at line 97 of file componentVelocityMotionSolver.C.

◆ updateMesh()

void updateMesh ( const mapPolyMesh mpm)
virtual

Implements motionSolver.

Reimplemented in velocityComponentLaplacianFvMotionSolver.

Definition at line 103 of file componentVelocityMotionSolver.C.

References motionSolver::updateMesh().

Referenced by velocityComponentLaplacianFvMotionSolver::updateMesh().

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

Member Data Documentation

◆ cmptName_

word cmptName_
protected

Definition at line 61 of file componentVelocityMotionSolver.H.

◆ cmpt_

direction cmpt_
protected

Definition at line 64 of file componentVelocityMotionSolver.H.

◆ pointMotionU_

pointScalarField pointMotionU_
mutableprotected

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