Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
cloud Class Reference

A cloud is a registry collection of lagrangian particles. More...

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

Public Types

enum  geometryType { COORDINATES, POSITIONS }
 
- 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 HashTable< regIOobject * >
typedef HashTable< T, Key, Hashthis_type
 
typedef Key key_type
 
typedef T mapped_type
 
typedef T value_type
 
typedef Hash hasher
 
typedef Tpointer
 
typedef Treference
 
typedef label difference_type
 
typedef label size_type
 
using key_iterator = key_iterator_base< iterator >
 
using const_key_iterator = key_iterator_base< const_iterator >
 

Public Member Functions

 TypeName ("cloud")
 
 cloud (const objectRegistry &obr)
 
 cloud (const objectRegistry &obr, const word &cloudName)
 
virtual ~cloud ()=default
 
virtual label nParcels () const
 
virtual void autoMap (const mapPolyMesh &)
 
virtual void readObjects (const objectRegistry &obr)
 
virtual void writeObjects (objectRegistry &obr) const
 
template<class Type >
Foam::IOField< Type > & createIOField (const word &fieldName, const label nParticle, objectRegistry &obr)
 
- Public Member Functions inherited from objectRegistry
 TypeName ("objectRegistry")
 
 objectRegistry (const Time &db, const label nObjects=128)
 
 objectRegistry (const IOobject &io, const label nObjects=128)
 
virtual ~objectRegistry ()
 
const objectRegistrythisDb () const noexcept
 
const objectRegistryparent () const noexcept
 
const Timetime () const noexcept
 
bool isTimeDb () const noexcept
 
virtual const fileNamedbDir () const
 
HashTable< wordHashSetclasses () const
 
template<class MatchPredicate >
HashTable< wordHashSetclasses (const MatchPredicate &matchName) const
 
label count (const char *clsName) const
 
template<class MatchPredicate >
label count (const MatchPredicate &matchClass) const
 
