(Rough approximation of) cell aspect ratio More...
Public Member Functions | |
| TypeName ("cellAspectRatio") | |
| cellAspectRatio (const polyMesh &) | |
| Construct given an polyMesh. More... | |
| virtual | ~cellAspectRatio () |
| Destructor. More... | |
| virtual bool | movePoints () |
| Ignore mesh motion for now. More... | |
 Public Member Functions inherited from MeshObject< polyMesh, MoveableMeshObject, cellAspectRatio > | |
| MeshObject (const polyMesh &mesh) | |
| Construct on Mesh type. More... | |
| virtual | ~MeshObject ()=default |
| Destructor. More... | |
| const polyMesh & | mesh () const |
| virtual bool | writeData (Ostream &os) const |
| Public Member Functions inherited from MoveableMeshObject< polyMesh > | |
| MoveableMeshObject (const word &typeName, const objectRegistry &obr) | |
| Construct from name and instance on registry. More... | |
| Public Member Functions inherited from GeometricMeshObject< polyMesh > | |
| GeometricMeshObject (const word &typeName, const objectRegistry &obr) | |
| Construct from name and instance on registry. More... | |
| Public Member Functions inherited from TopologicalMeshObject< polyMesh > | |
| TopologicalMeshObject (const word &typeName, const objectRegistry &obr) | |
| Construct from name and instance on registry. More... | |
| Public Member Functions inherited from meshObject | |
| ClassName ("meshObject") | |
| meshObject (const word &typeName, const objectRegistry &obr) | |
| Construct from name and instance on registry. More... | |
| Public Member Functions inherited from regIOobject | |
| TypeName ("regIOobject") | |
| Runtime type information. More... | |
| regIOobject (const IOobject &io, const bool isTimeObject=false) | |
| regIOobject (const regIOobject &rio) | |
| Copy construct. More... | |
| regIOobject (const regIOobject &rio, bool registerCopy) | |
| regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
| regIOobject (const IOobject &io, const regIOobject &rio) | |
| Copy construct with new IO parameters. More... | |
| virtual | ~regIOobject () |
| Destructor. More... | |
| bool | checkIn () |
| Add object to registry, if not already registered. More... | |
| bool | checkOut () |
| Remove all file watches and remove object from registry. More... | |
| virtual void | addWatch () |
| Add file watch on object (if registered and READ_IF_MODIFIED) More... | |
| bool | ownedByRegistry () const |
| Is this object owned by the registry? More... | |
| bool | store () |
| void | release (const bool unregister=false) |
| Release ownership of this object from its registry. More... | |
| label | eventNo () const |
| Event number at last update. More... | |
| label & | eventNo () |
| Event number at last update. More... | |
| bool | upToDate (const regIOobject &) const |
| Return true if up-to-date with respect to given object. More... | |
| bool | upToDate (const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More... | |
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More... | |
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More... | |
| void | setUpToDate () |
| Set as up-to-date. More... | |
| virtual void | rename (const word &newName) |
| Rename. More... | |
| const dictionary * | findMetaData () const noexcept |
| Return pointer to meta-data or nullptr. More... | |
| dictionary & | getMetaData () noexcept |
| Get or create meta-data. More... | |
| void | removeMetaData () |
| Remove meta-data. More... | |
| virtual void | updateMetaData () |
| Update internal meta-data (eg, prior to writing) More... | |
| virtual fileName | filePath () const |
| Return complete path + object name if the file exists. More... | |
| bool | headerOk () |
| Read and check header info. More... | |
| Istream & | readStream (const word &, const bool valid=true) |
| Return Istream and check object type against that given. More... | |
| void | close () |
| Close Istream. More... | |
| virtual bool | readData (Istream &) |
| Virtual readData function. More... | |
| virtual bool | read () |
| Read object. More... | |
| virtual label | addWatch (const fileName &) |
| Add file watch for fileName on object if not yet watched. More... | |
| const labelList & | watchIndices () const |
| Return file-monitoring handles. More... | |
| labelList & | watchIndices () |
| Return file-monitoring handles. More... | |
| virtual bool | modified () const |
| virtual bool | readIfModified () |
| Read object if modified (as set by call to modified) More... | |
| virtual bool | writeObject (IOstreamOption streamOpt, const bool valid) const |
| Write using stream options. More... | |
| virtual bool | write (const bool valid=true) const |
| Write using setting from DB. More... | |
| virtual bool | global () const |
| Is object global. More... | |
| void | operator= (const IOobject &io) |
| Copy assignment. More... | |
| virtual bool | writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const |
| Write using given format, version and compression. More... | |
| Public Member Functions inherited from IOobject | |
| TypeName ("IOobject") | |
| Declare type-name, virtual type (with debug switch) More... | |
| IOobject (const IOobject &)=default | |
| Copy construct. More... | |
| virtual | ~IOobject ()=default |
| Destructor. More... | |
| IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
| Construct from name, instance, registry, io options. More... | |
| IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
| Construct from name, instance, local, registry, io options. More... | |
| IOobject (const fileName &path, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
| Construct from path, registry, io options. More... | |
| IOobject (const IOobject &io, const objectRegistry ®istry) | |
| Copy construct, resetting registry. More... | |
| IOobject (const IOobject &io, const word &name) | |
| Copy construct, resetting name. More... | |
| IOobject (const IOobject &io, readOption, writeOption) | |
| Copy construct, resetting io options. More... | |
| autoPtr< IOobject > | clone () const |
| Clone. More... | |
| autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
| Clone resetting registry. More... | |
| const objectRegistry & | db () const noexcept |
| Return the local objectRegistry. More... | |
| const Time & | time () const |
| Return Time associated with the objectRegistry. More... | |
| const word & | name () const noexcept |
| Return name. More... | |
| const word & | headerClassName () const noexcept |
| Return name of the class name read from header. More... | |
| word & | headerClassName () noexcept |
| Return non-constant access to the class name read from header. More... | |
| const string & | note () const noexcept |
| Return the optional note. More... | |
| string & | note () noexcept |
| Return non-constant access to the optional note. More... | |
| bool | registerObject () const noexcept |
| Should object created with this IOobject be registered? More... | |
| bool | registerObject (bool on) noexcept |
| Change registration preference, return previous value. More... | |
| bool | globalObject () const noexcept |
| Is object same for all processors? More... | |
| bool | globalObject (bool on) noexcept |
| Change global-object status, return previous value. More... | |
| unsigned | labelByteSize () const noexcept |
| The sizeof (label) in bytes, possibly read from the header. More... | |
| unsigned | scalarByteSize () const noexcept |
| The sizeof (scalar) in bytes, possibly read from the header. More... | |
| bool | isHeaderClassName (const word &clsName) const |
| Test if headerClassName() equals the given class name. More... | |
| template<class Type > | |
| bool | isHeaderClassName () const |
| Test if headerClassName() equals Type::typeName. More... | |
| readOption | readOpt () const noexcept |
| The read option. More... | |
| readOption | readOpt (readOption opt) noexcept |
| Change the read option, return previous value. More... | |
| writeOption | writeOpt () const noexcept |
| The write option. More... | |
| writeOption | writeOpt (writeOption opt) noexcept |
| Change the write option, return previous value. More... | |
| word | group () const |
| Return group (extension part of name) More... | |
| word | member () const |
| Return member (name without the extension) More... | |
| const fileName & | rootPath () const |
| const fileName & | caseName () const |
| const fileName & | instance () const noexcept |
| fileName & | instance () noexcept |
| const fileName & | local () const noexcept |
| fileName | path () const |
| The complete path. More... | |
| fileName | path (const word &instance, const fileName &local=fileName::null) const |
| The complete path with alternative instance and local. More... | |
| fileName | objectPath () const |
| The complete path + object name. More... | |
| fileName | objectRelPath () const |
| The object path relative to the root. More... | |
| fileName | localFilePath (const word &typeName, const bool search=true) const |
| Helper for filePath that searches locally. More... | |
| fileName | globalFilePath (const word &typeName, const bool search=true) const |
| Helper for filePath that searches up if in parallel. More... | |
| IOstreamOption | parseHeader (const dictionary &headerDict) |
| bool | readHeader (Istream &is) |
| bool | readHeader (dictionary &headerDict, Istream &is) |
| template<class Type > | |
| bool | typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true) |
| Read header (uses typeFilePath to find file) and check its info. More... | |
| template<class Type > | |
| void | warnNoRereading () const |
| Helper: warn that type does not support re-reading. More... | |
| bool | writeHeader (Ostream &os) const |
| Write header with current type() More... | |
| bool | writeHeader (Ostream &os, const word &objectType) const |
| Write header with override of type. More... | |
| void | writeHeader (dictionary &dict, IOstreamOption streamOpt) const |
| void | writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const |
| bool | good () const noexcept |
| bool | bad () const noexcept |
| InfoProxy< IOobject > | info () const |
| Return info proxy. More... | |
| void | operator= (const IOobject &io) |
| readOption & | readOpt () noexcept |
| Access to the read option. More... | |
| writeOption & | writeOpt () noexcept |
| Access to the write option. More... | |
| bool & | registerObject () noexcept |
| Access to the register object option. More... | |
| bool & | globalObject () noexcept |
| Access to the global object option. More... | |
| template<> | |
| bool | isHeaderClassName () const |
Specialization for void always returns true (no headerClassName check). More... | |
| template<class StringType > | |
| Foam::word | groupName (StringType base, const word &group) |
| Public Member Functions inherited from Field< scalar > | |
| constexpr | Field () noexcept |
| Default construct. More... | |
| Field (const label len) | |
| Construct given size. More... | |
| Field (const label len, const scalar &val) | |
| Construct given size and initial value. More... | |
| Field (const label len, const Foam::zero) | |
| Construct given size and initial values of zero. More... | |
| Field (const Foam::one, const scalar &val) | |
| Construct with length=1, copying the value as the only content. More... | |
| Field (const Foam::one, scalar &&val) | |
| Construct with length=1, moving the value as the only content. More... | |
| Field (const Foam::one, const Foam::zero) | |
| Construct with length=1, initializing content to zero. More... | |
| Field (const Field< scalar > &fld) | |
| Copy construct. More... | |
| Field (const UList< scalar > &list) | |
| Copy construct from UList<Type> More... | |
| Field (const IndirectListBase< scalar, Addr > &list) | |
| Copy construct from IndirectList. More... | |
| Field (Field< scalar > &&fld) | |
| Move construct from Field. More... | |
| Field (List< scalar > &&list) | |
| Move construct from List. More... | |
| Field (DynamicList< scalar, SizeMin > &&list) | |
| Move construct from DynamicList. 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 (const UList< scalar > &mapF, const FieldMapper &map, const bool applyFlip=true) | |
| Construct by mapping from the given field. More... | |
| Field (const UList< scalar > &mapF, const FieldMapper &map, const scalar &defaultValue, const bool applyFlip=true) | |
| Construct by mapping from the given field. More... | |
| Field (const UList< scalar > &mapF, const FieldMapper &map, const UList< scalar > &defaultValues, const bool applyFlip=true) | |
| Construct by mapping from the given field. More... | |
| Field (const tmp< Field< scalar >> &tmapF, const FieldMapper &map, const bool applyFlip=true) | |
| Construct by mapping from the given tmp field. More... | |
| Field (const tmp< Field< scalar >> &tmapF, const FieldMapper &map, const scalar &defaultValue, const bool applyFlip=true) | |
| Field (const tmp< Field< scalar >> &tmapF, const FieldMapper &map, const UList< scalar > &defaultValues, const bool applyFlip=true) | |
| Field (Field< scalar > &fld, bool reuse) | |
| Copy construct or re-use as specified. More... | |
| Field (const tmp< Field< scalar >> &tfld) | |
| Copy or move construct from tmp. More... | |
| Field (Istream &is) | |
| Construct from Istream. More... | |
| Field (const word &keyword, const dictionary &dict, const label len) | |
| Construct from a dictionary entry. 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 | map (const UList< scalar > &mapF, const FieldMapper &map, const bool applyFlip=true) |
| Map from the given field. More... | |
| void | map (const tmp< Field< scalar >> &tmapF, const FieldMapper &map, const bool applyFlip=true) |
| Map from the given tmp field. More... | |
| void | autoMap (const FieldMapper &map, const bool applyFlip=true) |
| Map from self. 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 | negate () |
| Negate this field (negative). 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 | writeEntry (const word &keyword, Ostream &os) const |
| Write the field as a dictionary entry. More... | |
| SubField< scalar > | slice (const label pos, label len=-1) |
| Return SubField slice (non-const access) - no range checking. More... | |
| const SubField< scalar > | slice (const label pos, label len=-1) const |
| Return SubField slice (const access) - no range checking. More... | |
| SubField< scalar > | slice (const labelRange &range) |
| Return SubField slice (non-const access) - with range checking. More... | |
| const SubField< scalar > | slice (const labelRange &range) const |
| Return SubField slice (const access) - with range checking. More... | |
| void | operator= (const Field< scalar > &) |
| Copy assignment. More... | |
| void | operator= (const tmp< Field< scalar >> &) |
| void | operator= (const UList< scalar > &rhs) |
| void | operator= (const SubField< scalar > &rhs) |
| void | operator= (const IndirectListBase< scalar, Addr > &rhs) |
| Copy assign from IndirectList. More... | |
| void | operator= (Field< scalar > &&rhs) |
| Move assignment. More... | |
| void | operator= (List< scalar > &&rhs) |
| void | operator= (DynamicList< scalar, SizeMin > &&rhs) |
| void | operator= (const scalar &val) |
| Value assignment. More... | |
| void | operator= (const Foam::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 &) |
Additional Inherited Members | |
| Public Types inherited from IOobject | |
| enum | objectState : char { GOOD, BAD } |
| Enumeration defining the valid states of an IOobject. More... | |
| enum | readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ } |
| Enumeration defining the read options. More... | |
| enum | writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 } |
| Enumeration defining the write options. More... | |
| enum | fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster } |
| Enumeration defining the file checking options. More... | |
| Public Types inherited from Field< scalar > | |
| typedef pTraits< scalar >::cmptType | cmptType |
| Component type. More... | |
| typedef SubField< scalar > | subField |
| Declare type of subField. More... | |
| Static Public Member Functions inherited from MeshObject< polyMesh, MoveableMeshObject, cellAspectRatio > | |
| static const cellAspectRatio & | New (const polyMesh &mesh, Args &&... args) |
| Get existing or create a new MeshObject. More... | |
| static bool | Delete (const polyMesh &mesh) |
| Static destructor. More... | |
| Static Public Member Functions inherited from meshObject | |
| template<class Mesh > | |
| static void | movePoints (objectRegistry &obr) |
| template<class Mesh > | |
| static void | updateMesh (objectRegistry &obr, const mapPolyMesh &mpm) |
| template<class Mesh , template< class > class MeshObjectType> | |
| static void | clear (objectRegistry &obr) |
| template<class Mesh , template< class > class FromType, template< class > class ToType> | |
| static void | clearUpto (objectRegistry &obr) |
| Static Public Member Functions inherited from regIOobject | |
| template<class Type > | |
| static Type & | store (Type *p) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (autoPtr< Type > &ptr) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (autoPtr< Type > &&ptr) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (refPtr< Type > &ptr) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (refPtr< Type > &&ptr) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (tmp< Type > &ptr) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (tmp< Type > &&ptr) |
| Transfer pointer ownership to its registry. More... | |
| Static Public Member Functions inherited from IOobject | |
| static bool | bannerEnabled () noexcept |
| Status of output file banner. More... | |
| static bool | bannerEnabled (bool on) noexcept |
| Enable/disable an output file banner. More... | |
| static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
| Split path into instance, local, name components. More... | |
| template<class StringType > | |
| static word | groupName (StringType base, const word &group) |
| Create dot-delimited name.group string. More... | |
| static word | group (const word &name) |
| Return group (extension part of name) More... | |
| static word | member (const word &name) |
| Return member (name without the extension) More... | |
| static word | scopedName (const std::string &scope, const word &name) |
| Create scope:name or scope_name string. More... | |
| static IOobject | selectIO (const IOobject &io, const fileName &altFile, const word &ioName="") |
| Return the IOobject, but also consider an alternative file name. More... | |
| static Ostream & | writeBanner (Ostream &os, const bool noSyntaxHint=false) |
| Write the standard OpenFOAM file/dictionary banner. More... | |
| static Ostream & | writeDivider (Ostream &os) |
| Write the standard file section divider. More... | |
| static Ostream & | writeEndDivider (Ostream &os) |
| Write the standard end file divider. More... | |
| Static Public Member Functions inherited from Field< scalar > | |
| static const Field< scalar > & | null () |
| Return nullObject reference Field. More... | |
| static autoPtr< Field< scalar > > | New (Istream &is) |
| Return a pointer to a new Field created on freestore. More... | |
| static tmp< Field< scalar > > | NewCalculatedType (const Field< Type2 > &f) |
| Static Public Attributes inherited from IOobject | |
| static const Enum< fileCheckTypes > | fileCheckTypesNames |
| Names for the fileCheckTypes. More... | |
| static char | scopeSeparator |
| Character for scoping object names (':' or '_') More... | |
| static fileCheckTypes | fileModificationChecking |
| Type of file modification checking. More... | |
| static float | fileModificationSkew |
| Time skew (seconds) for file modification checks. More... | |
| static int | maxFileModificationPolls |
| Max number of times to poll for file modification changes. More... | |
| Protected Member Functions inherited from regIOobject | |
| bool | readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName) |
| Helper: check readOpt flags and read if necessary. More... | |
| Protected Member Functions inherited from IOobject | |
| void | setBad (const string &s) |
| Set the object state to bad. More... | |
| Static Protected Member Functions inherited from IOobject | |
| static void | writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr) |
| static void | writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr) |
| Protected Attributes inherited from MeshObject< polyMesh, MoveableMeshObject, cellAspectRatio > | |
| const polyMesh & | mesh_ |
| Static Protected Attributes inherited from regIOobject | |
| static bool | masterOnlyReading = false |
| To flag master-only reading of objects. More... | |
(Rough approximation of) cell aspect ratio
Definition at line 51 of file cellAspectRatio.H.
|
explicit |
Construct given an polyMesh.
Definition at line 40 of file cellAspectRatio.C.
|
virtual |
Destructor.
Definition at line 50 of file cellAspectRatio.C.
| TypeName | ( | "cellAspectRatio" | ) |
|
inlinevirtual |
Ignore mesh motion for now.
Implements MoveableMeshObject< polyMesh >.
Definition at line 81 of file cellAspectRatio.H.
1.8.17 