cpuLoad Class Reference

Class to maintain a field of the CPU load per cell. More...

Inheritance diagram for cpuLoad:
Collaboration diagram for cpuLoad:

Public Member Functions

 TypeName ("cpuLoad")
 
 cpuLoad (const word &name, const polyMesh &mesh)
 Construct from mesh, name and switch. More...
 
 cpuLoad (const cpuLoad &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~cpuLoad ()
 Destructor. More...
 
virtual void resetCpuTime ()
 Reset the CPU time. More...
 
virtual void cpuTimeIncrement (const label celli)
 Cache the CPU time increment for celli. More...
 
virtual void reset ()
 Reset the CPU load field. More...
 
virtual bool movePoints ()
 Update for mesh motion. More...
 
virtual void distribute (const polyDistributionMap &map)
 Redistribute or update using the given distribution map. More...
 
virtual void topoChange (const polyTopoChangeMap &map)
 Update topology using the given map. More...
 
virtual void mapMesh (const polyMeshMap &map)
 Update from another mesh using the given map. More...
 
void operator= (const cpuLoad &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from optionalCpuLoad
 optionalCpuLoad ()
 Construct from mesh, name and switch. More...
 
 optionalCpuLoad (const optionalCpuLoad &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~optionalCpuLoad ()
 Destructor. More...
 
void operator= (const optionalCpuLoad &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from DemandDrivenMeshObject< polyMesh, TopoChangeableMeshObject, cpuLoad >
virtual const wordtype () const
 Runtime type information. More...
 
virtual ~DemandDrivenMeshObject ()
 
const polyMeshmesh () const
 
virtual bool writeData (Foam::Ostream &) const
 Pure virtual writaData function. More...
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &, const bool isTime=false)
 Construct from IOobject. Optional flag for if IOobject is the. More...
 
 regIOobject (const regIOobject &)
 Copy constructor. More...
 
 regIOobject (const regIOobject &&)
 Move constructor. More...
 
 regIOobject (const regIOobject &, bool registerCopy)
 Copy constructor, transferring registry registration to copy. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Copy constructor with new name, transferring registry registration. More...
 
 regIOobject (const IOobject &, const regIOobject &)
 Copy constructor with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
virtual bool global () const
 Return true if object is global, i.e. same for all processors. More...
 
virtual bool globalFile () const
 Return true if object is global, i.e. same for all processors. More...
 
const fileNamecaseName () const
 
fileName path () const
 Return complete path. More...
 
fileName objectPath () const
 Return complete path + object name. More...
 
fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool checkIn ()
 Add object to registry. More...
 
bool checkOut ()
 Remove object from registry. More...
 
void addWatch ()
 Add file watch on object (if registered and READ_IF_MODIFIED) More...
 
bool registered () const
 Is this object registered with the registry? More...
 
bool ownedByRegistry () const
 Is this object owned by the registry? More...
 
void store ()
 Transfer ownership of this object to its registry. More...
 
void release ()
 Release ownership of this object from its registry. More...
 
label eventNo () const
 Event number at last update. More...
 
labeleventNo ()
 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 up to date (obviously) More...
 
virtual void rename (const word &newName)
 Rename. More...
 
bool headerOk ()
 Read and check header info. More...
 
IstreamreadStream (const word &, const bool read=true)
 Return Istream and check object type against that given. More...
 
void close ()
 Close Istream. More...
 
virtual bool readData (Istream &)
 Virtual readData function. More...
 
virtual bool read ()
 Read object. More...
 
const labelListwatchIndices () const
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 Return file-monitoring handles. More...
 
virtual bool modified () const
 Return true if the object's file (or files for objectRegistry) More...
 
virtual bool dependenciesModified () const
 Return true if the object's dependencies have been modified. More...
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const
 Write using given format, version and compression. More...
 
virtual bool write (const bool write=true) const
 Write using setting from DB. More...
 
void operator= (const IOobject &)
 Assign to IOobject. More...
 
void operator= (const regIOobject &)=delete
 Disallow default assignment. More...
 
const fileNamecaseName (const bool global) const
 
fileName path (const bool global) const
 Return complete path including the processor sub-directory. More...
 
fileName objectPath (const bool global) const
 Return complete path + object name including the processor. More...
 
fileName filePath (const word &typeName, const bool global) const
 Return complete path + object name if the file exists. More...
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 Construct from copy resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Construct from copy resetting name. More...
 
 IOobject (const IOobject &io)=default
 Copy constructor. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
virtual ~IOobject ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
wordheaderClassName ()
 Return name of the class name read from header. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () const
 Return the optional note. More...
 
bool & registerObject ()
 Register object created from this IOobject with registry if true. More...
 
bool registerObject () const
 Register object created from this IOobject with registry if true. More...
 
readOption readOpt () const
 
readOptionreadOpt ()
 
writeOption writeOpt () const
 
writeOptionwriteOpt ()
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const
 
const fileNamecaseName (const bool global) const
 
fileNameinstance () const
 Return the instance directory, constant, system, <time> etc. More...
 
void updateInstance () const
 If the instance is a time directory update to the current time. More...
 
const fileNamelocal () const
 
fileName path (const bool global) const
 Return complete path including the processor sub-directory. More...
 
fileName objectPath (const bool global) const
 Return complete path + object name including the processor. More...
 
fileName relativePath () const
 Return the path relative to the case directory. More...
 
fileName relativeObjectPath () const
 Return complete relativePath + object name. More...
 
fileName filePath (const word &typeName, const bool global) const
 Return complete path + object name if the file exists. More...
 
bool readHeader (Istream &)
 Read header. More...
 
bool headerOk ()
 Read header of local object without type-checking. More...
 
template<class Type >
void warnNoRereading () const
 Helper: warn that type does not support re-reading. More...
 
bool writeHeader (Ostream &) const
 Write header. More...
 
bool writeHeader (Ostream &, const word &objectType) const
 Write header. Allow override of type. More...
 
bool good () const
 
bool bad () const
 
InfoProxy< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 
- Public Member Functions inherited from TopoChangeableMeshObject< Mesh >
template<class Type >
 TopoChangeableMeshObject (Type &mo)
 
- Public Member Functions inherited from DistributeableMeshObject< Mesh >
template<class Type >
 DistributeableMeshObject (Type &mo)
 
- Public Member Functions inherited from MoveableMeshObject< Mesh >
template<class Type >
 MoveableMeshObject (Type &mo)
 
- Public Member Functions inherited from DeletableMeshObject< Mesh >
template<class Type >
 DeletableMeshObject (Type &mo)
 
virtual ~DeletableMeshObject ()=default
 Virtual destructor to make class polymorphic. More...
 
- Public Member Functions inherited from Field< scalar >
 Field ()
 Construct null. More...
 
 Field (const label)
 Construct given size. More...
 
 Field (const label, const scalar &)
 Construct given size and initial value. More...
 
 Field (const label, const zero)
 Construct given size and initialised to zero. More...
 
 Field (const UList< scalar > &)
 Copy constructor of a UList<Type> More...
 
 Field (List< scalar > &&)
 Mover constructor transferring the List contents. More...
 
 Field (const UIndirectList< scalar > &)
 Copy constructor of a UIndirectList<Type> More...
 
 Field (const Field< scalar > &)
 Copy constructor. More...
 
 Field (Field< scalar > &, bool reuse)
 Copy constructor or reuse as specified. More...
 
 Field (Field< scalar > &&)
 Move constructor transferring the Field contents. More...
 
 Field (const tmp< Field< scalar >> &)
 Copy constructor of tmp<Field> More...
 
 Field (const UList< scalar > &mapF, const labelUList &mapAddressing)
 Construct by 1 to 1 mapping from the given field. More...
 
 Field (const tmp< Field< scalar >> &tmapF, const labelUList &mapAddressing)
 Construct by 1 to 1 mapping from the given tmp field. More...
 
 Field (const UList< scalar > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
 Construct by interpolative mapping from the given field. More...
 
 Field (const tmp< Field< scalar >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
 Construct by interpolative mapping from the given tmp field. More...
 
 Field (Istream &)
 Construct from Istream. More...
 
 Field (const word &keyword, const dictionary &, const label size)
 Construct from a dictionary entry. More...
 
 Field (const word &keyword, const unitConversion &, const dictionary &, const label size)
 Construct from a dictionary entry with unit conversion. More...
 
tmp< Field< scalar > > clone () const
 Clone. More...
 
void map (const UList< scalar > &mapF, const labelUList &mapAddressing)
 1 to 1 map from the given field More...
 
void map (const tmp< Field< scalar >> &tmapF, const labelUList &mapAddressing)
 1 to 1 map from the given tmp field More...
 
void map (const UList< scalar > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
 Interpolative map from the given field. More...
 
void map (const tmp< Field< scalar >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
 Interpolative map from the given tmp field. More...
 
void rmap (const UList< scalar > &mapF, const labelUList &mapAddressing)
 1 to 1 reverse-map from the given field More...
 
void rmap (const tmp< Field< scalar >> &tmapF, const labelUList &mapAddressing)
 1 to 1 reverse-map from the given tmp field More...
 
void rmap (const UList< scalar > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)
 Interpolative reverse map from the given field. More...
 
void rmap (const tmp< Field< scalar >> &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)
 Interpolative reverse map from the given tmp field. More...
 
void reset (const Field< scalar > &)
 Reset the field values to the given field. More...
 
void negate ()
 Negate this field. More...
 
tmp< Field< cmptType > > component (const direction) const
 Return a component field of the field. More...
 
void replace (const direction, const UList< cmptType > &)
 Replace a component field of the field. More...
 
void replace (const direction, const tmp< Field< cmptType >> &)
 Replace a component field of the field. More...
 
void replace (const direction, const cmptType &)
 Replace a component field of the field. More...
 
VSForm block (const label start) const
 
tmp< Field< scalar > > T () const
 Return the field transpose (only defined for second rank tensors) More...
 
void operator= (const Field< scalar > &)
 
void operator= (Field< scalar > &&)
 
void operator= (const UList< scalar > &)
 
void operator= (List< scalar > &&)
 
void operator= (const SubField< scalar > &)
 
void operator= (const tmp< Field< scalar >> &)
 
void operator= (const scalar &)
 
void operator= (const zero)
 
void operator= (const VectorSpace< Form, Cmpt, nCmpt > &)
 
void operator= (const tmp< Field > &rhs)
 
void operator+= (const UList< scalar > &)
 
void operator+= (const tmp< Field< scalar >> &)
 
void operator+= (const scalar &)
 
void operator-= (const UList< scalar > &)
 
void operator-= (const tmp< Field< scalar >> &)
 
void operator-= (const scalar &)
 
void operator*= (const UList< scalar > &)
 
void operator*= (const tmp< Field< scalar >> &)
 
void operator*= (const scalar &)
 
void operator/= (const UList< scalar > &)
 
void operator/= (const tmp< Field< scalar >> &)
 
void operator/= (const scalar &)
 
- Public Member Functions inherited from refCount
int count () const
 Return the current reference count. More...
 
bool unique () const
 Return true if the reference count is zero. More...
 
void operator++ ()
 Increment the reference count. More...
 
void operator++ (int)
 Increment the reference count. More...
 
void operator-- ()
 Decrement the reference count. More...
 
void operator-- (int)
 Decrement the reference count. More...
 
void operator= (const refCount &)=delete
 Disallow bitwise assignment. More...
 
- Public Member Functions inherited from List< scalar >
 List ()
 Null constructor. More...
 
 List (const label)
 Construct with given size. More...
 
 List (const label, const scalar &)
 Construct with given size and value for all elements. More...
 
 List (const label, const zero)
 Construct with given size initialising all elements to zero. More...
 
 List (const List< scalar > &)
 Copy constructor. More...
 
 List (const UList< T2 > &)
 Copy constructor from list containing another type. More...
 
 List (List< scalar > &&)
 Move constructor. More...
 
 List (List< scalar > &, bool reuse)
 Construct as copy or reuse as specified. More...
 
 List (const UList< scalar > &, const labelUList &mapAddressing)
 Construct as subset. More...
 
 List (InputIterator first, InputIterator last)
 Construct given start and end iterators. More...
 
 List (const FixedList< scalar, Size > &)
 Construct as copy of FixedList<T, Size> More...
 
 List (const PtrList< scalar > &)
 Construct as copy of PtrList<T> More...
 
 List (const SLList< scalar > &)
 Construct as copy of SLList<T> More...
 
 List (const UIndirectList< scalar > &)
 Construct as copy of UIndirectList<T> More...
 
 List (const BiIndirectList< scalar > &)
 Construct as copy of BiIndirectList<T> More...
 
 List (std::initializer_list< scalar >)
 Construct from an initialiser list. More...
 
 List (Istream &)
 Construct from Istream. More...
 
label size () const
 Return the number of elements in the UList. More...
 
autoPtr< List< scalar > > clone () const
 Clone. More...
 
 ~List ()
 Destructor. More...
 
void resize (const label)
 Alias for setSize(const label) More...
 
void resize (const label, const scalar &)
 Alias for setSize(const label, const T&) More...
 
void setSize (const label)
 Reset size of List. More...
 
void setSize (const label, const scalar &)
 Reset size of List and value for new elements. More...
 
void clear ()
 Clear the list, i.e. set size to zero. More...
 
void append (const scalar &)
 Append an element at the end of the list. More...
 
void append (const UList< scalar > &)
 Append a List at the end of this list. More...
 
void append (const UIndirectList< scalar > &)
 Append a UIndirectList at the end of this list. More...
 
void transfer (List< scalar > &)
 Transfer the contents of the argument List into this list. More...
 
void transfer (DynamicList< scalar, SizeInc, SizeMult, SizeDiv > &)
 Transfer the contents of the argument List into this list. More...
 
void transfer (SortableList< scalar > &)
 Transfer the contents of the argument List into this list. More...
 
scalar & newElmt (const label)
 Return subscript-checked element of UList. More...
 
void shallowCopy (const UList< scalar > &)=delete
 Disallow implicit shallowCopy. More...
 
void operator= (const UList< scalar > &)
 Assignment to UList operator. Takes linear time. More...
 
void operator= (const List< scalar > &)
 Assignment operator. Takes linear time. More...
 
void operator= (List< scalar > &&)
 Move assignment operator. More...
 
void operator= (const SLList< scalar > &)
 Assignment to SLList operator. Takes linear time. More...
 
void operator= (const UIndirectList< scalar > &)
 Assignment to UIndirectList operator. Takes linear time. More...
 
void operator= (const BiIndirectList< scalar > &)
 Assignment to BiIndirectList operator. Takes linear time. More...
 
void operator= (std::initializer_list< scalar >)
 Assignment to an initialiser list. More...
 
void operator= (const scalar &)
 Assignment of all entries to the given value. More...
 
void operator= (const zero)
 Assignment of all entries to zero. More...
 
- Public Member Functions inherited from UList< T >
 UList ()
 Null constructor. More...
 
 UList (T *__restrict__ v, label size)
 Construct from components. More...
 
 UList (const UList< T > &)=default
 Copy construct. More...
 
label fcIndex (const label i) const
 Return the forward circular index, i.e. the next index. More...
 
label rcIndex (const label i) const
 Return the reverse circular index, i.e. the previous index. More...
 
std::streamsize byteSize () const
 Return the binary size in number of characters of the UList. More...
 
const Tcdata () const
 Return a const pointer to the first data element,. More...
 
Tdata ()
 Return a pointer to the first data element,. More...
 
Tfirst ()
 Return the first element of the list. More...
 
const Tfirst () const
 Return first element of the list. More...
 
Tlast ()
 Return the last element of the list. More...
 
const Tlast () const
 Return the last element of the list. More...
 
void checkStart (const label start) const
 Check start is within valid range (0 ... size-1) More...
 
void checkSize (const label size) const
 Check size is within valid range (0 ... size) More...
 
void checkIndex (const label i) const
 Check index i is within valid range (0 ... size-1) More...
 
void shallowCopy (const UList< T > &)
 Copy the pointer held by the given UList. More...
 
void deepCopy (const UList< T > &)
 Copy elements of the given UList. More...
 
Toperator[] (const label)
 Return element of UList. More...
 
const Toperator[] (const label) const
 Return element of constant UList. More...
 
 operator const Foam::List< T > & () const
 Allow cast to a const List<T>&. More...
 
void operator= (const T &)
 Assignment of all entries to the given value. More...
 
void operator= (const zero)
 Assignment of all entries to zero. More...
 
iterator begin ()
 Return an iterator to begin traversing the UList. More...
 
iterator end ()
 Return an iterator to end traversing the UList. More...
 
const_iterator cbegin () const
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator cend () const
 Return const_iterator to end traversing the constant UList. More...
 
const_iterator begin () const
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator end () const
 Return const_iterator to end traversing the constant UList. More...
 
reverse_iterator rbegin ()
 Return reverse_iterator to begin reverse traversing the UList. More...
 
reverse_iterator rend ()
 Return reverse_iterator to end reverse traversing the UList. More...
 
const_reverse_iterator crbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList. More...
 
const_reverse_iterator crend () const
 Return const_reverse_iterator to end reverse traversing the UList. More...
 
const_reverse_iterator rbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList. More...
 
const_reverse_iterator rend () const
 Return const_reverse_iterator to end reverse traversing the UList. More...
 
label size () const
 Return the number of elements in the UList. More...
 
label max_size () const
 Return size of the largest possible UList. More...
 
bool empty () const
 Return true if the UList is empty (ie, size() is zero) More...
 
void swap (UList< T > &)
 Swap two ULists of the same type in constant time. More...
 
bool operator== (const UList< T > &) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UList< T > &) const
 The opposite of the equality operation. Takes linear time. More...
 
bool operator< (const UList< T > &) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator> (const UList< T > &) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator<= (const UList< T > &) const
 Return true if !(a > b). Takes linear time. More...
 
bool operator>= (const UList< T > &) const
 Return true if !(a < b). Takes linear time. More...
 
const bool & operator[] (const label i) const
 

Additional Inherited Members

- Public Types inherited from IOobject
enum  objectState { GOOD , BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  readOption { MUST_READ , MUST_READ_IF_MODIFIED , READ_IF_PRESENT , NO_READ }
 Enumeration defining the read options. More...
 
enum  writeOption { AUTO_WRITE = 0 , NO_WRITE = 1 }
 Enumeration defining the write options. More...
 
enum  fileCheckTypes { timeStamp , timeStampMaster , inotify , inotifyMaster }
 Enumeration defining the file checking options. More...
 
- Public Types inherited from Field< scalar >
typedef pTraits< scalar >::cmptType cmptType
 Component type. More...
 
typedef SubField< scalar > subField
 Declare type of subField. More...
 
- Public Types inherited from List< scalar >
typedef SubList< scalar > subList
 Declare type of subList. More...
 
- Public Types inherited from UList< T >
typedef T value_type
 Type of values the UList contains. More...
 
typedef Treference
 Type that can be used for storing into. More...
 
typedef const Tconst_reference
 Type that can be used for storing into. More...
 
typedef label difference_type
 The type that can represent the difference between any two. More...
 
typedef label size_type
 The type that can represent the size of a UList. More...
 
typedef Titerator
 Random access iterator for traversing UList. More...
 
typedef const Tconst_iterator
 Random access iterator for traversing UList. More...
 
typedef std::reverse_iterator< iteratorreverse_iterator
 Reverse iterator for reverse traversal of UList. More...
 
typedef std::reverse_iterator< const_iteratorconst_reverse_iterator
 Reverse iterator for reverse traversal of constant UList. More...
 
- Static Public Member Functions inherited from optionalCpuLoad
static optionalCpuLoadNew (const word &name, const polyMesh &mesh, const bool loadBalancing)
 Construct from polyMesh if loadBalancing is true. More...
 
- Static Public Member Functions inherited from DemandDrivenMeshObject< polyMesh, TopoChangeableMeshObject, cpuLoad >
static cpuLoadNew (const word &name, const polyMesh &mesh)
 Construct and return the named DemandDrivenMeshObject. More...
 
static cpuLoadNew (const polyMesh &mesh)
 Construct and return the DemandDrivenMeshObject named Type::typeName. More...
 
static cpuLoadNew (const word &name, const polyMesh &mesh, const Args &... args)
 Construct and return the named DemandDrivenMeshObject. More...
 
static cpuLoadNew (const polyMesh &mesh, const Args &... args)
 Construct and return the DemandDrivenMeshObject named Type::typeName. More...
 
static bool found (const word &name, const polyMesh &mesh)
 Return true if the DemandDrivenMeshObject with the given name. More...
 
static bool found (const polyMesh &mesh)
 Return true if the DemandDrivenMeshObject named Type::typeName. More...
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *)
 Transfer ownership of the given object pointer to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &)
 Transfer ownership of the given object pointer to its registry. More...
 
- Static Public Member Functions inherited from IOobject
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 Split path into instance, local, name components. More...
 
template<class Name >
static word groupName (Name name, const word &group)
 
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...
 
template<class Stream >
static Stream & writeBanner (Stream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
template<class Stream >
static Stream & writeDivider (Stream &os)
 Write the standard file section divider. More...
 
template<class Stream >
static Stream & writeEndDivider (Stream &os)
 Write the standard end file divider. More...
 
- Static Public Member Functions inherited from Field< scalar >
static const Field< scalar > & null ()
 Return a null field. More...
 
static tmp< Field< scalar > > NewCalculatedType (const Field< Type2 > &f)
 Return a pointer to a new calculatedFvPatchFieldField created on. More...
 
- Static Public Member Functions inherited from List< scalar >
static const List< scalar > & null ()
 Return a null List. More...
 
- Static Public Member Functions inherited from UList< T >
static const UList< T > & null ()
 Return a null UList. More...
 
- Static Public Attributes inherited from regIOobject
static float fileModificationSkew
 
- Static Public Attributes inherited from IOobject
static constexpr const char * foamFile = "FoamFile"
 Keyword for the FoamFile header sub-dictionary. More...
 
static const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static fileCheckTypes fileModificationChecking
 Type of file modification checking. More...
 
- Static Public Attributes inherited from Field< scalar >
static const char *const typeName
 
- Protected Member Functions inherited from DemandDrivenMeshObject< polyMesh, TopoChangeableMeshObject, cpuLoad >
 DemandDrivenMeshObject (const IOobject &io, const polyMesh &mesh)
 Construct from mesh and IOobject. More...
 
 DemandDrivenMeshObject (const word &name, const polyMesh &mesh)
 Construct from mesh and name. More...
 
 DemandDrivenMeshObject (const polyMesh &mesh)
 Construct from mesh, the name is set to Type::typeName. More...
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName)
 Read header, check readOpt flags and read data if necessary. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &)
 Set the object state to bad. More...
 
template<class Type >
bool typeHeaderOk (const bool checkType)
 Read header using typeGlobalFile to find file. More...
 
- Protected Member Functions inherited from refCount
 refCount ()
 Construct null initialising count to 0. More...
 
 refCount (const refCount &)=delete
 Disallow copy. More...
 
- Protected Member Functions inherited from List< scalar >
void size (const label)
 Override size to be inconsistent with allocated storage. More...
 

Detailed Description

Class to maintain a field of the CPU load per cell.

The optionalCpuLoad is a base-class for cpuLoad to simplify the implementation of optional CPU time caching. This is achieved via the optionalCpuLoad::New function which returns a optionalCpuLoad with dummy functions if loadBalancing is false otherwise it creates or looks-up and returns a cpuLoad with the given name.

Used for loadBalancing.

Source files

Definition at line 124 of file cpuLoad.H.

Constructor & Destructor Documentation

◆ cpuLoad() [1/2]

cpuLoad ( const word name,
const polyMesh mesh 
)

Construct from mesh, name and switch.

Definition at line 43 of file cpuLoad.C.

◆ cpuLoad() [2/2]

cpuLoad ( const cpuLoad )
delete

Disallow default bitwise copy construction.

◆ ~cpuLoad()

~cpuLoad ( )
virtual

Destructor.

Definition at line 56 of file cpuLoad.C.

Member Function Documentation

◆ TypeName()

TypeName ( "cpuLoad"  )

◆ resetCpuTime()

void resetCpuTime ( )
virtual

Reset the CPU time.

Reimplemented from optionalCpuLoad.

Definition at line 87 of file cpuLoad.C.

◆ cpuTimeIncrement()

void cpuTimeIncrement ( const label  celli)
virtual

Cache the CPU time increment for celli.

Reimplemented from optionalCpuLoad.

Definition at line 93 of file cpuLoad.C.

◆ reset()

void reset ( )
virtual

Reset the CPU load field.

Reimplemented from optionalCpuLoad.

Definition at line 99 of file cpuLoad.C.

References Field< scalar >::operator=().

Here is the call graph for this function:

◆ movePoints()

bool movePoints ( )
virtual

Update for mesh motion.

Implements MoveableMeshObject< Mesh >.

Definition at line 105 of file cpuLoad.C.

◆ distribute()

void distribute ( const polyDistributionMap map)
virtual

Redistribute or update using the given distribution map.

Implements DistributeableMeshObject< Mesh >.

Definition at line 125 of file cpuLoad.C.

References polyDistributionMap::mesh(), primitiveMesh::nCells(), and setSize().

Here is the call graph for this function:

◆ topoChange()

void topoChange ( const polyTopoChangeMap map)
virtual

Update topology using the given map.

Implements TopoChangeableMeshObject< Mesh >.

Definition at line 111 of file cpuLoad.C.

◆ mapMesh()

void mapMesh ( const polyMeshMap map)
virtual

Update from another mesh using the given map.

Implements TopoChangeableMeshObject< Mesh >.

Definition at line 118 of file cpuLoad.C.

References polyMeshMap::mesh(), primitiveMesh::nCells(), and setSize().

Here is the call graph for this function:

◆ operator=()

void operator= ( const cpuLoad )
delete

Disallow default bitwise assignment.


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