A surface mesh consisting of general polygon faces and capable of holding fields. More...
#include <polySurface.H>
Public Types | |
| enum | FieldAssociation { NO_DATA = 0 , FACE_DATA = 1 , POINT_DATA = 2 , FACE_OR_POINT_DATA = 3 } |
| Enumeration for the field association. More... | |
| typedef polySurface | Mesh |
| Typedef required for GeoMesh. | |
| typedef bool | BoundaryMesh |
| Placeholder only, for GeoMesh. | |
| Public Types inherited from IOobject | |
| enum | objectState : char { GOOD , BAD } |
| Enumeration defining the valid states of an IOobject. More... | |
| enum | fileCheckTypes : char { timeStamp = 1 , timeStampMaster = 3 , inotify = 4 , inotifyMaster = 6 } |
| Enumeration defining the file checking options (time-stamp | inotify) | (all | masterOnly). More... | |
| Public Types inherited from IOobjectOption | |
| enum | readOption : unsigned char { NO_READ = 0 , MUST_READ = 0x1 , READ_MODIFIED = 0x3 , MUST_READ_IF_MODIFIED = 0x3 , LAZY_READ = 0x4 , READ_IF_PRESENT = 0x4 } |
| Enumeration defining read preferences. More... | |
| enum | writeOption : unsigned char { NO_WRITE = 0 , AUTO_WRITE = 0x10 } |
| Enumeration defining write preferences. More... | |
| enum | registerOption : unsigned char { NO_REGISTER = 0 , REGISTER = 1 , LEGACY_REGISTER = 2 } |
| Enumeration for use with registerObject(). Values map to bool (false/true). More... | |
| enum class | Layout : unsigned char { regular , global } |
| The layout of the case structure. More... | |
| Public Types inherited from HashTable< regIOobject * > | |
| typedef HashTable< regIOobject *, word, Foam::Hash< word > > | this_type |
| The template instance used for this HashTable. | |
| using | node_type |
| A table entry (node) that encapsulates the key/val tuple with an additional linked-list entry for hash collisions. | |
| typedef word | key_type |
| The second template parameter, type of keys used. | |
| typedef regIOobject * | mapped_type |
| The first template parameter, type of objects contained. | |
| typedef regIOobject * | value_type |
| Same as mapped_type for OpenFOAM HashTables. | |
| typedef Foam::Hash< word > | hasher |
| The third template parameter, the hash index method. | |
| typedef regIOobject ** | pointer |
| Pointer type for storing into value_type objects. | |
| typedef regIOobject *& | reference |
| Reference to the stored value_type. | |
| typedef const regIOobject ** | const_pointer |
| Const pointer type for the stored value_type. | |
| typedef const regIOobject *& | const_reference |
| Const reference to the stored value_type. | |
| typedef label | difference_type |
| The type to represent the difference between two iterators. | |
| typedef label | size_type |
| The type that can represent the size of a HashTable. | |
| using | key_iterator |
| Forward iterator returning the key. | |
| using | const_key_iterator |
| Forward const iterator returning the key. | |
| Public Types inherited from PrimitivePatch<::Foam::List< face >, pointField > | |
| enum | surfaceTopo |
| Enumeration defining the surface type. Used in check routines. More... | |
| typedef std::remove_reference< ::Foam::List< face > >::type::value_type | face_type |
| The face type. | |
| typedef std::remove_reference< pointField >::type::value_type | point_type |
| The point type. | |
| typedef ::Foam::List< face > | FaceListType |
| The face list type. | |
| typedef pointField | PointFieldType |
| The point field type. | |
| typedef face_type | FaceType |
| Deprecated(2020-03) prefer face_type typedef. | |
| Public Types inherited from List< face > | |
| typedef SubList< face > | subList |
| Declare type of subList. | |
| Public Types inherited from UList< face > | |
| typedef face | value_type |
| The value type the list contains. | |
| typedef face * | pointer |
| The pointer type for non-const access to value_type items. | |
| typedef const face * | const_pointer |
| The pointer type for const access to value_type items. | |
| typedef face & | reference |
| The type used for storing into value_type objects. | |
| typedef const face & | const_reference |
| The type used for reading from constant value_type objects. | |
| typedef face * | iterator |
| Random access iterator for traversing a UList. | |
| typedef const face * | const_iterator |
| Random access iterator for traversing a UList. | |
| typedef label | size_type |
| The type to represent the size of a UList. | |
| typedef label | difference_type |
| The difference between iterator objects. | |
| typedef std::reverse_iterator< iterator > | reverse_iterator |
| Reverse iterator (non-const access). | |
| typedef std::reverse_iterator< const_iterator > | const_reverse_iterator |
| Reverse iterator (const access). | |
| using | is_List |
| Have unique tag. | |
Public Member Functions | |
| TypeName ("polySurface") | |
| Runtime type information. | |
| polySurface (const polySurface &)=delete | |
| No copy construct. | |
| void | operator= (const polySurface &)=delete |
| No copy assignment. | |
| polySurface (const IOobject &io, bool doCheckIn=false) | |
| Default construct with NO_READ, NO_WRITE optionally with a checkIn on the parent registry. | |
| polySurface (const word &surfName, const objectRegistry &obr, bool doCheckIn=false) | |
| Default construct with specified name on the given registry, optionally with a checkIn on the parent registry. | |
| polySurface (const IOobject &io, const MeshedSurface< face > &surf, bool doCheckIn=false) | |
| Copy construct from MeshedSurface<face> contents with NO_READ, NO_WRITE optionally with a checkIn on the parent registry. | |
| polySurface (const IOobject &io, MeshedSurface< face > &&surf, bool doCheckIn=false) | |
| Move construct from MeshedSurface<face> contents with NO_READ, NO_WRITE optionally with a checkIn on the parent registry. | |
| virtual | ~polySurface () |
| Destructor. | |
| virtual label | nPoints () const |
| Return the number of points. | |
| virtual label | nFaces () const |
| Return the number of faces. | |
| virtual label | size () const |
| Return number of faces. | |
| virtual const pointField & | points () const |
| Return points. | |
| virtual const faceList & | faces () const |
| Return faces. | |
| virtual const labelList & | zoneIds () const |
| Const access to per-face zone/region information (demand-driven). | |
| const vectorField & | Sf () const |
| Return face area vectors (normals). | |
| const scalarField & | magSf () const |
| Return face area magnitudes. | |
| const vectorField & | Cf () const |
| Face centres. | |
| void | copySurface (const pointField &points, const faceList &faces, bool unused=false) |
| Update with new contents. Removes existing fields if sizes have changed. | |
| void | copySurface (const meshedSurf &surf, bool unused=false) |
| Update with new contents. Removes existing fields if sizes have changed. | |
| void | copySurface (const MeshedSurface< face > &surf, bool unused=false) |
| Update with new contents. Removes existing fields if sizes have changed. | |
| void | transfer (pointField &&points, faceList &&faces, labelList &&zoneIds=labelList()) |
| Transfer the contents (and annul the parameters). Removes existing fields. | |
| void | transfer (MeshedSurface< face > &surf, bool validate=false) |
| Transfer the contents (and annul the parameters). Removes existing fields. | |
| label | nFaceData () const |
| Number of main entries, without PointData sub-registry. | |
| label | nPointData () const |
| Number of entries on PointData sub-registry (if it exists). | |
| FieldAssociation | queryFieldAssociation (const word &fieldName) const |
| Query the field association (FACE or POINT). | |
| const regIOobject * | findFieldObject (const word &fieldName, const FieldAssociation association) const |
| Find the field object with the given name and required FieldAssociation (FACE or POINT). | |
| template<class GeoMeshType = void> | |
| const regIOobject * | findFieldObject (const word &fieldName) const |
| General finding of the field object (FACE or POINT). | |
| template<class GeoMeshType = void> | |
| const objectRegistry * | whichRegistry (const word &fieldName) const |
| General finding of the registry with the field object (FACE or POINT). | |
| template<class DataType> | |
| const objectRegistry & | fieldData () const |
| Regular data are stored directly on the registry. | |
| const objectRegistry & | faceData () const |
| Face data are stored directly on the registry. | |
| const objectRegistry & | pointData () const |
| Point data are stored in a sub-registry. | |
| template<class Type, class GeoMeshType = polySurfaceGeoMesh> | |
| DimensionedField< Type, GeoMeshType > & | newField (const word &fieldName, const dimensionSet &dims) |
| Create/store named zero field as face or point data (template parameter). | |
| template<class Type, class GeoMeshType = polySurfaceGeoMesh> | |
| DimensionedField< Type, GeoMeshType > & | storeField (const word &fieldName, const dimensionSet &dims, const Field< Type > &values) |
| Copy/store named field as face or point data (template parameter). | |
| template<class Type, class GeoMeshType = polySurfaceGeoMesh> | |
| DimensionedField< Type, GeoMeshType > & | storeField (const word &fieldName, const dimensionSet &dims, Field< Type > &&values) |
| Move/store named field as face or point data (template parameter). | |
| virtual bool | writeObject (IOstreamOption streamOpt, const bool writeOnProc) const |
| Write - this is a no-op. | |
| void | clearGeom () |
| Clear geometry. | |
| void | clearAddressing () |
| Clear addressing. | |
| void | clearOut () |
| Clear all geometry and addressing unnecessary for CFD. | |
| void | clearPrimitives () |
| Clear primitive data (points, faces and cells). | |
| void | clearFields () |
| Clear stored fields. | |
| template<> | |
| const regIOobject * | findFieldObject (const word &fieldName) const |
| template<> | |
| const regIOobject * | findFieldObject (const word &fieldName) const |
| template<> | |
| const objectRegistry * | whichRegistry (const word &fieldName) const |
| template<> | |
| const objectRegistry * | whichRegistry (const word &fieldName) const |
| template<> | |
| const regIOobject * | findFieldObject (const word &fieldName) const |
| Find face field object (on main registry). | |
| template<> | |
| const regIOobject * | findFieldObject (const word &fieldName) const |
| Find point field object (on sub-registry). | |
| template<> | |
| const objectRegistry * | whichRegistry (const word &fieldName) const |
| Return field object (on main registry). Face data field found on main registry? | |
| template<> | |
| const objectRegistry * | whichRegistry (const word &fieldName) const |
| Point data field found on sub-registry? | |
| template<> | |
| const objectRegistry & | fieldData () const |
| Point data are stored in a sub-registry. | |
| template<class GeoMeshType> | |
| const Foam::regIOobject * | findFieldObject (const word &fieldName) const |
| template<class GeoMeshType> | |
| const Foam::objectRegistry * | whichRegistry (const word &fieldName) const |
| template<class Type, class GeoMeshType> | |
| Foam::DimensionedField< Type, GeoMeshType > & | newField (const word &fieldName, const dimensionSet &dims) |
| template<class Type, class GeoMeshType> | |
| Foam::DimensionedField< Type, GeoMeshType > & | storeField (const word &fieldName, const dimensionSet &dims, const Field< Type > &values) |
| template<class Type, class GeoMeshType> | |
| Foam::DimensionedField< Type, GeoMeshType > & | storeField (const word &fieldName, const dimensionSet &dims, Field< Type > &&values) |
| Public Member Functions inherited from objectRegistry | |
| TypeName ("objectRegistry") | |
| Declare type name for this IOobject. | |
| objectRegistry (const Time &db, const label initialCapacity=128) | |
| Construct the time objectRegistry, with estimated table capacity (default: 128). | |
| objectRegistry (const IOobject &io, const label initialCapacity=128) | |
| Construct sub-registry given an IObject to describe the registry, with estimated table capacity (default: 128). | |
| virtual | ~objectRegistry () |
| Destructor, with checkOut() for all objects that are ownedByRegistry. | |
| const objectRegistry & | thisDb () const noexcept |
| Return the object registry. | |
| const objectRegistry & | parent () const noexcept |
| Return the parent objectRegistry. | |
| const Time & | time () const noexcept |
| Return time registry. | |
| bool | isTimeDb () const noexcept |
| True if the registry is Time. | |
| virtual const fileName & | dbDir () const |
| Local directory path of this objectRegistry relative to the time. | |
| IOobject | newIOobject (const word &name, IOobjectOption ioOpt) const |
| Create an IOobject at the current time instance (timeName) with the specified options. | |
| IOobject | newIOobject (const word &name, IOobjectOption::readOption rOpt=IOobjectOption::NO_READ, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, IOobjectOption::registerOption regOpt=IOobjectOption::NO_REGISTER) const |
| Create an IOobject at the current time instance (timeName). | |
| HashTable< wordHashSet > | classes () const |
| A summary hash of classes used and their associated object names. | |
| template<class MatchPredicate> | |
| HashTable< wordHashSet > | classes (const MatchPredicate &matchName) const |
| A summary hash of classes used and their associated object names, restricted to objects that have a matching object name. | |
| template<class Type, bool Strict = false> | |
| UPtrList< const Type > | cobjects () const |
Return unsorted list of objects with a class satisfying isA<Type> or isType<Type> (with Strict). | |
| template<class Type, bool Strict = false> | |
| UPtrList< Type > | objects () |
Return unsorted list of objects with a class satisfying isA<Type> or isType<Type> (with Strict). | |
| template<class Type, class MatchPredicate> | |
| UPtrList< const Type > | cobjects (const MatchPredicate &matchName) const |
Return unsorted list of objects with a class satisfying isA<Type> that also have a matching object name. | |
| template<class Type, class MatchPredicate> | |
| UPtrList< Type > | objects (const MatchPredicate &matchName) |
Return sorted list of objects with a class satisfying isA<Type> that also have a matching object name. | |
| template<class Type, bool Strict = false> | |
| UPtrList< const Type > | csorted () const |
Return sorted list of objects with a class satisfying isA<Type> or isType<Type> (with Strict). | |
| template<class Type, bool Strict = false> | |
| UPtrList< Type > | sorted () |
Return sorted list of objects with a class satisfying isA<Type> or isType<Type> (with Strict). | |
| UPtrList< const regIOobject > | csorted () const |
| Return sorted list of objects. | |
| UPtrList< regIOobject > | sorted () |
| Return sorted list of objects. | |
| template<class Type, class MatchPredicate> | |
| UPtrList< const Type > | csorted (const MatchPredicate &matchName) const |
Return sorted list of objects with a class satisfying isA<Type> that also have a matching object name. | |
| template<class Type, class MatchPredicate> | |
| UPtrList< Type > | sorted (const MatchPredicate &matchName) |
Return sorted list of objects with a class satisfying isA<Type> that also have a matching object name. | |
| label | count (const char *clsName) const |
| The number of objects of the given class name. | |
| template<class MatchPredicate> | |
| label | count (const MatchPredicate &matchClass) const |
| The number of objects of the given class name. | |
| template<class MatchPredicate1, class MatchPredicate2> | |
| label | count (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
| The number of objects of the given class name. | |
| template<class Type> | |
| label | count (const bool strict=false) const |
The names of objects with a class satisfying isA<Type>. | |
| template<class Type, class MatchPredicate> | |
| label | count (const MatchPredicate &matchName) const |
The names of objects with a class satisfying isA<Type> that also have a matching object name. | |
| wordList | names () const |
| The unsorted names of all objects. | |
| wordList | names (const char *clsName) const |
| The unsorted names of objects with the given class name. | |
| template<class MatchPredicate> | |
| wordList | names (const MatchPredicate &matchClass) const |
| The unsorted names of objects with a matching class name. | |
| template<class MatchPredicate1, class MatchPredicate2> | |
| wordList | names (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
| The unsorted names of objects with a matching class name that also have a matching object name. | |
| template<class Type> | |
| wordList | names () const |
The unsorted names of objects with a class satisfying isA<Type>. | |
| template<class Type, class MatchPredicate> | |
| wordList | names (const MatchPredicate &matchName) const |
The unsorted names of objects with a class satisfying isA<Type> that also have a matching object name. | |
| wordList | sortedNames () const |
| The sorted names of all objects. | |
| wordList | sortedNames (const char *clsName) const |
| The sorted names of objects with the given class name. | |
| template<class MatchPredicate> | |
| wordList | sortedNames (const MatchPredicate &matchClass) const |
| The sorted names objects with a matching class name. | |
| template<class MatchPredicate1, class MatchPredicate2> | |
| wordList | sortedNames (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
| The sorted names of objects with a matching class name that also have a matching object name. | |
| template<class Type> | |
| wordList | sortedNames () const |
The sorted names of objects with a class satisfying isA<Type>. | |
| template<class Type, class MatchPredicate> | |
| wordList | sortedNames (const MatchPredicate &matchName) const |
The sorted names of objects with a class satisfying isA<Type> that also have a matching object name. | |
| const objectRegistry & | subRegistry (const word &name, const bool forceCreate=false, const bool recursive=false) const |
| Lookup and return a const sub-objectRegistry. | |
| template<class Type, bool Strict = false> | |
| HashTable< const Type * > | lookupClass () const |
Return all objects with a class satisfying isA<Type> or isType<Type> (with Strict). | |
| template<class Type, bool Strict = false> | |
| HashTable< Type * > | lookupClass () |
Return all objects with a class satisfying isA<Type> or isType<Type> (with Strict). | |
| template<class Type> | |
| HashTable< const Type * > | lookupClass (const bool strict) const |
Return all objects with a class satisfying isA<Type>. | |
| template<class Type> | |
| HashTable< Type * > | lookupClass (const bool strict) |
Return all objects with a class satisfying isA<Type>. | |
| const regIOobject * | cfindIOobject (const word &name, const bool recursive=false) const |
| Return const pointer to the regIOobject. | |
| bool | contains (const word &name, const bool recursive=false) const |
| Does the registry contain the regIOobject object (by name). | |
| template<class Type> | |
| bool | foundObject (const word &name, const bool recursive=false) const |
| Contains the named Type? | |
| template<class Type> | |
| const Type * | cfindObject (const word &name, const bool recursive=false) const |
| Return const pointer to the object of the given Type. | |
| template<class Type> | |
| const Type * | findObject (const word &name, const bool recursive=false) const |
| Return const pointer to the object of the given Type. | |
| template<class Type> | |
| Type * | findObject (const word &name, const bool recursive=false) |
| Return non-const pointer to the object of the given Type. | |
| template<class Type> | |
| Type * | getObjectPtr (const word &name, const bool recursive=false) const |
| Return non-const pointer to the object of the given Type, using a const-cast to have it behave like a mutable. | |
| template<class Type> | |
| const Type & | lookupObject (const word &name, const bool recursive=false) const |
| Lookup and return const reference to the object of the given Type. Fatal if not found or the wrong type. | |
| template<class Type> | |
| Type & | lookupObjectRef (const word &name, const bool recursive=false) const |
| Lookup and return non-const reference to the object of the given Type. Fatal if not found or the wrong type. | |
| label | getEvent () const |
| Return new event number. | |
| bool | checkIn (regIOobject *io) const |
| Add a regIOobject to registry. A nullptr is ignored. | |
| bool | checkIn (regIOobject &io) const |
| Add a regIOobject to registry. | |
| bool | checkOut (regIOobject *io) const |
| Remove a regIOobject from registry and free memory if the object is ownedByRegistry. A nullptr is ignored. | |
| bool | checkOut (regIOobject &io) const |
| Remove a regIOobject from registry and free memory if the object is ownedByRegistry. | |
| bool | checkOut (const word &key) const |
| Remove a regIOobject by name from registry and free memory if the object is ownedByRegistry. | |
| void | clear () |
| Clear all entries from the registry. | |
| void | clearStorage () |
| Clear all entries from the registry and the table itself. | |
| bool | erase (const iterator &iter) |
| Erase an entry specified by the given iterator. | |
| bool | erase (const word &key) |
| Erase an entry specified by the given key. | |
| label | erase (std::initializer_list< word > keys) |
| Remove entries given by the listed keys. | |
| label | erase (const UList< word > &keys) |
| Remove entries given by the listed keys. | |
| virtual void | rename (const word &newName) |
| Rename. | |
| bool | is_cacheTemporaryObject (const word &name) const |
| True if given name is in the cacheTemporaryObjects set. | |
| bool | is_cacheTemporaryObject (const regIOobject *io) const |
| True if name of object is in the cacheTemporaryObjects set. | |
| bool | is_cacheTemporaryObject (const regIOobject &io) const |
| True if name of object is in the cacheTemporaryObjects set. | |
| template<class Type> | |
| bool | cacheTemporaryObject (Type &obj) const |
| Cache the given object. Moves content and stores. | |
| void | resetCacheTemporaryObject (const regIOobject *io) const |
| Reset the cache state of the given object (nullptr is ignored). | |
| void | resetCacheTemporaryObject (const regIOobject &io) const |
| Reset the cache state of the given object in the cacheTemporaryObjects set. | |
| bool | checkCacheTemporaryObjects () const |
| Check that all objects specified in the cacheTemporaryObjects were also cached. | |
| virtual bool | modified () const |
| Return true if any of the object's files have been modified. | |
| void | readModifiedObjects () |
| Read the objects that have been modified. | |
| virtual bool | readIfModified () |
| Read object if modified. | |
| virtual bool | writeData (Ostream &) const |
| The writeData function is required by regIOobject but not used. | |
| bool | found (const word &name, bool recursive=false) const |
| Same as contains(). | |
| template<class Type> | |
| const Type * | lookupObjectPtr (const word &name, bool recursive=false) const |
| Deprecated(2018-10) find object. | |
| template<class Type> | |
| Type * | lookupObjectRefPtr (const word &name, bool recursive=false) const |
| Deprecated(2018-10) get object pointer, ignoring constness. | |
| template<class Type> | |
| UPtrList< const Type > | sorted () const |
| Deprecated(2023-07) use csorted() method. | |
| UPtrList< const regIOobject > | sorted () const |
| Deprecated(2023-07) use csorted() method. | |
| template<class Type, class MatchPredicate> | |
| UPtrList< const Type > | sorted (const MatchPredicate &matchName) const |
| Deprecated(2023-07) use csorted() method. | |
| template<class MatchPredicate> | |
| Foam::HashTable< Foam::wordHashSet > | classesImpl (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 Type, class MatchPredicate> | |
| Foam::UPtrList< Type > | objectsTypeImpl (const bool strict, const objectRegistry &list, const MatchPredicate &matchName, const bool doSort) |
| template<class Type> | |
| Foam::HashTable< Type * > | lookupClassTypeImpl (const bool strict, const objectRegistry &list) |
| template<class MatchPredicate> | |
| Foam::HashTable< Foam::wordHashSet > | classes (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 Type, bool Strict> | |
| Foam::UPtrList< const Type > | cobjects () const |
| template<class Type, bool Strict> | |
| Foam::UPtrList< Type > | objects () |
| template<class Type, bool Strict> | |
| Foam::UPtrList< const Type > | csorted () const |
| template<class Type, bool Strict> | |
| Foam::UPtrList< Type > | sorted () |
| template<class Type, class MatchPredicate> | |
| Foam::UPtrList< const Type > | cobjects (const MatchPredicate &matchName) const |
| template<class Type, class MatchPredicate> | |
| Foam::UPtrList< Type > | objects (const MatchPredicate &matchName) |
| template<class Type, class MatchPredicate> | |
| Foam::UPtrList< const Type > | csorted (const MatchPredicate &matchName) const |
| template<class Type, class MatchPredicate> | |
| Foam::UPtrList< Type > | sorted (const MatchPredicate &matchName) |
| 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, bool Strict> | |
| Foam::HashTable< const Type * > | lookupClass () const |
| template<class Type, bool Strict> | |
| Foam::HashTable< Type * > | lookupClass () |
| 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 | |
| void | operator= (const regIOobject &)=delete |
| No copy assignment. | |
| TypeName ("regIOobject") | |
| Runtime type information. | |
| regIOobject (const IOobject &io, const bool isTimeObject=false) | |
| Construct from IOobject. The optional flag adds special handling if the object is the top-level regIOobject (eg, Time). | |
| regIOobject (const regIOobject &rio) | |
| Copy construct. | |
| regIOobject (const regIOobject &rio, bool registerCopy) | |
| Copy construct, transferring registry registration to the copy if registerCopy is true. | |
| regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
| Copy construct with new name, transferring registry registration to the copy if registerCopy is true. | |
| regIOobject (const IOobject &io, const regIOobject &rio) | |
| Copy construct with new IO parameters. | |
| virtual | ~regIOobject () |
| Destructor. | |
| bool | checkIn () |
| Add object to registry, if not already registered. | |
| bool | checkOut () |
| Remove object from registry, and remove all file watches. | |
| virtual void | addWatch () |
| Add file watch on object (if registered and READ_IF_MODIFIED). | |
| bool | registered () const noexcept |
| Query the registered state (ie, has been checked in). This is not necessarily the same as registerObject(), which is just a stated preference. | |
| bool | ownedByRegistry () const noexcept |
| Is this object owned by the registry? | |
| bool | store () |
| Register object with its registry and transfer ownership to the registry. | |
| void | release (const bool unregister=false) noexcept |
| Set object as not ownedByRegistry. | |
| label | eventNo () const noexcept |
| Event number at last update. | |
| label & | eventNo () noexcept |
| Event number at last update. | |
| bool | upToDate (const regIOobject &) const |
| Return true if up-to-date with respect to given object. | |
| bool | upToDate (const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. | |
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. | |
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. | |
| void | setUpToDate () |
| Set as up-to-date. | |
| const dictionary * | findMetaData () const noexcept |
| Return pointer to meta-data or nullptr. | |
| dictionary & | getMetaData () noexcept |
| Get or create meta-data. | |
| void | removeMetaData () |
| Remove meta-data. | |
| virtual void | updateMetaData () |
| Update internal meta-data (eg, prior to writing). | |
| virtual fileName | filePath () const |
| Return complete path + object name if the file exists. | |
| bool | headerOk () |
| Read and check header info. Does not check the headerClassName. | |
| Istream & | readStream (const word &, const bool readOnProc=true) |
| Return Istream and check object type against that given. | |
| void | close () |
| Close Istream. | |
| virtual bool | readData (Istream &) |
| Virtual readData function. | |
| virtual bool | read () |
| Read object. | |
| virtual label | addWatch (const fileName &) |
| Add file watch for fileName on object if not yet watched. | |
| const labelList & | watchIndices () const noexcept |
| Read access to file-monitoring handles. | |
| labelList & | watchIndices () noexcept |
| Write access to file-monitoring handles. | |
| virtual bool | write (const bool writeOnProc=true) const |
| Write using setting from DB. | |
| virtual bool | global () const |
| Is object global. | |
| void | operator= (const IOobject &io) |
| Copy assignment. | |
| virtual bool | writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool writeOnProc) const |
| Write using given format, version and compression. | |
| Public Member Functions inherited from IOobject | |
| TypeName ("IOobject") | |
| Declare type-name, virtual type (with debug switch). | |
| IOobject (const IOobject &)=default | |
| Copy construct. | |
| virtual | ~IOobject ()=default |
| Destructor. | |
| IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
| Construct from name, instance, registry, io options. | |
| IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
| Construct from name, instance, local, registry, io options. | |
| IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
| Construct from path, registry, io options. | |
| IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) | |
| Construct from name, instance, registry, io options. | |
| IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) | |
| Construct from name, instance, local, registry, io options. | |
| IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) | |
| Construct from path, registry, io options. | |
| IOobject (const IOobject &io, const objectRegistry ®istry) | |
| Copy construct, resetting registry. | |
| IOobject (const IOobject &io, const word &name) | |
| Copy construct, resetting name. | |
| IOobject (const IOobject &io, const word &name, const fileName &local) | |
| Copy construct, resetting name and local component. | |
| IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt) | |
| Copy construct, resetting read/write options. | |
| IOobject (const IOobject &io, IOobjectOption::registerOption regOpt) | |
| Copy construct, resetting register option. | |
| autoPtr< IOobject > | clone () const |
| Clone. | |
| autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
| Clone resetting registry. | |
| const objectRegistry & | db () const noexcept |
| Return the local objectRegistry. | |
| const Time & | time () const noexcept |
| Return Time associated with the objectRegistry. | |
| const word & | name () const noexcept |
| Return the object name. | |
| const word & | headerClassName () const noexcept |
| Return name of the class name read from header. | |
| word & | headerClassName () noexcept |
| Modifiable access to the class name read from header. | |
| const string & | note () const noexcept |
| Return the optional note. | |
| string & | note () noexcept |
| Modifiable access to the optional note. | |
| unsigned | labelByteSize () const noexcept |
| The sizeof (label) in bytes, possibly read from the header. | |
| unsigned | scalarByteSize () const noexcept |
| The sizeof (scalar) in bytes, possibly read from the header. | |
| void | resetHeader (const word &newName=word::null) |
| Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file. | |
| bool | hasHeaderClass () const noexcept |
| True if headerClassName() is non-empty (after reading). | |
| bool | isHeaderClass (const word &expectedType) const |
| Check if headerClassName() equals the expected type. Always true if the expected type is empty. | |
| template<class Type> | |
| bool | isHeaderClass () const |
Check if headerClassName() equals Type::typeName Always true for a void type. | |
| word | group () const |
| Return group (extension part of name). | |
| word | member () const |
| Return member (name without the extension). | |
| const fileName & | rootPath () const noexcept |
| Return the Time::rootPath(). | |
| const fileName & | caseName () const noexcept |
| Return the Time::caseName(). | |
| const fileName & | globalCaseName () const noexcept |
| Return the Time::globalCaseName(). | |
| const fileName & | caseName (IOobjectOption::Layout) const noexcept |
| Return the Time::caseName() - normal or global. | |
| const fileName & | instance () const noexcept |
| Read access to instance path component. | |
| fileName & | instance () noexcept |
| Modifiable access to instance path component. | |
| scalar | instanceValue () const |
| Return the scalar value of the instance component (or 0), which often corresponds to a time index/value. | |
| const fileName & | local () const noexcept |
| Read access to local path component. | |
| fileName & | local () noexcept |
| Modifiable access to the local path component. | |
| fileName | path () const |
| The complete path for the object (with instance, local,...). | |
| fileName | globalPath () const |
| The complete global path for the object (with instance, local,...). | |
| fileName | path (IOobjectOption::Layout) const |
| The complete path (normal or global) for the object. | |
| fileName | path (const word &instance, const fileName &local=fileName::null) const |
| The complete path with alternative instance and local. | |
| fileName | globalPath (const word &instance, const fileName &local=fileName::null) const |
| The complete global path with alternative instance and local. | |
| fileName | path (IOobjectOption::Layout, const word &instance, const fileName &local=fileName::null) const |
| The complete path (normal or global) with alternative instance and local. | |
| fileName | objectPath () const |
| The complete path + object name. | |
| fileName | globalObjectPath () const |
| The complete global path + object name. | |
| fileName | objectPath (IOobjectOption::Layout) const |
| The complete path (normal or global) + object name. | |
| fileName | objectPath (IOobjectOption::Layout, const word &instance) const |
| The complete path (normal or global) + object name with alternative instance. | |
| fileName | objectPath (const word &instance) const |
| The complete path + object name with alternative instance. | |
| fileName | globalObjectPath (const word &instance) const |
| The complete global path + object name with alternative instance. | |
| fileName | objectRelPath () const |
| The object path relative to the case. | |
| fileName | localFilePath (const word &typeName, const bool search=true) const |
| Redirect to fileHandler filePath, searching locally. | |
| fileName | globalFilePath (const word &typeName, const bool search=true) const |
| Redirect to fileHandler filePath, searching up if in parallel. | |
| IOstreamOption | parseHeader (const dictionary &headerDict) |
| Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics. | |
| bool | readHeader (Istream &is) |
| Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics. | |
| bool | readHeader (dictionary &headerDict, Istream &is) |
| Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics. | |
| template<class Type> | |
| bool | typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true) |
Read header (respects is_globalIOobject trait) and check its info. A void type suppresses trait and type-name checks. | |
| template<class Type, bool Searching> | |
| bool | typeHeaderOk (const bool checkType=true, const bool verbose=true) |
Forwards to single-parameter version with the specified search type. A void type suppresses trait and type-name checks. | |
| template<class Type> | |
| fileName | typeFilePath (const bool search=true) const |
| Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait. | |
| template<class Type> | |
| void | warnNoRereading () const |
| Helper: warn that type does not support re-reading. | |
| bool | writeHeader (Ostream &os) const |
| Write header with current type(). | |
| bool | writeHeader (Ostream &os, const word &objectType) const |
| Write header with override of type. | |
| void | writeHeader (dictionary &dict, IOstreamOption streamOpt) const |
| Write header into a dictionary with current type() and given output format. | |
| void | writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const |
| Write header into a dictionary with override of type and given output format. | |
| bool | good () const noexcept |
| Did last readHeader() succeed? | |
| bool | bad () const noexcept |
| Did last readHeader() fail? | |
| InfoProxy< IOobject > | info () const noexcept |
| Return info proxy, for printing information to a stream. | |
| void | operator= (const IOobject &io) |
| Copy assignment, copies all values (except the registry). | |
| template<class Type> | |
| bool | isHeaderClassName () const |
| Same as isHeaderClass(). | |
| template<class StringType> | |
| Foam::word | groupName (StringType base, const word &group) |
| template<class Type> | |
| Foam::fileName | typeFilePath (const bool search) const |
| Public Member Functions inherited from IOobjectOption | |
| constexpr | IOobjectOption (readOption rOpt=readOption::NO_READ, writeOption wOpt=writeOption::NO_WRITE, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
| Default construct (NO_READ, NO_WRITE, REGISTER, non-global) or construct with specified options. | |
| constexpr | IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
| Construct NO_WRITE with specified read/register options. | |
| constexpr | IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
| Construct NO_READ with specified write/register options. | |
| constexpr | IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept |
| Construct (NO_READ, NO_WRITE) with specified register option. | |
| constexpr | IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept |
| Construct from components with specified register option as bool. | |
| constexpr | IOobjectOption (bool registerObject, bool globalObject=false) noexcept |
| Construct (NO_READ, NO_WRITE) with specified register option as bool. | |
| readOption | readOpt () const noexcept |
| Get the read option. | |
| readOption | readOpt (readOption opt) noexcept |
| Set the read option. | |
| writeOption | writeOpt () const noexcept |
| Get the write option. | |
| writeOption | writeOpt (writeOption opt) noexcept |
| Set the write option. | |
| bool | registerObject () const noexcept |
| Should objects created with this IOobject be registered? | |
| bool | registerObject (bool on) noexcept |
| Change registration preference. | |
| bool | globalObject () const noexcept |
| True if object is treated the same for all processors. | |
| bool | globalObject (bool on) noexcept |
| Change global-object status. | |
| bool | isAnyRead () const noexcept |
| True if any reading may be required (ie, != NO_READ). | |
| bool | isReadRequired () const noexcept |
| True if (MUST_READ | READ_MODIFIED) bits are set. | |
| bool | isReadOptional () const noexcept |
| True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. | |
| readOption & | readOpt () noexcept |
| Access to the read option. | |
| writeOption & | writeOpt () noexcept |
| Access to the write option. | |
| bool & | registerObject () noexcept |
| Access to the register object option. | |
| bool & | globalObject () noexcept |
| Access to the global object option. | |
| Public Member Functions inherited from HashTable< regIOobject * > | |
| Foam::List< word > | sortedToc (const Compare &comp) const |
| Foam::List< word > | tocKeys (const UnaryPredicate &pred, const bool invert) const |
| Foam::List< word > | tocValues (const UnaryPredicate &pred, const bool invert) const |
| Foam::List< word > | tocEntries (const BinaryPredicate &pred, const bool invert) const |
| Foam::label | countKeys (const UnaryPredicate &pred, const bool invert) const |
| Foam::label | countValues (const UnaryPredicate &pred, const bool invert) const |
| Foam::label | countEntries (const BinaryPredicate &pred, const bool invert) const |
| Foam::label | erase (InputIter first, InputIter last) |
| Foam::label | erase (const FixedList< word, N > &keys) |
| Foam::label | erase (const HashTable< AnyType, word, AnyHash > &other) |
| Foam::label | retain (const HashTable< AnyType, word, AnyHash > &other) |
| Foam::label | filterKeys (const UnaryPredicate &pred, const bool pruning) |
| Foam::label | filterValues (const UnaryPredicate &pred, const bool pruning) |
| Foam::label | filterEntries (const BinaryPredicate &pred, const bool pruning) |
| constexpr | HashTable () noexcept |
| Default construct: empty without allocation (capacity=0). | |
| ~HashTable () | |
| Destructor. | |
| bool | empty () const noexcept |
| True if the hash table is empty. | |
| label | size () const noexcept |
| The number of elements in table. | |
| label | capacity () const noexcept |
| The size of the underlying table (the number of buckets). | |
| regIOobject *& | at (const word &key) |
| Find and return a hashed entry. FatalError if it does not exist. | |
| bool | contains (const word &key) const |
| True if hashed key is contained (found) in table. | |
| iterator | find (const word &key) |
| Find and return an iterator set at the hashed entry. | |
| const_iterator | cfind (const word &key) const |
| Find and return an const_iterator set at the hashed entry. | |
| const regIOobject *& | lookup (const word &key, const regIOobject *&deflt) const |
| Return hashed entry if it exists, or return the given default. | |
| List< word > | toc () const |
| The table of contents (the keys) in unsorted order. | |
| UPtrList< const node_type > | csorted () const |
| Const access to the hash-table contents in sorted order (sorted by keys). | |
| UPtrList< node_type > | sorted () |
| Non-const access to the hash-table contents in sorted order (sorted by keys). | |
| bool | emplace (const word &key, Args &&... args) |
| Emplace insert a new entry, not overwriting existing entries. | |
| bool | emplace_set (const word &key, Args &&... args) |
| Emplace set an entry, overwriting any existing entries. | |
| bool | insert (const word &key, const regIOobject *&obj) |
| Copy insert a new entry, not overwriting existing entries. | |
| bool | set (const word &key, const regIOobject *&obj) |
| Copy assign a new entry, overwriting existing entries. | |
| void | clear () |
| Remove all entries from table. | |
| void | clearStorage () |
| Remove all entries from table and the table itself. | |
| void | setCapacity (label newCapacity) |
| Change the hash table capacity (number of buckets). | |
| void | resize (label newCapacity) |
| Rehash the hash table with new number of buckets. Currently identical to setCapacity(). | |
| void | reserve (label numEntries) |
| Reserve space for at least the specified number of elements (not the number of buckets) and regenerates the hash table. | |
| void | swap (HashTable< regIOobject *, word, Foam::Hash< word > > &rhs) noexcept |
| Swap contents into this table. | |
| void | transfer (HashTable< regIOobject *, word, Foam::Hash< word > > &rhs) |
| Transfer contents into this table. | |
| void | merge (HashTable< regIOobject *, word, Foam::Hash< word > > &source) |
Attempts to extract entries from source parameter and insert them into this, does not overwrite existing entries. The source will contains any items that could not be merged. | |
| regIOobject *& | operator[] (const word &key) |
| Find and return a hashed entry. FatalError if it does not exist. | |
| regIOobject *& | operator() (const word &key) |
| Return existing entry or create a new entry. | |
| void | operator= (const this_type &rhs) |
| Copy assign. | |
| bool | operator== (const this_type &rhs) const |
| Equality. Tables are equal if all keys and values are equal, independent of order or underlying storage size. | |
| bool | operator!= (const this_type &rhs) const |
| The opposite of the equality operation. | |
| this_type & | operator+= (const this_type &rhs) |
| Add entries into this HashTable. | |
| const_iterator_pair< const_key_iterator, this_type > | keys () const |
| A const iterator begin/end pair for iterating over keys. | |
| iterator | begin () |
| iterator set to the beginning of the HashTable | |
| const_iterator | cbegin () const |
| const_iterator set to the beginning of the HashTable | |
| iterator | end () noexcept |
| iterator to signal the end (for any HashTable) | |
| constexpr const_iterator | cend () const noexcept |
| const_iterator to signal the end (for any HashTable) | |
| Ostream & | printInfo (Ostream &os) const |
| Print information. | |
| Ostream & | writeKeys (Ostream &os, const label shortLen=0) const |
| Write unordered keys (list), with line-breaks when length exceeds shortLen. | |
| bool | found (const word &key) const |
| Same as contains(). | |
| Public Member Functions inherited from HashTableCore | |
| ClassName ("HashTable") | |
| Declare type-name (with debug switch). | |
| constexpr | HashTableCore () noexcept=default |
| Default construct. | |
| Public Member Functions inherited from PrimitivePatch<::Foam::List< face >, pointField > | |
| PrimitivePatch (const ::Foam::List< face > &faces, const pointField &points) | |
| Construct from components. | |
| PrimitivePatch (::Foam::List< face > &&faces, const pointField &points) | |
| Construct from components, transferring faces. | |
| PrimitivePatch (::Foam::List< face > &faces, pointField &points, const bool reuse) | |
| Construct from components, reuse storage. | |
| PrimitivePatch (const PrimitivePatch< ::Foam::List< face >, pointField > &pp) | |
| Copy construct. | |
| virtual | ~PrimitivePatch () |
| Destructor. | |
| void | clearOut () |
| void | clearGeom () |
| void | clearTopology () |
| void | clearPatchMeshAddr () |
| void | swap (PrimitivePatch &)=delete |
| Suppress direct swapping, since storage containers may be const. | |
| const Field< point_type > & | points () const noexcept |
| Return reference to global points. | |
| label | nFaces () const noexcept |
| Number of faces in the patch. | |
| label | nPoints () const |
| Number of points supporting patch faces. | |
| label | nEdges () const |
| Number of edges in patch. | |
| const edgeList & | edges () const |
| Return list of edges, address into LOCAL point list. | |
| const edgeList::subList | internalEdges () const |
| Return sub-list of internal edges, address into LOCAL point list. | |
| const edgeList::subList | boundaryEdges () const |
| Return sub-list of boundary edges, address into LOCAL point list. | |
| label | nInternalEdges () const |
| Number of internal edges. | |
| label | nBoundaryEdges () const |
| Number of boundary edges == (nEdges() - nInternalEdges()). | |
| bool | isInternalEdge (const label edgei) const |
| Is internal edge? | |
| const labelList & | boundaryPoints () const |
| Return list of boundary points, address into LOCAL point list. | |
| const labelListList & | faceFaces () const |
| Return face-face addressing. | |
| const labelListList & | edgeFaces () const |
| Return edge-face addressing. | |
| const labelListList & | faceEdges () const |
| Return face-edge addressing. | |
| const labelListList & | pointEdges () const |
| Return point-edge addressing. | |
| const labelListList & | pointFaces () const |
| Return point-face addressing. | |
| const List< face_type > & | localFaces () const |
| Return patch faces addressing into local point list. | |
| labelList | boundaryFaces () const |
| Extract list of local faces corresponding to the boundary edges. | |
| labelList | uniqBoundaryFaces () const |
| Extract sorted list of unique local faces associated with the boundary edges. | |
| const labelList & | meshPoints () const |
| Return labelList of mesh points in patch. | |
| const Map< label > & | meshPointMap () const |
| Mesh point map. | |
| const Field< point_type > & | localPoints () const |
| Return pointField of points in patch. | |
| const labelList & | localPointOrder () const |
| Return orders the local points for most efficient search. | |
| label | whichPoint (const label gp) const |
| Given a global point index, return the local point index. | |
| edge | meshEdge (const label edgei) const |
| From patch edge to global edge using meshPoints. | |
| edge | meshEdge (const edge &e) const |
| From patch edge to global edge using meshPoints. | |
| label | findEdge (const edge &e) const |
| Search for edge (local point labels) and return its index in the edge list or -1 if not found. | |
| labelList | meshEdges (const edgeList &allEdges, const labelListList &cellEdges, const labelList &faceCells) const |
| Return labels of patch edges in the global edge list using cell addressing. | |
| labelList | meshEdges (const edgeList &allEdges, const labelListList &pointEdges) const |
| Return labels of patch edges into the global edge list using basic edge addressing. | |
| label | meshEdge (const label edgei, const edgeList &allEdges, const labelListList &pointEdges) const |
| Return label of the local patch edge into the global edge list using basic edge addressing. | |
| labelList | meshEdges (const labelUList &edgeLabels, const edgeList &allEdges, const labelListList &pointEdges) const |
| Return labels of specified patch edges into the global edge list using basic edge addressing. | |
| const Field< point_type > & | faceCentres () const |
| Return face centres for patch. | |
| const Field< point_type > & | faceAreas () const |
| Return face area vectors for patch. | |
| const Field< scalar > & | magFaceAreas () const |
| Return face area magnitudes for patch. | |
| const Field< point_type > & | faceNormals () const |
| Return face unit normals for patch. | |
| const Field< point_type > & | pointNormals () const |
| Return point normals for patch. | |
| Pair< point_type > | box () const |
| The enclosing (bounding) box for the patch points. | |
| scalar | sphere (const label facei) const |
| The enclosing (bounding) sphere radius^2 for specified face. | |
| bool | hasFaceAreas () const |
| bool | hasFaceCentres () const |
| bool | hasFaceNormals () const |
| bool | hasPointNormals () const |
| bool | hasBoundaryPoints () const |
| bool | hasEdges () const |
| bool | hasFaceFaces () const |
| bool | hasEdgeFaces () const |
| bool | hasFaceEdges () const |
| bool | hasPointEdges () const |
| bool | hasPointFaces () const |
| bool | hasMeshPoints () const |
| bool | hasMeshPointMap () const |
| List< objectHit > | projectPoints (const ToPatch &targetPatch, const Field< point_type > &projectionDirection, const intersection::algorithm=intersection::FULL_RAY, const intersection::direction=intersection::VECTOR) const |
| Project vertices of patch onto another patch. | |
| List< objectHit > | projectFaceCentres (const ToPatch &targetPatch, const Field< point_type > &projectionDirection, const intersection::algorithm=intersection::FULL_RAY, const intersection::direction=intersection::VECTOR) const |
| Project vertices of patch onto another patch. | |
| const labelListList & | edgeLoops () const |
| Return list of closed loops of boundary vertices. | |
| surfaceTopo | surfaceType (labelHashSet *badEdgesPtr=nullptr) const |
| Calculate surface type formed by patch, optionally recording the indices of illegal edges. | |
| bool | checkTopology (const bool report=false, labelHashSet *pointSetPtr=nullptr) const |
| Check surface formed by patch for manifoldness (see above). | |
| bool | checkPointManifold (const bool report=false, labelHashSet *pointSetPtr=nullptr) const |
| Checks primitivePatch for faces sharing point but not edge. | |
| virtual void | movePoints (const Field< point_type > &) |
| Correct patch after moving points. | |
| void | operator= (const PrimitivePatch< ::Foam::List< face >, pointField > &rhs) |
| Copy assign faces. Leave points alone (could be a reference). | |
| void | operator= (PrimitivePatch< ::Foam::List< face >, pointField > &&rhs) |
| Move assign faces. Leave points alone (could be a reference). | |
| label | whichEdge (const edge &e) const |
| Identical to findEdge. | |
| Foam::List< Foam::objectHit > | projectPoints (const ToPatch &targetPatch, const Field< typename Foam::PrimitivePatch< ::Foam::List< face >, pointField >::point_type > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const |
| Foam::List< Foam::objectHit > | projectFaceCentres (const ToPatch &targetPatch, const Field< typename Foam::PrimitivePatch< ::Foam::List< face >, pointField >::point_type > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const |
| Public Member Functions inherited from PrimitivePatchBase | |
| ClassName ("PrimitivePatch") | |
| Runtime type information. | |
| PrimitivePatchBase ()=default | |
| Default construct. | |
| Public Member Functions inherited from List< face > | |
| constexpr | List () noexcept |
| Default construct. | |
| List (const label len) | |
| Construct with given size. | |
| List (const label len, const face &val) | |
| Construct with given size and value for all elements. | |
| List (const label len, Foam::zero) | |
| Construct with given size initializing all elements to zero. | |
| List (Foam::one, const face &val) | |
| Construct with length=1, copying the value as the only content. | |
| List (Foam::one, face &&val) | |
| Construct with length=1, moving the value as the only content. | |
| List (Foam::one, Foam::zero) | |
| Construct with length=1, initializing content to zero. | |
| List (const List< face > &list) | |
| Copy construct from list. | |
| List (const UList< face > &list) | |
| Copy construct contents from list. | |
| List (List< face > &list, bool reuse) | |
| Construct as copy or re-use as specified. | |
| List (const UList< face > &list, const labelUList &indices) | |
| Copy construct subset of list. | |
| List (const UList< face > &list, const FixedList< label, N > &indices) | |
| Copy construct subset of list. | |
| List (const FixedList< face, N > &list) | |
| Construct as copy of FixedList<T, N>. | |
| List (const UPtrList< face > &list) | |
| Construct as copy of UPtrList<T> content. | |
| List (const IndirectListBase< face, Addr > &list) | |
| Construct as copy of IndirectList contents. | |
| List (std::initializer_list< face > list) | |
| Construct from an initializer list. | |
| List (List< face > &&list) noexcept | |
| Move construct from List. | |
| List (DynamicList< face, SizeMin > &&list) | |
| Move construct from DynamicList. | |
| List (Istream &is) | |
| Construct from Istream. | |
| autoPtr< List< face > > | clone () const |
| Clone. | |
| ~List () | |
| Destructor. | |
| void | clear () |
| Clear the list, i.e. set size to zero. | |
| void | resize (const label len) |
| Adjust allocated size of list. | |
| void | resize (const label len, const face &val) |
| Adjust allocated size of list and set val for new elements. | |
| void | resize_copy (label count, const label len) |
| Change allocated size of list, retaining the first count elements. | |
| void | resize_fill (const label len, const face &val) |
| Adjust allocated size of list and set val for all elements. | |
| void | resize_nocopy (const label len) |
| Adjust allocated size of list without necessarily. | |
| void | transfer (List< face > &list) |
| Transfer the contents of the argument List into this list and annul the argument list. | |
| void | transfer (DynamicList< face, SizeMin > &list) |
| Transfer the contents of the argument List into this list and annul the argument list. | |
| face & | newElmt (const label i) |
| Return subscript-checked element of UList and resizing the list if required. | |
| face & | emplace_back (Args &&... args) |
| Construct an element at the end of the list, return reference to the new list element. | |
| void | push_back (const face &val) |
| Append an element at the end of the list. | |
| void | push_back (face &&val) |
| Move append an element at the end of the list. | |
| void | push_back (const UList< face > &list) |
| Append a List to the end of this list. | |
| void | push_back (const IndirectListBase< face, Addr > &list) |
| Append IndirectList contents at the end of this list. | |
| label | push_uniq (const face &val) |
| Append an element if not already in the list. | |
| void | pop_back (label n=1) |
| Reduce size by 1 or more elements. Can be called on an empty list. | |
| void | operator= (const UList< face > &list) |
| Assignment to UList operator. Takes linear time. | |
| void | operator= (const List< face > &list) |
| Assignment operator. Takes linear time. | |
| void | operator= (const IndirectListBase< face, Addr > &list) |
| Assignment from IndirectList. Takes linear time. | |
| void | operator= (const FixedList< face, N > &list) |
| Copy assignment from FixedList. | |
| void | operator= (std::initializer_list< face > list) |
| Assignment to an initializer list. | |
| void | operator= (const face &val) |
| Assignment of all entries to the given value. | |
| void | operator= (Foam::zero) |
| Assignment of all entries to zero. | |
| void | operator= (List< face > &&list) |
| Move assignment. Takes constant time. | |
| void | operator= (DynamicList< face, SizeMin > &&list) |
| Move assignment. Takes constant time. | |
| Istream & | readList (Istream &is) |
| Read List from Istream, discarding contents of existing List. | |
| void | shallowCopy (const UList< face > &)=delete |
| No shallowCopy permitted. | |
| bool | set (const label i, bool val=true) |
| A bitSet::set() method for a list of bool. | |
| void | append (const face &val) |
| Append an element at the end of the list. | |
| void | append (face &&val) |
| Move append an element at the end of the list. | |
| void | append (const UList< face > &list) |
| Append a List to the end of this list. | |
| void | append (const IndirectListBase< face, Addr > &list) |
| Append IndirectList contents at the end of this list. | |
| label | appendUniq (const face &val) |
| Same as push_uniq(). | |
| void | setSize (label n) |
| Alias for resize(). | |
| void | setSize (label n, const face &val) |
| Alias for resize(). | |
| List (const Expression::ListExpression< E > &expr) | |
| Construct from value expression. | |
| void | operator= (const Expression::ListExpression< E > &expr) |
| Assign values from expression. | |
| void | resize (const label len) |
| Public Member Functions inherited from UList< face > | |
| UList (const UList< face > &) noexcept=default | |
| Copy construct, shallow copy. | |
| UList (UList< face > &&) noexcept=default | |
| Move construct, shallow copy. | |
| UList< face > & | operator= (const UList< face > &)=delete |
| No copy assignment (default: shallow copy). | |
| UList< face > & | operator= (UList< face > &&) noexcept=default |
| Move assignment, shallow copy. | |
| constexpr | UList () noexcept |
| Default construct, zero-sized and nullptr. | |
| UList (face *__restrict__ ptr, const label len) noexcept | |
| Construct from components. | |
| UList (SubList< face > &&) noexcept | |
| Move construct from a SubList, shallow copy. | |
| label | fcIndex (const label i) const noexcept |
| The forward circular index. The next index in the list which returns to the first at the end of the list. | |
| label | rcIndex (const label i) const noexcept |
| The reverse circular index. The previous index in the list which returns to the last at the beginning of the list. | |
| const face & | fcValue (const label i) const |
| Return forward circular value (ie, next value in the list). | |
| face & | fcValue (const label i) |
| Return forward circular value (ie, next value in the list). | |
| const face & | rcValue (const label i) const |
| Return reverse circular value (ie, previous value in the list). | |
| face & | rcValue (const label i) |
| Return reverse circular value (ie, previous value in the list). | |
| const face * | cdata () const noexcept |
| Return pointer to the underlying array serving as data storage. | |
| face * | data () noexcept |
| Return pointer to the underlying array serving as data storage. | |
| const char * | cdata_bytes () const noexcept |
| Return pointer to the underlying array serving as data storage,. | |
| char * | data_bytes () noexcept |
| Return pointer to the underlying array serving as data storage,. | |
| face & | front () |
| Access first element of the list, position [0]. | |
| const face & | front () const |
| Access first element of the list. | |
| face & | back () |
| Access last element of the list, position [size()-1]. | |
| const face & | back () const |
| Access last element of the list, position [size()-1]. | |
| std::streamsize | size_bytes () const noexcept |
| Number of contiguous bytes for the List data. | |
| std::streamsize | byteSize () const |
| Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous. | |
| void | checkStart (const label start) const |
| Check start is within valid range [0,size). | |
| void | checkSize (const label size) const |
| Check size is within valid range [0,size]. | |
| void | checkRange (const label start, const label len) const |
| Check that start and length define a valid range. | |
| void | checkIndex (const label i) const |
| Check index is within valid range [0,size). | |
| bool | uniform () const |
| True if all entries have identical values, and list is non-empty. | |
| bool | contains (const face &val) const |
| True if the value is contained in the list. | |
| bool | contains (const face &val, label pos, label len=-1) const |
| Is the value contained in the list? | |
| label | find (const face &val) const |
| Find index of the first occurrence of the value. | |
| label | find (const face &val, label pos, label len=-1) const |
| Find index of the first occurrence of the value. | |
| label | rfind (const face &val, label pos=-1) const |
| Find index of the last occurrence of the value. | |
| void | moveFirst (const label i) |
| Move element to the first position. | |
| void | moveLast (const label i) |
| Move element to the last position. | |
| void | swapFirst (const label i) |
| Swap element with the first element. Fatal on an empty list. | |
| void | swapLast (const label i) |
| Swap element with the last element. Fatal on an empty list. | |
| void | shallowCopy (face *__restrict__ ptr, const label len) noexcept |
| Copy the pointer and size. | |
| void | shallowCopy (std::nullptr_t) noexcept |
| Copy nullptr and zero size. | |
| void | shallowCopy (const UList< face > &list) noexcept |
| Copy the pointer and size held by the given UList. | |
| void | deepCopy (const UList< face > &list) |
| Copy elements of the given UList. Sizes must match! | |
| void | deepCopy (const IndirectListBase< face, Addr > &list) |
| Copy elements of the given indirect list. Sizes must match! | |
| SubList< face > | slice (const label pos, label len=-1) |
| Return SubList slice (non-const access) - no range checking. | |
| const SubList< face > | slice (const label pos, label len=-1) const |
| Return SubList slice (const access) - no range checking. | |
| SubList< face > | slice (const labelRange &range) |
| Return SubList slice (non-const access) - with range checking. | |
| const SubList< face > | slice (const labelRange &range) const |
| Return SubList slice (const access) - with range checking. | |
| face & | operator[] (const label i) |
| Return element of UList. | |
| const face & | operator[] (const label i) const |
| Return element of constant UList. | |
| operator const Foam::List< face > & () const | |
| Allow cast to a const List<T>&. | |
| void | operator= (const face &val) |
| Assignment of all entries to the given value. | |
| void | operator= (Foam::zero) |
| Assignment of all entries to zero. | |
| iterator | begin () noexcept |
| Return an iterator to begin traversing the UList. | |
| iterator | end () noexcept |
| Return an iterator to end traversing the UList. | |
| iterator | begin (const label i) noexcept |
| Return iterator at offset i from begin, clamped to [0,size] range. | |
| const_iterator | cbegin () const noexcept |
| Return const_iterator to begin traversing the constant UList. | |
| const_iterator | cend () const noexcept |
| Return const_iterator to end traversing the constant UList. | |
| const_iterator | begin () const noexcept |
| Return const_iterator to begin traversing the constant UList. | |
| const_iterator | end () const noexcept |
| Return const_iterator to end traversing the constant UList. | |
| const_iterator | cbegin (const label i) const noexcept |
| Return const_iterator at offset i from begin, clamped to [0,size] range. | |
| const_iterator | begin (const label i) const noexcept |
| Return const_iterator at offset i from begin, clamped to [0,size] range. | |
| reverse_iterator | rbegin () |
| Return reverse_iterator to begin reverse traversing the UList. | |
| reverse_iterator | rend () |
| Return reverse_iterator to end reverse traversing the UList. | |
| const_reverse_iterator | crbegin () const |
| Return const_reverse_iterator to begin reverse traversing the UList. | |
| const_reverse_iterator | crend () const |
| Return const_reverse_iterator to end reverse traversing the UList. | |
| const_reverse_iterator | rbegin () const |
| Return const_reverse_iterator to begin reverse traversing the UList. | |
| const_reverse_iterator | rend () const |
| Return const_reverse_iterator to end reverse traversing the UList. | |
| bool | empty () const noexcept |
| True if List is empty (ie, size() is zero). | |
| label | size () const noexcept |
| The number of elements in the container. | |
| label | capacity () const noexcept |
| Size of the underlying storage. | |
| void | swap (UList< face > &list) noexcept |
| Swap content with another UList of the same type in constant time. | |
| bool | operator== (const UList< face > &list) const |
| Equality operation on ULists of the same type. | |
| bool | operator!= (const UList< face > &list) const |
| The opposite of the equality operation. Takes linear time. | |
| bool | operator< (const UList< face > &list) const |
| Compare two ULists lexicographically. Takes linear time. | |
| bool | operator> (const UList< face > &list) const |
| Compare two ULists lexicographically. Takes linear time. | |
| bool | operator<= (const UList< face > &list) const |
| Return true if !(a > b). Takes linear time. | |
| bool | operator>= (const UList< face > &list) const |
| Return true if !(a < b). Takes linear time. | |
| Istream & | readList (Istream &is) |
| Read List contents from Istream. | |
| void | writeEntry (const word &keyword, Ostream &os) const |
| Write the List as a dictionary entry with keyword. | |
| Ostream & | writeList (Ostream &os, const label shortLen=0) const |
| Write List, with line-breaks in ASCII when length exceeds shortLen. | |
| bool | all () const |
| True if all entries are 'true' or if the list is empty. | |
| bool | any () const |
| True if any entries are 'true'. | |
| bool | none () const |
| True if no entries are 'true'. | |
| bool | test (const label i) const |
Test bool value at specified position, always false for out-of-range access. | |
| bool | get (const label i) const |
Return bool value at specified position, always false for out-of-range access. | |
| bool | unset (const label i) |
Unset the bool entry at specified position, always false for out-of-range access. | |
| std::string_view | view () const |
| Return a string_view of the charList. Content is non-modifiable. | |
| face & | first () |
| Access first element of the list, position [0]. | |
| const face & | first () const |
| Access first element of the list. | |
| face & | last () |
| Access last element of the list, position [size()-1]. | |
| const face & | last () const |
| Access last element of the list, position [size()-1]. | |
| bool | found (const face &val, label pos=0) const |
| Same as contains(). | |
| auto | expr () const |
| Wrap value as expression. | |
| void | operator= (const Expression::ListExpression< E > &expr) |
| Assign values from expression. | |
| operator const Foam::List< face > & () const | |
| Allow cast to a const List<T>&. | |
| Public Member Functions inherited from meshedSurf | |
| constexpr | meshedSurf () noexcept=default |
| Default construct. | |
| virtual | ~meshedSurf ()=default |
| Destructor. | |
| virtual const labelList & | faceIds () const |
| Per-face identifier (eg, element Id). | |
Static Public Member Functions | |
| static polySurface & | New (const word &surfName, const objectRegistry &) |
| Get or create (NO_READ, NO_WRITE) named surface on registry. | |
| static bool | Delete (const word &surfName, const objectRegistry &) |
| Remove named surface from specified registry. | |
| Static Public Member Functions inherited from regIOobject | |
| template<class Type> | |
| static Type & | store (Type *p) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (std::unique_ptr< Type > &&ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (autoPtr< Type > &ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (autoPtr< Type > &&ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (refPtr< Type > &ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (refPtr< Type > &&ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (tmp< Type > &ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (tmp< Type > &&ptr) |
| Transfer pointer ownership to its registry. | |
| Static Public Member Functions inherited from IOobject | |
| static bool | bannerEnabled () noexcept |
| Status of output file banner. | |
| static bool | bannerEnabled (bool on) noexcept |
| Enable/disable output file banner. | |
| static bool | fileModificationChecking_masterOnly () noexcept |
| Test fileModificationChecking for master-only. | |
| static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
| Split path into instance, local, name components. | |
| template<class StringType> | |
| static word | groupName (StringType base, const word &group) |
| Create dot-delimited name.group string. | |
| static word | group (const word &name) |
| Return group (extension part of name). | |
| static word | member (const word &name) |
| Return member (name without the extension). | |
| static word | scopedName (const std::string &scope, const word &name) |
| Create scope:name or scope_name string. | |
| static word | scopedName (const std::string &scope, const word &name1, const word &name2) |
| Create scope:name1:name2 or scope_name1_name2 string. | |
| static IOobject | selectIO (const IOobject &io, const fileName &altFile, const word &ioName="") |
| Return the IOobject, but also consider an alternative file name. | |
| static Ostream & | writeBanner (Ostream &os, const bool noSyntaxHint=false) |
| Write the standard OpenFOAM file/dictionary banner. | |
| static Ostream & | writeDivider (Ostream &os) |
| Write the standard file section divider. | |
| static Ostream & | writeEndDivider (Ostream &os) |
| Write the standard end file divider. | |
| Static Public Member Functions inherited from IOobjectOption | |
| static bool | isAnyRead (readOption opt) noexcept |
| True if any reading may be required (ie, != NO_READ). | |
| static bool | isReadRequired (readOption opt) noexcept |
| True if (MUST_READ | READ_MODIFIED) bits are set. | |
| static bool | isReadOptional (readOption opt) noexcept |
| True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. | |
| static readOption | lazierRead (readOption opt) noexcept |
| Downgrade readOption optional (LAZY_READ), leaves NO_READ intact. | |
| Static Public Member Functions inherited from HashTableCore | |
| static label | canonicalSize (const label size) noexcept |
| Return a canonical (power-of-two) of the requested size. | |
| Static Public Member Functions inherited from List< face > | |
| static const List< face > & | null () noexcept |
| Return a null List (reference to a nullObject). Behaves like an empty List. | |
| Static Public Member Functions inherited from UList< face > | |
| static const UList< face > & | null () noexcept |
| Return a null UList (reference to a nullObject). Behaves like an empty UList. | |
| static constexpr label | max_size () noexcept |
| The size of the largest possible UList. | |
Static Public Attributes | |
| static const word | pointDataName |
| Name for point fields sub-registry. | |
| Static Public Attributes inherited from IOobject | |
| static const Enum< fileCheckTypes > | fileCheckTypesNames |
| Names for the fileCheckTypes. | |
| static char | scopeSeparator |
| Character for scoping object names (':' or '_'). | |
| static fileCheckTypes | fileModificationChecking |
| Type of file modification checking. | |
| static float | fileModificationSkew |
| Time skew (seconds) for file modification checks. | |
| static int | maxFileModificationPolls |
| Max number of times to poll for file modification changes. | |
| Static Public Attributes inherited from HashTableCore | |
| static constexpr int32_t | maxTableSize = (1 << (32-3)) |
| Maximum allowable internal table size (must be a power of two!). | |
Protected Member Functions | |
| pointField & | storedPoints () |
| Non-const access to points. | |
| faceList & | storedFaces () |
| Non-const access to the faces. | |
| const faceList & | storedFaces () const |
| Const access to the faces. | |
| Protected Member Functions inherited from regIOobject | |
| bool | readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName) |
| Helper: check readOpt flags and read if necessary. | |
| Protected Member Functions inherited from IOobject | |
| void | setBad (const string &s) |
| Set the object state to bad. | |
| Protected Member Functions inherited from UList< face > | |
| void | setAddressableSize (const label n) noexcept |
| Set addressed size to be inconsistent with allocated storage. | |
| void | size (const label n) |
| Older name for setAddressableSize. | |
| void | writeEntry (Ostream &os) const |
| Write the UList with its compound type. | |
| labelRange | validateRange (const labelRange &requestedRange) const |
| Return a validated (start,size) subset range, which means that it always addresses a valid section of the list. | |
| void | fill_uniform (const face &val) |
| Assign all entries to the given value. | |
| void | fill_uniform (Foam::zero) |
| Assign all entries to zero. | |
Additional Inherited Members | |
| Static Protected Member Functions inherited from IOobject | |
| static void | writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr) |
| Helper: write content for FoamFile IOobject header with optional meta information. | |
| static void | writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr) |
| Helper: write dictionary content for FoamFile header with optional meta information. | |
| Static Protected Attributes inherited from regIOobject | |
| static bool | masterOnlyReading = false |
| To flag master-only reading of objects. | |
A surface mesh consisting of general polygon faces and capable of holding fields.
Definition at line 62 of file polySurface.H.
| typedef polySurface Mesh |
Typedef required for GeoMesh.
Definition at line 154 of file polySurface.H.
| typedef bool BoundaryMesh |
Placeholder only, for GeoMesh.
Definition at line 159 of file polySurface.H.
| enum FieldAssociation |
Enumeration for the field association.
| Enumerator | |
|---|---|
| NO_DATA | No associated data. |
| FACE_DATA | Data associated with faces. |
| POINT_DATA | Data associated with points. |
| FACE_OR_POINT_DATA | Data associated with faces or points. |
Definition at line 73 of file polySurface.H.
|
delete |
No copy construct.
References polySurface().
Referenced by Delete(), New(), operator=(), polySurface(), polySurface(), polySurface(), and polySurface().
|
explicit |
Default construct with NO_READ, NO_WRITE optionally with a checkIn on the parent registry.
Created without a PointData sub-registry
Definition at line 75 of file polySurface.C.
References IOobject::db(), io, Foam::name(), IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, IOobjectOption::REGISTER, regIOobject::store(), and objectRegistry::time().
| polySurface | ( | const word & | surfName, |
| const objectRegistry & | obr, | ||
| bool | doCheckIn = false ) |
Default construct with specified name on the given registry, optionally with a checkIn on the parent registry.
Created without a PointData sub-registry
Definition at line 100 of file polySurface.C.
References IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, polySurface(), IOobjectOption::REGISTER, and objectRegistry::time().
| polySurface | ( | const IOobject & | io, |
| const MeshedSurface< face > & | surf, | ||
| bool | doCheckIn = false ) |
Copy construct from MeshedSurface<face> contents with NO_READ, NO_WRITE optionally with a checkIn on the parent registry.
Created without a PointData sub-registry
Definition at line 123 of file polySurface.C.
References copySurface(), io, and polySurface().
| polySurface | ( | const IOobject & | io, |
| MeshedSurface< face > && | surf, | ||
| bool | doCheckIn = false ) |
Move construct from MeshedSurface<face> contents with NO_READ, NO_WRITE optionally with a checkIn on the parent registry.
Created without a PointData sub-registry
Definition at line 136 of file polySurface.C.
References io, polySurface(), and transfer().
|
virtual |
|
inlineprotected |
Non-const access to points.
Definition at line 117 of file polySurface.H.
References PrimitivePatch<::Foam::List< face >, pointField >::points().
Referenced by copySurface(), copySurface(), copySurface(), transfer(), and transfer().
|
inlineprotected |
Non-const access to the faces.
Definition at line 125 of file polySurface.H.
Referenced by copySurface(), copySurface(), copySurface(), faces(), transfer(), and transfer().
|
inlineprotected |
Const access to the faces.
Definition at line 137 of file polySurface.H.
| TypeName | ( | "polySurface" | ) |
Runtime type information.
|
delete |
No copy assignment.
References UList< face >::begin(), UList< face >::cbegin(), UList< face >::cend(), UList< face >::end(), io, and polySurface().
|
static |
Get or create (NO_READ, NO_WRITE) named surface on registry.
Definition at line 151 of file polySurface.C.
References objectRegistry::getObjectPtr(), polySurface(), and regIOobject::store().
|
static |
Remove named surface from specified registry.
Definition at line 169 of file polySurface.C.
References objectRegistry::checkOut(), objectRegistry::getObjectPtr(), and polySurface().
Referenced by sampledSurface::removeRegistrySurface().
|
inlinevirtual |
Return the number of points.
Definition at line 272 of file polySurface.H.
References PrimitivePatch<::Foam::List< face >, pointField >::points().
|
inlinevirtual |
Return the number of faces.
Definition at line 280 of file polySurface.H.
References UList< face >::size().
|
inlinevirtual |
Return number of faces.
Definition at line 288 of file polySurface.H.
References UList< face >::size().
|
inlinevirtual |
Return points.
Implements meshedSurf.
Definition at line 297 of file polySurface.H.
References PrimitivePatch<::Foam::List< face >, pointField >::points().
Referenced by copySurface(), and transfer().
|
inlinevirtual |
Return faces.
Implements meshedSurf.
Definition at line 305 of file polySurface.H.
References storedFaces().
Referenced by copySurface(), and transfer().
|
inlinevirtual |
Const access to per-face zone/region information (demand-driven).
Reimplemented from meshedSurf.
Definition at line 313 of file polySurface.H.
Referenced by transfer().
|
inline |
Return face area vectors (normals).
Definition at line 321 of file polySurface.H.
References PrimitivePatch<::Foam::List< face >, pointField >::faceAreas().
|
inline |
Return face area magnitudes.
Definition at line 329 of file polySurface.H.
References PrimitivePatch<::Foam::List< face >, pointField >::magFaceAreas().
|
inline |
Face centres.
Definition at line 337 of file polySurface.H.
References PrimitivePatch<::Foam::List< face >, pointField >::faceCentres().
| void copySurface | ( | const pointField & | points, |
| const faceList & | faces, | ||
| bool | unused = false ) |
Update with new contents. Removes existing fields if sizes have changed.
| unused | validate the zone coverage (ignored) |
Definition at line 297 of file polySurface.C.
References clearFields(), clearOut(), faces(), nPoints, points(), UList< T >::size(), storedFaces(), and storedPoints().
Referenced by polySurface(), and sampledSurface::storeRegistrySurface().
| void copySurface | ( | const meshedSurf & | surf, |
| bool | unused = false ) |
Update with new contents. Removes existing fields if sizes have changed.
| unused | validate the zone coverage (ignored) |
Definition at line 328 of file polySurface.C.
References clearFields(), clearOut(), meshedSurf::faces(), meshedSurf::meshedSurf(), nPoints, meshedSurf::points(), UList< T >::size(), storedFaces(), storedPoints(), and meshedSurf::zoneIds().
| void copySurface | ( | const MeshedSurface< face > & | surf, |
| bool | unused = false ) |
Update with new contents. Removes existing fields if sizes have changed.
| unused | validate the zone coverage (ignored) |
Definition at line 358 of file polySurface.C.
References clearFields(), clearOut(), nPoints, PrimitivePatch< FaceList, PointField >::points(), storedFaces(), storedPoints(), MeshedSurface< Face >::surfFaces(), and MeshedSurface< Face >::surfZones().
| void transfer | ( | pointField && | points, |
| faceList && | faces, | ||
| labelList && | zoneIds = labelList() ) |
Transfer the contents (and annul the parameters). Removes existing fields.
Definition at line 388 of file polySurface.C.
References clearFields(), clearOut(), faces(), points(), storedFaces(), storedPoints(), and zoneIds().
Referenced by polySurface().
| void transfer | ( | MeshedSurface< face > & | surf, |
| bool | validate = false ) |
Transfer the contents (and annul the parameters). Removes existing fields.
| validate | validate the zone coverage |
Definition at line 404 of file polySurface.C.
References clearFields(), clearOut(), MeshedSurface< Face >::storedFaces(), storedFaces(), MeshedSurface< Face >::storedPoints(), storedPoints(), and MeshedSurface< Face >::surfZones().
| Foam::label nFaceData | ( | ) | const |
Number of main entries, without PointData sub-registry.
Definition at line 189 of file polySurface.C.
References objectRegistry::foundObject(), pointDataName, and HashTable< regIOobject * >::size().
| Foam::label nPointData | ( | ) | const |
Number of entries on PointData sub-registry (if it exists).
Definition at line 201 of file polySurface.C.
References objectRegistry::cfindObject(), and pointDataName.
| Foam::polySurface::FieldAssociation queryFieldAssociation | ( | const word & | fieldName | ) | const |
Query the field association (FACE or POINT).
Definition at line 229 of file polySurface.C.
References objectRegistry::cfindObject(), objectRegistry::contains(), FACE_DATA, NO_DATA, POINT_DATA, and pointDataName.
| const Foam::regIOobject * findFieldObject | ( | const word & | fieldName, |
| const FieldAssociation | association ) const |
Find the field object with the given name and required FieldAssociation (FACE or POINT).
For FACE_POINT_DATA, face data are checked first.
Definition at line 259 of file polySurface.C.
References objectRegistry::cfindObject(), FACE_DATA, POINT_DATA, and pointDataName.
| const regIOobject * findFieldObject | ( | const word & | fieldName | ) | const |
General finding of the field object (FACE or POINT).
Later specializations are used to restrict the scope.
| const objectRegistry * whichRegistry | ( | const word & | fieldName | ) | const |
General finding of the registry with the field object (FACE or POINT).
Later specializations are used to restrict the scope.
|
inline |
Regular data are stored directly on the registry.
Definition at line 455 of file polySurface.H.
Referenced by newField(), storeField(), and storeField().
| const Foam::objectRegistry & faceData | ( | ) | const |
Face data are stored directly on the registry.
Definition at line 215 of file polySurface.C.
| const Foam::objectRegistry & pointData | ( | ) | const |
Point data are stored in a sub-registry.
Note that this method will automatically create the corresponding sub-registry if it did not previously exist. Use the nPointData() methods instead if you wish to test for content without this side-effect.
Definition at line 221 of file polySurface.C.
References pointDataName, and objectRegistry::subRegistry().
Referenced by fieldData().
| DimensionedField< Type, GeoMeshType > & newField | ( | const word & | fieldName, |
| const dimensionSet & | dims ) |
Create/store named zero field as face or point data (template parameter).
| DimensionedField< Type, GeoMeshType > & storeField | ( | const word & | fieldName, |
| const dimensionSet & | dims, | ||
| const Field< Type > & | values ) |
Copy/store named field as face or point data (template parameter).
Referenced by sampledSurface::storeRegistryField(), and sampledSurface::storeRegistryField().
| DimensionedField< Type, GeoMeshType > & storeField | ( | const word & | fieldName, |
| const dimensionSet & | dims, | ||
| Field< Type > && | values ) |
Move/store named field as face or point data (template parameter).
|
virtual |
Write - this is a no-op.
Reimplemented from objectRegistry.
Definition at line 25 of file polySurfaceIO.C.
| void clearGeom | ( | ) |
Clear geometry.
Definition at line 25 of file polySurfaceClear.C.
References PrimitivePatch<::Foam::List< face >, pointField >::clearGeom(), DebugInFunction, and Foam::endl().
Referenced by clearOut().
| void clearAddressing | ( | ) |
Clear addressing.
Definition at line 33 of file polySurfaceClear.C.
References PrimitivePatch<::Foam::List< face >, pointField >::clearPatchMeshAddr(), DebugInFunction, and Foam::endl().
Referenced by clearOut().
| void clearOut | ( | ) |
Clear all geometry and addressing unnecessary for CFD.
Definition at line 41 of file polySurfaceClear.C.
References clearAddressing(), clearGeom(), and PrimitivePatch<::Foam::List< face >, pointField >::clearOut().
Referenced by copySurface(), copySurface(), copySurface(), transfer(), and transfer().
| void clearPrimitives | ( | ) |
Clear primitive data (points, faces and cells).
| void clearFields | ( | ) |
Clear stored fields.
Definition at line 50 of file polySurfaceClear.C.
References objectRegistry::clear().
Referenced by copySurface(), copySurface(), copySurface(), transfer(), and transfer().
| const regIOobject * findFieldObject | ( | const word & | fieldName | ) | const |
Definition at line 469 of file polySurface.C.
References objectRegistry::cfindObject().
| const regIOobject * findFieldObject | ( | const word & | fieldName | ) | const |
Definition at line 480 of file polySurface.C.
References objectRegistry::cfindObject(), and pointDataName.
| const objectRegistry * whichRegistry | ( | const word & | fieldName | ) | const |
Definition at line 501 of file polySurface.C.
References objectRegistry::contains().
| const objectRegistry * whichRegistry | ( | const word & | fieldName | ) | const |
Definition at line 519 of file polySurface.C.
References objectRegistry::cfindObject(), and pointDataName.
| const regIOobject * findFieldObject | ( | const word & | fieldName | ) | const |
Find face field object (on main registry).
| const regIOobject * findFieldObject | ( | const word & | fieldName | ) | const |
Find point field object (on sub-registry).
| const objectRegistry * whichRegistry | ( | const word & | fieldName | ) | const |
Return field object (on main registry). Face data field found on main registry?
| const objectRegistry * whichRegistry | ( | const word & | fieldName | ) | const |
Point data field found on sub-registry?
|
inline |
Point data are stored in a sub-registry.
Definition at line 617 of file polySurface.H.
References pointData().
| const Foam::regIOobject * findFieldObject | ( | const word & | fieldName | ) | const |
Definition at line 27 of file polySurfaceTemplates.C.
References objectRegistry::cfindObject(), forAllConstIters, and Foam::isA().
| const Foam::objectRegistry * whichRegistry | ( | const word & | fieldName | ) | const |
Definition at line 58 of file polySurfaceTemplates.C.
References objectRegistry::contains(), forAllConstIters, and Foam::isA().
| Foam::DimensionedField< Type, GeoMeshType > & newField | ( | const word & | fieldName, |
| const dimensionSet & | dims ) |
Definition at line 88 of file polySurfaceTemplates.C.
References fieldData(), objectRegistry::getObjectPtr(), objectRegistry::newIOobject(), IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, IOobjectOption::REGISTER, and regIOobject::store().
| Foam::DimensionedField< Type, GeoMeshType > & storeField | ( | const word & | fieldName, |
| const dimensionSet & | dims, | ||
| const Field< Type > & | values ) |
Definition at line 131 of file polySurfaceTemplates.C.
References fieldData(), objectRegistry::getObjectPtr(), objectRegistry::newIOobject(), IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, IOobjectOption::REGISTER, and regIOobject::store().
| Foam::DimensionedField< Type, GeoMeshType > & storeField | ( | const word & | fieldName, |
| const dimensionSet & | dims, | ||
| Field< Type > && | values ) |
Definition at line 175 of file polySurfaceTemplates.C.
References fieldData(), objectRegistry::getObjectPtr(), objectRegistry::newIOobject(), IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, IOobjectOption::REGISTER, and regIOobject::store().
|
static |
Name for point fields sub-registry.
Definition at line 164 of file polySurface.H.
Referenced by findFieldObject(), findFieldObject(), nFaceData(), nPointData(), pointData(), queryFieldAssociation(), and whichRegistry().
1.16.1 