template<class MatchPredicate1 , class MatchPredicate2 >
label count (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const
 
template<class Type >
label count (const bool strict=false) const
 
template<class Type , class MatchPredicate >
label count (const MatchPredicate &matchName) const
 
wordList names () const
 
wordList names (const char *clsName) const
 
template<class MatchPredicate >
wordList names (const MatchPredicate &matchClass) const
 
template<class MatchPredicate1 , class MatchPredicate2 >
wordList names (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const
 
template<class Type >
wordList names () const
 
template<class Type , class MatchPredicate >
wordList names (const MatchPredicate &matchName) const
 
wordList sortedNames () const
 
wordList sortedNames (const char *clsName) const
 
template<class MatchPredicate >
wordList sortedNames (const MatchPredicate &matchClass) const
 
template<class MatchPredicate1 , class MatchPredicate2 >
wordList sortedNames (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const
 
template<class Type >
wordList sortedNames () const
 
template<class Type , class MatchPredicate >
wordList sortedNames (const MatchPredicate &matchName) const
 
const objectRegistrysubRegistry (const word &name, const bool forceCreate=false, const bool recursive=false) const
 
template<class Type >
HashTable< const Type * > lookupClass (const bool strict=false) const
 
template<class Type >
HashTable< Type * > lookupClass (const bool strict=false)
 
const regIOobjectcfindIOobject (const word &name, const bool recursive=false) const
 
bool found (const word &name, const bool recursive=false) const
 
template<class Type >
bool foundObject (const word &name, const bool recursive=false) const
 
template<class Type >
const Type * cfindObject (const word &name, const bool recursive=false) const
 
template<class Type >
const Type * findObject (const word &name, const bool recursive=false) const
 
template<class Type >
Type * findObject (const word &name, const bool recursive=false)
 
template<class Type >
Type * getObjectPtr (const word &name, const bool recursive=false) const
 
template<class Type >
const Type & lookupObject (const word &name, const bool recursive=false) const
 
template<class Type >
Type & lookupObjectRef (const word &name, const bool recursive=false) const
 
label getEvent () const
 
bool checkIn (regIOobject *io) const
 
bool checkIn (regIOobject &io) const
 
bool checkOut (regIOobject *io) const
 
bool checkOut (regIOobject &io) const
 
bool checkOut (const word &key) const
 
void clear ()
 
void clearStorage ()
 
bool erase (const iterator &iter)
 
bool erase (const word &key)
 
label erase (std::initializer_list< word > keys)
 
label erase (const UList< word > &keys)
 
virtual void rename (const word &newName)
 
virtual bool modified () const
 
void readModifiedObjects ()
 
virtual bool readIfModified ()
 
virtual bool writeData (Ostream &) const
 
virtual bool writeObject (IOstreamOption streamOpt, const bool valid) const
 
template<class Type >
const Type * lookupObjectPtr (const word &name, bool recursive=false) const
 
template<class Type >
Type * lookupObjectRefPtr (const word &name, bool recursive=false) const
 
template<class MatchPredicate >
Foam::HashTable< Foam::wordHashSetclassesImpl (const objectRegistry &list, const MatchPredicate &matchName)
 
template<class MatchPredicate1 , class MatchPredicate2 >
Foam::label countImpl (const objectRegistry &list, const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName)
 
template<class Type , class MatchPredicate >
Foam::label countTypeImpl (const objectRegistry &list, const MatchPredicate &matchName)
 
template<class MatchPredicate1 , class MatchPredicate2 >
Foam::wordList namesImpl (const objectRegistry &list, const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName, const bool doSort)
 
template<class Type , class MatchPredicate >
Foam::wordList namesTypeImpl (const objectRegistry &list, const MatchPredicate &matchName, const bool doSort)
 
template<class MatchPredicate >
Foam::HashTable< Foam::wordHashSetclasses (const MatchPredicate &matchName) const
 
template<class MatchPredicate >
Foam::label count (const MatchPredicate &matchClass) const
 
template<class MatchPredicate1 , class MatchPredicate2 >
Foam::label count (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const
 
template<class Type , class MatchPredicate >
Foam::label count (const MatchPredicate &matchName) const
 
template<class Type >
Foam::label count (const bool strict) const
 
template<class MatchPredicate >
Foam::wordList names (const MatchPredicate &matchClass) const
 
template<class MatchPredicate1 , class MatchPredicate2 >
Foam::wordList names (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const
 
template<class Type >
Foam::wordList names () const
 
template<class Type , class MatchPredicate >
Foam::wordList names (const MatchPredicate &matchName) const
 
template<class MatchPredicate >
Foam::wordList sortedNames (const MatchPredicate &matchClass) const
 
template<class MatchPredicate1 , class MatchPredicate2 >
Foam::wordList sortedNames (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const
 
template<class Type >
Foam::wordList sortedNames () const
 
template<class Type , class MatchPredicate >
Foam::wordList sortedNames (const MatchPredicate &matchName) 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")
 
 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 ()
 
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 readData (Istream &)
 
virtual bool read ()
 
virtual label addWatch (const fileName &)
 
const labelListwatchIndices () const
 
labelListwatchIndices ()
 
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)
 
- Public Member Functions inherited from HashTable< regIOobject * >
 HashTable ()
 
 HashTable (const label size)
 
 HashTable (Istream &is, const label size=128)
 
 HashTable (const this_type &ht)
 
 HashTable (this_type &&rhs)
 
 HashTable (std::initializer_list< std::pair< Key, T >> list)
 
 ~HashTable ()
 
label capacity () const noexcept
 
label size () const noexcept
 
bool empty () const noexcept
 
Tat (const Key &key)
 
const Tat (const Key &key) const
 
bool found (const Key &key) const
 
iterator find (const Key &key)
 
const_iterator find (const Key &key) const
 
const_iterator cfind (const Key &key) const
 
const Tlookup (const Key &key, const T &deflt) const
 
List< Key > toc () const
 
List< Key > sortedToc () const
 
List< Key > sortedToc (const Compare &comp) const
 
Foam::List< Key > sortedToc (const Compare &comp) const
 
List< Key > tocKeys (const UnaryPredicate &pred, const bool invert=false) const
 
Foam::List< Key > tocKeys (const UnaryPredicate &pred, const bool invert) const
 
List< Key > tocValues (const UnaryPredicate &pred, const bool invert=false) const
 
Foam::List< Key > tocValues (const UnaryPredicate &pred, const bool invert) const
 
List< Key > tocEntries (const BinaryPredicate &pred, const bool invert=false) const
 
Foam::List< Key > tocEntries (const BinaryPredicate &pred, const bool invert) const
 
label countKeys (const UnaryPredicate &pred, const bool invert=false) const
 
Foam::label countKeys (const UnaryPredicate &pred, const bool invert) const
 
label countValues (const UnaryPredicate &pred, const bool invert=false) const
 
Foam::label countValues (const UnaryPredicate &pred, const bool invert) const
 
label countEntries (const BinaryPredicate &pred, const bool invert=false) const
 
Foam::label countEntries (const BinaryPredicate &pred, const bool invert) const
 
bool emplace (const Key &key, Args &&... args)
 
bool emplace_set (const Key &key, Args &&... args)
 
bool insert (const Key &key, const T &obj)
 
bool insert (const Key &key, T &&obj)
 
bool set (const Key &key, const T &obj)
 
bool set (const Key &key, T &&obj)
 
bool erase (const iterator &iter)
 
bool erase (const Key &key)
 
label erase (const HashTable< AnyType, Key, AnyHash > &other)
 
label erase (std::initializer_list< Key > keys)
 
label erase (InputIter first, InputIter last)
 
label erase (const FixedList< Key, N > &keys)
 
label erase (const UList< Key > &keys)
 
Foam::label erase (InputIter first, InputIter last)
 
Foam::label erase (const FixedList< Key, N > &keys)
 
Foam::label erase (const HashTable< AnyType, Key, AnyHash > &other)
 
label retain (const HashTable< AnyType, Key, AnyHash > &other)
 
Foam::label retain (const HashTable< AnyType, Key, AnyHash > &other)
 
label filterKeys (const UnaryPredicate &pred, const bool pruning=false)
 
Foam::label filterKeys (const UnaryPredicate &pred, const bool pruning)
 
label filterValues (const UnaryPredicate &pred, const bool pruning=false)
 
Foam::label filterValues (const UnaryPredicate &pred, const bool pruning)
 
label filterEntries (const BinaryPredicate &pred, const bool pruning=false)
 
Foam::label filterEntries (const BinaryPredicate &pred, const bool pruning)
 
void resize (const label sz)
 
void clear ()
 
void clearStorage ()
 
void swap (HashTable< T, Key, Hash > &rhs)
 
void transfer (HashTable< T, Key, Hash > &rhs)
 
Toperator[] (const Key &key)
 
const Toperator[] (const Key &key) const
 
Toperator() (const Key &key)
 
Toperator() (const Key &key, const T &deflt)
 
void operator= (const this_type &rhs)
 
void operator= (std::initializer_list< std::pair< Key, T >> rhs)
 
void operator= (this_type &&rhs)
 
bool operator== (const this_type &rhs) const
 
bool operator!= (const this_type &rhs) const
 
this_typeoperator+= (const this_type &rhs)
 
const_iterator_pair< const_key_iterator, this_typekeys () const
 
iterator begin ()
 
const_iterator begin () const
 
const_iterator cbegin () const
 
iterator end () noexcept
 
const_iterator end () const noexcept
 
constexpr const_iterator cend () const noexcept
 
OstreamprintInfo (Ostream &os) const
 
OstreamwriteKeys (Ostream &os, const label shortLen=0) const
 

Static Public Member Functions

template<class Type >
static IOField< Type > & createIOField (const word &fieldName, const label nParticle, objectRegistry &obr)
 
template<class Type >
static const IOField< Type > * findIOField (const word &fieldName, const objectRegistry &obr)
 
static const IOField< point > * findIOPosition (const objectRegistry &obr)
 
template<class Type >
static const IOField< Type > & lookupIOField (const word &fieldName, const objectRegistry &obr)
 
- 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 Attributes

static const Enum< geometryTypegeometryTypeNames
 
static const word prefix
 
static word defaultName
 
- Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypesfileCheckTypesNames
 
static char scopeSeparator
 
static fileCheckTypes fileModificationChecking
 
static float fileModificationSkew
 
static int maxFileModificationPolls
 

Additional Inherited Members

- Public Attributes inherited from HashTable< regIOobject * >
const typedef Tconst_pointer
 
const typedef Tconst_reference
 
- 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)
 
- Protected Member Functions inherited from HashTable< regIOobject * >
bool iterator_erase (node_type *&entry, label &index)
 
- 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

A cloud is a registry collection of lagrangian particles.

Source files

Definition at line 53 of file cloud.H.

Member Enumeration Documentation

◆ geometryType

enum geometryType
strong
Enumerator
COORDINATES 

barycentric coordinates

POSITIONS 

positions

Definition at line 70 of file cloud.H.

Constructor & Destructor Documentation

◆ cloud() [1/2]

cloud ( const objectRegistry obr)
explicit

Definition at line 45 of file cloud.C.

◆ cloud() [2/2]

cloud ( const objectRegistry obr,
const word cloudName 
)

Definition at line 51 of file cloud.C.

◆ ~cloud()

virtual ~cloud ( )
virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "cloud"  )

◆ nParcels()

Foam::label nParcels ( ) const
virtual

Definition at line 70 of file cloud.C.

References NotImplemented.

Referenced by cloudInfo::write().

Here is the caller graph for this function:

◆ autoMap()

void autoMap ( const mapPolyMesh )
virtual

Definition at line 77 of file cloud.C.

References NotImplemented.

◆ readObjects()

void readObjects ( const objectRegistry obr)
virtual

Definition at line 83 of file cloud.C.

References NotImplemented.

◆ writeObjects()

void writeObjects ( objectRegistry obr) const
virtual

Definition at line 89 of file cloud.C.

References NotImplemented.

◆ createIOField() [1/2]

static IOField<Type>& createIOField ( const word fieldName,
const label  nParticle,
objectRegistry obr 
)
static

◆ findIOField()

static const IOField<Type>* findIOField ( const word fieldName,
const objectRegistry obr 
)
inlinestatic

Definition at line 138 of file cloud.H.

References objectRegistry::cfindObject().

Here is the call graph for this function:

◆ findIOPosition()

static const IOField<point>* findIOPosition ( const objectRegistry obr)
inlinestatic

Definition at line 149 of file cloud.H.

References objectRegistry::cfindObject().

Referenced by parcelSelection::calculateFilter(), and particle< Type >::readObjects().

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

◆ lookupIOField()

static const IOField<Type>& lookupIOField ( const word fieldName,
const objectRegistry obr 
)
inlinestatic

Definition at line 160 of file cloud.H.

References objectRegistry::lookupObject().

Here is the call graph for this function:

◆ createIOField() [2/2]

Foam::IOField<Type>& createIOField ( const word fieldName,
const label  nParticle,
objectRegistry obr 
)

Definition at line 27 of file cloudTemplates.C.

References objectRegistry::time(), and Time::timeName().

Here is the call graph for this function:

Member Data Documentation

◆ geometryTypeNames

const Foam::Enum< Foam::cloud::geometryType > geometryTypeNames
static

Definition at line 76 of file cloud.H.

◆ prefix

const Foam::word prefix
static

◆ defaultName

Foam::word defaultName
static

Definition at line 86 of file cloud.H.

Referenced by nearWallFields::calcAddressing(), dataCloud::read(), and vtkCloud::read().


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