IOoject and searching on triSurface. More...
Public Types | |
enum | readAction { localOnly, localOrGlobal, masterOnly } |
Public Types inherited from IOobject | |
enum | objectState : char { GOOD, BAD } |
Enumeration defining the valid states of an IOobject. More... | |
enum | fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster } |
Enumeration defining the file checking options. 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... | |
Public Types inherited from HashTable< regIOobject *> | |
typedef HashTable< regIOobject *, word, Foam::Hash< word > > | this_type |
The template instance used for this HashTable. More... | |
typedef std::conditional< std::is_same< Foam::zero, typename std::remove_cv< regIOobject * >::type >::value, Detail::HashTableSingle< word >, Detail::HashTablePair< word, regIOobject * > >::type | node_type |
A table entry (node) that encapsulates the key/val tuple with an additional linked-list entry for hash collisions. More... | |
typedef word | key_type |
The second template parameter, type of keys used. More... | |
typedef regIOobject * | mapped_type |
The first template parameter, type of objects contained. More... | |
typedef regIOobject * | value_type |
Same as mapped_type for OpenFOAM HashTables. More... | |
typedef Foam::Hash< word > | hasher |
The third template parameter, the hash index method. More... | |
typedef regIOobject * * | pointer |
Pointer type for storing into value_type objects. More... | |
typedef regIOobject * & | reference |
Reference to the stored value_type. More... | |
typedef const regIOobject * * | const_pointer |
Const pointer type for the stored value_type. More... | |
typedef const regIOobject * & | const_reference |
Const reference to the stored value_type. More... | |
typedef label | difference_type |
The type to represent the difference between two iterators. More... | |
typedef label | size_type |
The type that can represent the size of a HashTable. More... | |
using | key_iterator = key_iterator_base< iterator > |
Forward iterator returning the key. More... | |
using | const_key_iterator = key_iterator_base< const_iterator > |
Forward const iterator returning the key. More... | |
Public Types inherited from triSurface | |
typedef bool | BoundaryMesh |
Placeholder only, but do not remove - it is needed for GeoMesh. More... | |
typedef labelledTri | face_type |
The face type (same as the underlying PrimitivePatch) More... | |
typedef point | point_type |
The point type (same as the underlying PrimitivePatch) More... | |
Public Types inherited from PrimitivePatch<::Foam::List< labelledTri >, pointField > | |
enum | surfaceTopo |
Enumeration defining the surface type. Used in check routines. More... | |
typedef std::remove_reference< ::Foam::List< labelledTri > >::type::value_type | face_type |
The face type. More... | |
typedef std::remove_reference< pointField >::type::value_type | point_type |
The point type. More... | |
typedef ::Foam::List< labelledTri > | FaceListType |
The face list type. More... | |
typedef pointField | PointFieldType |
The point field type. More... | |
typedef face_type | FaceType |
Deprecated(2020-03) prefer face_type typedef. More... | |
Public Types inherited from List< labelledTri > | |
typedef SubList< labelledTri > | subList |
Declare type of subList. More... | |
Public Types inherited from UList< T > | |
typedef T | value_type |
The value type the list contains. More... | |
typedef T * | pointer |
The pointer type for non-const access to value_type items. More... | |
typedef const T * | const_pointer |
The pointer type for const access to value_type items. More... | |
typedef T & | reference |
The type used for storing into value_type objects. More... | |
typedef const T & | const_reference |
The type used for reading from constant value_type objects. More... | |
typedef T * | iterator |
Random access iterator for traversing a UList. More... | |
typedef const T * | const_iterator |
Random access iterator for traversing a UList. More... | |
typedef label | size_type |
The type to represent the size of a UList. More... | |
typedef label | difference_type |
The difference between iterator objects. More... | |
typedef std::reverse_iterator< iterator > | reverse_iterator |
Reverse iterator (non-const access) More... | |
typedef std::reverse_iterator< const_iterator > | const_reverse_iterator |
Reverse iterator (const access) More... | |
Public Member Functions | |
TypeName ("triSurfaceMesh") | |
Runtime type information. More... | |
triSurfaceMesh (const IOobject &, const triSurface &) | |
Construct from triSurface. More... | |
triSurfaceMesh (const IOobject &io) | |
Construct read. More... | |
triSurfaceMesh (const IOobject &io, const dictionary &dict) | |
Construct from IO and dictionary (used by searchableSurface). More... | |
triSurfaceMesh (const IOobject &io, const readAction r) | |
triSurfaceMesh (const IOobject &io, const dictionary &dict, const readAction r) | |
virtual | ~triSurfaceMesh () |
Destructor. More... | |
void | clearOut () |
Clear storage. More... | |
virtual void | movePoints (const pointField &) |
Move points. More... | |
const indexedOctree< treeDataEdge > & | edgeTree () const |
Demand driven construction of octree for boundary edges. More... | |
virtual const wordList & | regions () const |
Names of regions. More... | |
virtual bool | hasVolumeType () const |
Whether supports volume type (below) - i.e. whether is closed. More... | |
virtual volumeType | outsideVolumeType () const |
If surface is closed, what is type of points outside bounds. More... | |
virtual label | size () const |
Range of local indices that can be returned. More... | |
virtual tmp< pointField > | coordinates () const |
Get representative set of element coordinates. More... | |
virtual void | boundingSpheres (pointField ¢res, scalarField &radiusSqr) const |
Get bounding spheres (centre and radius squared). Any point. More... | |
virtual tmp< pointField > | points () const |
Get the points that define the surface. More... | |
virtual bool | overlaps (const boundBox &bb) const |
Does any part of the surface overlap the supplied bound box? More... | |
virtual void | findNearest (const pointField &sample, const scalarField &nearestDistSqr, List< pointIndexHit > &) const |
virtual void | findNearest (const pointField &sample, const scalarField &nearestDistSqr, const labelList ®ionIndices, List< pointIndexHit > &) const |
Find the nearest locations for the supplied points to a. More... | |
virtual void | findLine (const pointField &start, const pointField &end, List< pointIndexHit > &) const |
Find first intersection on segment from start to end. More... | |
virtual void | findLineAny (const pointField &start, const pointField &end, List< pointIndexHit > &) const |
Return any intersection on segment from start to end. More... | |
virtual void | findLineAll (const pointField &start, const pointField &end, List< List< pointIndexHit >> &) const |
Get all intersections in order from start to end. More... | |
virtual void | getRegion (const List< pointIndexHit > &, labelList ®ion) const |
From a set of points and indices get the region. More... | |
virtual void | getNormal (const List< pointIndexHit > &, vectorField &normal) const |
From a set of points and indices get the normal. More... | |
virtual void | getVolumeType (const pointField &points, List< volumeType > &volType) const |
Determine type (inside/outside/mixed) for point. More... | |
virtual void | setField (const labelList &values) |
WIP. Store element-wise field. More... | |
virtual void | getField (const List< pointIndexHit > &, labelList &) const |
WIP. From a set of hits (points and. More... | |
bool | writeData (Ostream &) const |
The writeData function is required by regIOobject but not used. More... | |
virtual bool | writeObject (IOstreamOption streamOpt, const bool writeOnProc) const |
Write using stream options. More... | |
virtual bool | global () const |
Is object global. More... | |
virtual fileName | filePath () const |
Return complete path + object name if the file exists. More... | |
Public Member Functions inherited from searchableSurface | |
TypeName ("searchableSurface") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, searchableSurface, dict,(const IOobject &io, const dictionary &dict),(io, dict)) | |
searchableSurface (const IOobject &io) | |
virtual autoPtr< searchableSurface > | clone () const |
Clone. More... | |
virtual | ~searchableSurface ()=default |
Destructor. More... | |
virtual const boundBox & | bounds () const |
Return const reference to boundBox. More... | |
virtual boundBox & | bounds () |
Return non-const access to the boundBox to allow it to be set. More... | |
virtual label | globalSize () const |
Range of global indices that can be returned. More... | |
virtual void | findNearest (const pointField &sample, const scalarField &nearestDistSqr, List< pointIndexHit > &, vectorField &normal, labelList ®ion) const |
Find nearest, normal and region. Can be overridden with. More... | |
virtual void | distribute (const List< treeBoundBox > &, const bool keepNonLocal, autoPtr< mapDistribute > &faceMap, autoPtr< mapDistribute > &pointMap) |
Set bounds of surface. Bounds currently set as list of. More... | |
Public Member Functions inherited from regIOobject | |
void | operator= (const regIOobject &)=delete |
No copy assignment. More... | |
TypeName ("regIOobject") | |
Runtime type information. More... | |
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). More... | |
regIOobject (const regIOobject &rio) | |
Copy construct. More... | |
regIOobject (const regIOobject &rio, bool registerCopy) | |
Copy construct, transferring registry registration to the copy if registerCopy is true. More... | |
regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
Copy construct with new name, transferring registry registration to the copy if registerCopy is true. More... | |
regIOobject (const IOobject &io, const regIOobject &rio) | |
Copy construct with new IO parameters. More... | |
virtual | ~regIOobject () |
Destructor. More... | |
bool | checkIn () |
Add object to registry, if not already registered. More... | |
bool | checkOut () |
Remove object from registry, and remove all file watches. More... | |
virtual void | addWatch () |
Add file watch on object (if registered and READ_IF_MODIFIED) More... | |
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. More... | |
bool | ownedByRegistry () const noexcept |
Is this object owned by the registry? More... | |
bool | store () |
Register object with its registry and transfer ownership to the registry. More... | |
void | release (const bool unregister=false) noexcept |
Set object as not ownedByRegistry. More... | |
label | eventNo () const noexcept |
Event number at last update. More... | |
label & | eventNo () noexcept |
Event number at last update. More... | |
bool | upToDate (const regIOobject &) const |
Return true if up-to-date with respect to given object. More... | |
bool | upToDate (const regIOobject &, const regIOobject &) const |
Return true if up-to-date with respect to given objects. More... | |
bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const |
Return true if up-to-date with respect to given objects. More... | |
bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const |
Return true if up-to-date with respect to given objects. More... | |
void | setUpToDate () |
Set as up-to-date. More... | |
const dictionary * | findMetaData () const noexcept |
Return pointer to meta-data or nullptr. More... | |
dictionary & | getMetaData () noexcept |
Get or create meta-data. More... | |
void | removeMetaData () |
Remove meta-data. More... | |
virtual void | updateMetaData () |
Update internal meta-data (eg, prior to writing) More... | |
bool | headerOk () |
Read and check header info. Does not check the headerClassName. More... | |
Istream & | readStream (const word &, const bool readOnProc=true) |
Return Istream and check object type against that given. More... | |
void | close () |
Close Istream. More... | |
virtual bool | readData (Istream &) |
Virtual readData function. More... | |
virtual bool | read () |
Read object. More... | |
virtual label | addWatch (const fileName &) |
Add file watch for fileName on object if not yet watched. More... | |
const labelList & | watchIndices () const noexcept |
Read access to file-monitoring handles. More... | |
labelList & | watchIndices () noexcept |
Write access to file-monitoring handles. More... | |
virtual bool | write (const bool writeOnProc=true) const |
Write using setting from DB. More... | |
void | operator= (const IOobject &io) |
Copy assignment. More... | |
virtual bool | writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool writeOnProc) const |
Write using given format, version and compression. More... | |
Public Member Functions inherited from IOobject | |
TypeName ("IOobject") | |
Declare type-name, virtual type (with debug switch) More... | |
IOobject (const IOobject &)=default | |
Copy construct. More... | |
virtual | ~IOobject ()=default |
Destructor. More... | |
IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from name, instance, registry, io options. More... | |
IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from name, instance, local, registry, io options. More... | |
IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from path, registry, io options. More... | |
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. More... | |
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. More... | |
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. More... | |
IOobject (const IOobject &io, const objectRegistry ®istry) | |
Copy construct, resetting registry. More... | |
IOobject (const IOobject &io, const word &name) | |
Copy construct, resetting name. More... | |
IOobject (const IOobject &io, const word &name, const fileName &local) | |
Copy construct, resetting name and local component. More... | |
IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt) | |
Copy construct, resetting read/write options. More... | |
IOobject (const IOobject &io, IOobjectOption::registerOption regOpt) | |
Copy construct, resetting register option. More... | |
autoPtr< IOobject > | clone () const |
Clone. More... | |
autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
Clone resetting registry. More... | |
const objectRegistry & | db () const noexcept |
Return the local objectRegistry. More... | |
const Time & | time () const noexcept |
Return Time associated with the objectRegistry. More... | |
const word & | name () const noexcept |
Return the object name. More... | |
const word & | headerClassName () const noexcept |
Return name of the class name read from header. More... | |
word & | headerClassName () noexcept |
Return non-constant access to the class name read from header. More... | |
const string & | note () const noexcept |
Return the optional note. More... | |
string & | note () noexcept |
Modifiable access to the optional note. More... | |
unsigned | labelByteSize () const noexcept |
The sizeof (label) in bytes, possibly read from the header. More... | |
unsigned | scalarByteSize () const noexcept |
The sizeof (scalar) in bytes, possibly read from the header. More... | |
void | resetHeader (const word &newName=word::null) |
Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file. More... | |
bool | hasHeaderClass () const noexcept |
True if headerClassName() is non-empty (after reading) More... | |
template<class Type > | |
bool | isHeaderClass () const |
Check if headerClassName() equals Type::typeName. More... | |
template<class Type > | |
bool | isHeaderClassName () const |
Same as isHeaderClass() More... | |
word | group () const |
Return group (extension part of name) More... | |
word | member () const |
Return member (name without the extension) More... | |
const fileName & | rootPath () const noexcept |
Return the Time::rootPath() More... | |
const fileName & | caseName () const noexcept |
Return the Time::caseName() More... | |
const fileName & | globalCaseName () const noexcept |
Return the Time::globalCaseName() More... | |
const fileName & | instance () const noexcept |
Read access to instance path component. More... | |
fileName & | instance () noexcept |
Write access to instance path component. More... | |
const fileName & | local () const noexcept |
Read access to local path component. More... | |
fileName | path () const |
The complete path for the object (with instance, local,...). More... | |
fileName | globalPath () const |
The complete global path for the object (with instance, local,...) More... | |
fileName | path (const word &instance, const fileName &local=fileName::null) const |
The complete path with alternative instance and local. More... | |
fileName | globalPath (const word &instance, const fileName &local=fileName::null) const |
The complete global path with alternative instance and local. More... | |
fileName | objectPath () const |
The complete path + object name. More... | |
fileName | globalObjectPath () const |
The complete global path + object name. More... | |
fileName | objectRelPath () const |
The object path relative to the root. More... | |
fileName | localFilePath (const word &typeName, const bool search=true) const |
Redirect to fileHandler filePath, searching locally. More... | |
fileName | globalFilePath (const word &typeName, const bool search=true) const |
Redirect to fileHandler filePath, searching up if in parallel. More... | |
IOstreamOption | parseHeader (const dictionary &headerDict) |
Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics. More... | |
bool | readHeader (Istream &is) |
Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics. More... | |
bool | readHeader (dictionary &headerDict, Istream &is) |
Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics. More... | |
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. More... | |
template<class Type > | |
fileName | typeFilePath (const bool search=true) const |
Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait. More... | |
template<class Type > | |
void | warnNoRereading () const |
Helper: warn that type does not support re-reading. More... | |
bool | writeHeader (Ostream &os) const |
Write header with current type() More... | |
bool | writeHeader (Ostream &os, const word &objectType) const |
Write header with override of type. More... | |
void | writeHeader (dictionary &dict, IOstreamOption streamOpt) const |
Write header into a dictionary with current type() and given output format. More... | |
void | writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const |
Write header into a dictionary with override of type and given output format. More... | |
bool | good () const noexcept |
Did last readHeader() succeed? More... | |
bool | bad () const noexcept |
Did last readHeader() fail? More... | |
InfoProxy< IOobject > | info () const noexcept |
Return info proxy, for printing information to a stream. More... | |
void | operator= (const IOobject &io) |
Copy assignment, copies all values (except the registry) More... | |
template<> | |
bool | isHeaderClass () const |
Specialization for void always returns true (no headerClassName check). More... | |
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. More... | |
constexpr | IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
Construct NO_WRITE with specified read/register options. More... | |
constexpr | IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
Construct NO_READ with specified write/register options. More... | |
constexpr | IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept |
Construct (NO_READ, NO_WRITE) with specified register option. More... | |
constexpr | IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept |
Construct from components with specified register option as bool. More... | |
constexpr | IOobjectOption (bool registerObject, bool globalObject=false) noexcept |
Construct (NO_READ, NO_WRITE) with specified register option as bool. More... | |
readOption | readOpt () const noexcept |
Get the read option. More... | |
readOption | readOpt (readOption opt) noexcept |
Set the read option. More... | |
writeOption | writeOpt () const noexcept |
Get the write option. More... | |
writeOption | writeOpt (writeOption opt) noexcept |
Set the write option. More... | |
bool | registerObject () const noexcept |
Should objects created with this IOobject be registered? More... | |
bool | registerObject (bool on) noexcept |
Change registration preference. More... | |
bool | globalObject () const noexcept |
True if object is treated the same for all processors. More... | |
bool | globalObject (bool on) noexcept |
Change global-object status. More... | |
bool | isAnyRead () const noexcept |
True if any reading may be required (ie, != NO_READ) More... | |
bool | isReadRequired () const noexcept |
True if (MUST_READ | READ_MODIFIED) bits are set. More... | |
bool | isReadOptional () const noexcept |
True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More... | |
readOption & | readOpt () noexcept |
Access to the read option. More... | |
writeOption & | writeOpt () noexcept |
Access to the write option. More... | |
bool & | registerObject () noexcept |
Access to the register object option. More... | |
bool & | globalObject () noexcept |
Access to the global object option. More... | |
Public Member Functions inherited from objectRegistry | |
TypeName ("objectRegistry") | |
Declare type name for this IOobject. More... | |
objectRegistry (const Time &db, const label initialCapacity=128) | |
Construct the time objectRegistry, with estimated table capacity (default: 128) More... | |
objectRegistry (const IOobject &io, const label initialCapacity=128) | |
Construct sub-registry given an IObject to describe the registry, with estimated table capacity (default: 128) More... | |
virtual | ~objectRegistry () |
Destructor, with checkOut() for all objects that are ownedByRegistry. More... | |
const objectRegistry & | thisDb () const noexcept |
Return the object registry. More... | |
const objectRegistry & | parent () const noexcept |
Return the parent objectRegistry. More... | |
const Time & | time () const noexcept |
Return time registry. More... | |
bool | isTimeDb () const noexcept |
True if the registry is Time. More... | |
virtual const fileName & | dbDir () const |
Local directory path of this objectRegistry relative to the time. More... | |
IOobject | newIOobject (const word &name, IOobjectOption ioOpt) const |
Create an IOobject at the current time instance (timeName) with the specified options. More... | |
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). More... | |
HashTable< wordHashSet > | classes () const |
A summary hash of classes used and their associated object names. More... | |
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. More... | |
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) More... | |
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) More... | |
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. More... | |
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. More... | |
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) More... | |
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) More... | |
UPtrList< const regIOobject > | csorted () const |
Return sorted list of objects. More... | |
UPtrList< regIOobject > | sorted () |
Return sorted list of objects. More... | |
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. More... | |
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. More... | |
label | count (const char *clsName) const |
The number of objects of the given class name. More... | |
template<class MatchPredicate > | |
label | count (const MatchPredicate &matchClass) const |
The number of objects of the given class name. More... | |
template<class MatchPredicate1 , class MatchPredicate2 > | |
label | count (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
The number of objects of the given class name. More... | |
template<class Type > | |
label | count (const bool strict=false) const |
The names of objects with a class satisfying isA<Type> More... | |
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. More... | |
wordList | names () const |
The unsorted names of all objects. More... | |
wordList | names (const char *clsName) const |
The unsorted names of objects with the given class name. More... | |
template<class MatchPredicate > | |
wordList | names (const MatchPredicate &matchClass) const |
The unsorted names of objects with a matching class name. More... | |
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. More... | |
template<class Type > | |
wordList | names () const |
The unsorted names of objects with a class satisfying isA<Type> More... | |
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. More... | |
wordList | sortedNames () const |
The sorted names of all objects. More... | |
wordList | sortedNames (const char *clsName) const |
The sorted names of objects with the given class name. More... | |
template<class MatchPredicate > | |
wordList | sortedNames (const MatchPredicate &matchClass) const |
The sorted names objects with a matching class name. More... | |
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. More... | |
template<class Type > | |
wordList | sortedNames () const |
The sorted names of objects with a class satisfying isA<Type> More... | |
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. More... | |
const objectRegistry & | subRegistry (const word &name, const bool forceCreate=false, const bool recursive=false) const |
Lookup and return a const sub-objectRegistry. More... | |
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) More... | |
template<class Type , bool Strict = false> | |
HashTable< Type * > | lookupClass () |
Return all objects with a class satisfying isA<Type> or isType<Type> (with Strict) More... | |
template<class Type > | |
HashTable< const Type * > | lookupClass (const bool strict) const |
Return all objects with a class satisfying isA<Type> More... | |
template<class Type > | |
HashTable< Type * > | lookupClass (const bool strict) |
Return all objects with a class satisfying isA<Type> More... | |
const regIOobject * | cfindIOobject (const word &name, const bool recursive=false) const |
Return const pointer to the regIOobject. More... | |
bool | contains (const word &name, const bool recursive=false) const |
Does the registry contain the regIOobject object (by name). More... | |
template<class Type > | |
bool | foundObject (const word &name, const bool recursive=false) const |
Is the named Type found? More... | |
template<class Type > | |
const Type * | cfindObject (const word &name, const bool recursive=false) const |
Return const pointer to the object of the given Type. More... | |
template<class Type > | |
const Type * | findObject (const word &name, const bool recursive=false) const |
Return const pointer to the object of the given Type. More... | |
template<class Type > | |
Type * | findObject (const word &name, const bool recursive=false) |
Return non-const pointer to the object of the given Type. More... | |
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. More... | |
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. More... | |
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. More... | |
label | getEvent () const |
Return new event number. More... | |
bool | checkIn (regIOobject *io) const |
Add a regIOobject to registry. A nullptr is ignored. More... | |
bool | checkIn (regIOobject &io) const |
Add a regIOobject to registry. More... | |
bool | checkOut (regIOobject *io) const |
Remove a regIOobject from registry and free memory if the object is ownedByRegistry. A nullptr is ignored. More... | |
bool | checkOut (regIOobject &io) const |
Remove a regIOobject from registry and free memory if the object is ownedByRegistry. More... | |
bool | checkOut (const word &key) const |
Remove a regIOobject by name from registry and free memory if the object is ownedByRegistry. More... | |
void | clear () |
Clear all entries from the registry. More... | |
void | clearStorage () |
Clear all entries from the registry and the table itself. More... | |
bool | erase (const iterator &iter) |
Erase an entry specified by the given iterator. More... | |
bool | erase (const word &key) |
Erase an entry specified by the given key. More... | |
label | erase (std::initializer_list< word > keys) |
Remove entries given by the listed keys. More... | |
label | erase (const UList< word > &keys) |
Remove entries given by the listed keys. More... | |
virtual void | rename (const word &newName) |
Rename. More... | |
bool | is_cacheTemporaryObject (const word &name) const |
True if given name is in the cacheTemporaryObjects set. More... | |
bool | is_cacheTemporaryObject (const regIOobject *io) const |
True if name of object is in the cacheTemporaryObjects set. More... | |
bool | is_cacheTemporaryObject (const regIOobject &io) const |
True if name of object is in the cacheTemporaryObjects set. More... | |
template<class Type > | |
bool | cacheTemporaryObject (Type &obj) const |
Cache the given object. Moves content and stores. More... | |
void | resetCacheTemporaryObject (const regIOobject *io) const |
Reset the cache state of the given object (nullptr is ignored) More... | |
void | resetCacheTemporaryObject (const regIOobject &io) const |
Reset the cache state of the given object in the cacheTemporaryObjects set. More... | |
bool | checkCacheTemporaryObjects () const |
Check that all objects specified in the cacheTemporaryObjects were also cached. More... | |
virtual bool | modified () const |
Return true if any of the object's files have been modified. More... | |
void | readModifiedObjects () |
Read the objects that have been modified. More... | |
virtual bool | readIfModified () |
Read object if modified. More... | |
bool | found (const word &name, bool recursive=false) const |
Same as contains() More... | |
template<class Type > | |
const Type * | lookupObjectPtr (const word &name, bool recursive=false) const |
Deprecated(2018-10) find object. More... | |
template<class Type > | |
Type * | lookupObjectRefPtr (const word &name, bool recursive=false) const |
Deprecated(2018-10) get object pointer, ignoring constness. More... | |
template<class Type > | |
UPtrList< const Type > | sorted () const |
Deprecated(2023-07) use csorted() method. More... | |
UPtrList< const regIOobject > | sorted () const |
Deprecated(2023-07) use csorted() method. More... | |
template<class Type , class MatchPredicate > | |
UPtrList< const Type > | sorted (const MatchPredicate &matchName) const |
Deprecated(2023-07) use csorted() method. More... | |
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 HashTable< regIOobject *> | |
HashTable () noexcept | |
Default construct: empty without allocation (capacity=0) More... | |
HashTable (const Foam::zero) noexcept | |
Construct empty without allocation (capacity=0) More... | |
HashTable (const label initialCapacity) | |
Construct empty with initial table capacity. More... | |
HashTable (Istream &is) | |
Construct from Istream. More... | |
HashTable (const this_type &ht) | |
Copy construct. More... | |
HashTable (this_type &&rhs) noexcept | |
Move construct. More... | |
HashTable (std::initializer_list< std::pair< word, regIOobject * >> list, const bool overwrite=false) | |
Construct from key/value pairs in initializer list. More... | |
HashTable (const UList< word > &keys, const UList< regIOobject * > &values, const bool overwrite=false) | |
Construct from key/value pairs. More... | |
~HashTable () | |
Destructor. More... | |
bool | empty () const noexcept |
True if the hash table is empty. More... | |
label | size () const noexcept |
The number of elements in table. More... | |
label | capacity () const noexcept |
The size of the underlying table (the number of buckets) More... | |
regIOobject * & | at (const word &key) |
Find and return a hashed entry. FatalError if it does not exist. More... | |
const regIOobject * & | at (const word &key) const |
Find and return a hashed entry. FatalError if it does not exist. More... | |
bool | contains (const word &key) const |
True if hashed key is contained (found) in table. More... | |
iterator | find (const word &key) |
Find and return an iterator set at the hashed entry. More... | |
const_iterator | find (const word &key) const |
Find and return an const_iterator set at the hashed entry. More... | |
const_iterator | cfind (const word &key) const |
Find and return an const_iterator set at the hashed entry. More... | |
const regIOobject * & | lookup (const word &key, const regIOobject * &deflt) const |
Return hashed entry if it exists, or return the given default. More... | |
List< word > | toc () const |
The table of contents (the keys) in unsorted order. More... | |
List< word > | sortedToc () const |
The table of contents (the keys) in sorted order. More... | |
List< word > | sortedToc (const Compare &comp) const |
The table of contents (the keys) sorted according to the specified comparator. More... | |
Foam::List< word > | sortedToc (const Compare &comp) const |
List< word > | tocKeys (const UnaryPredicate &pred, const bool invert=false) const |
The table of contents (the keys) selected according to the unary predicate applied to the keys. More... | |
Foam::List< word > | tocKeys (const UnaryPredicate &pred, const bool invert) const |
List< word > | tocValues (const UnaryPredicate &pred, const bool invert=false) const |
The table of contents (the keys) selected according to the unary predicate applied to the values. More... | |
Foam::List< word > | tocValues (const UnaryPredicate &pred, const bool invert) const |
List< word > | tocEntries (const BinaryPredicate &pred, const bool invert=false) const |
The table of contents (the keys) selected according to the binary predicate applied to the keys and values. More... | |
Foam::List< word > | tocEntries (const BinaryPredicate &pred, const bool invert) const |
UPtrList< const node_type > | csorted () const |
Const access to the hash-table contents in sorted order (sorted by keys). More... | |
UPtrList< node_type > | sorted () |
Non-const access to the hash-table contents in sorted order (sorted by keys). More... | |
UPtrList< const node_type > | sorted () const |
Deprecated(2023-07) use csorted() method. More... | |
label | countKeys (const UnaryPredicate &pred, const bool invert=false) const |
Count the number of keys that satisfy the unary predicate. More... | |
Foam::label | countKeys (const UnaryPredicate &pred, const bool invert) const |
label | countValues (const UnaryPredicate &pred, const bool invert=false) const |
Count the number of values that satisfy the unary predicate. More... | |
Foam::label | countValues (const UnaryPredicate &pred, const bool invert) const |
label | countEntries (const BinaryPredicate &pred, const bool invert=false) const |
Count the number of entries that satisfy the binary predicate. More... | |
Foam::label | countEntries (const BinaryPredicate &pred, const bool invert) const |
bool | emplace (const word &key, Args &&... args) |
Emplace insert a new entry, not overwriting existing entries. More... | |
bool | emplace_set (const word &key, Args &&... args) |
Emplace set an entry, overwriting any existing entries. More... | |
bool | insert (const word &key, const regIOobject * &obj) |
Copy insert a new entry, not overwriting existing entries. More... | |
bool | insert (const word &key, regIOobject * &&obj) |
Move insert a new entry, not overwriting existing entries. More... | |
bool | set (const word &key, const regIOobject * &obj) |
Copy assign a new entry, overwriting existing entries. More... | |
bool | set (const word &key, regIOobject * &&obj) |
Move assign a new entry, overwriting existing entries. More... | |
bool | erase (const iterator &iter) |
Erase an entry specified by given iterator. More... | |
bool | erase (const word &key) |
Erase an entry specified by the given key. More... | |
label | erase (const HashTable< AnyType, word, AnyHash > &other) |
Remove table entries given by keys of the other hash-table. More... | |
label | erase (std::initializer_list< word > keys) |
Remove table entries given by the listed keys. More... | |
label | erase (InputIter first, InputIter last) |
Remove multiple entries using an iterator range of keys. More... | |
label | erase (const FixedList< word, N > &keys) |
Remove table entries given by the listed keys. More... | |
label | erase (const UList< word > &keys) |
Remove table entries given by the listed keys. More... | |
Foam::label | erase (InputIter first, InputIter last) |
Foam::label | erase (const FixedList< word, N > &keys) |
Foam::label | erase (const HashTable< AnyType, word, AnyHash > &other) |
label | retain (const HashTable< AnyType, word, AnyHash > &other) |
Retain table entries given by keys of the other hash-table. More... | |
Foam::label | retain (const HashTable< AnyType, word, AnyHash > &other) |
label | filterKeys (const UnaryPredicate &pred, const bool pruning=false) |
Generalized means to filter table entries based on their keys. More... | |
Foam::label | filterKeys (const UnaryPredicate &pred, const bool pruning) |
label | filterValues (const UnaryPredicate &pred, const bool pruning=false) |
Generalized means to filter table entries based on their values. More... | |
Foam::label | filterValues (const UnaryPredicate &pred, const bool pruning) |
label | filterEntries (const BinaryPredicate &pred, const bool pruning=false) |
Generalized means to filter table entries based on their key/value. More... | |
Foam::label | filterEntries (const BinaryPredicate &pred, const bool pruning) |
void | clear () |
Remove all entries from table. More... | |
void | clearStorage () |
Remove all entries from table and the table itself. More... | |
void | setCapacity (label newCapacity) |
Change the hash table capacity (number of buckets). More... | |
void | resize (label newCapacity) |
Rehash the hash table with new number of buckets. Currently identical to setCapacity() More... | |
void | reserve (label numEntries) |
Reserve space for at least the specified number of elements (not the number of buckets) and regenerates the hash table. More... | |
void | swap (HashTable< regIOobject *, word, Foam::Hash< word > > &rhs) noexcept |
Swap contents into this table. More... | |
void | transfer (HashTable< regIOobject *, word, Foam::Hash< word > > &rhs) |
Transfer contents into this table. More... | |
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. More... | |
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. More... | |
regIOobject * & | operator[] (const word &key) |
Find and return a hashed entry. FatalError if it does not exist. More... | |
const regIOobject * & | operator[] (const word &key) const |
Find and return a hashed entry. FatalError if it does not exist. More... | |
regIOobject * & | operator() (const word &key) |
Return existing entry or create a new entry. More... | |
regIOobject * & | operator() (const word &key, const regIOobject * &deflt) |
Return existing entry or insert a new entry. More... | |
void | operator= (const this_type &rhs) |
Copy assign. More... | |
void | operator= (std::initializer_list< std::pair< word, regIOobject * >> rhs) |
Copy assign from an initializer list. More... | |
void | operator= (this_type &&rhs) |
Move assign. More... | |
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. More... | |
bool | operator!= (const this_type &rhs) const |
The opposite of the equality operation. More... | |
this_type & | operator+= (const this_type &rhs) |
Add entries into this HashTable. More... | |
const_iterator_pair< const_key_iterator, this_type > | keys () const |
A const iterator begin/end pair for iterating over keys. More... | |
iterator | begin () |
iterator set to the beginning of the HashTable More... | |
const_iterator | begin () const |
const_iterator set to the beginning of the HashTable More... | |
const_iterator | cbegin () const |
const_iterator set to the beginning of the HashTable More... | |
iterator | end () noexcept |
iterator to signal the end (for any HashTable) More... | |
const_iterator | end () const noexcept |
const_iterator to signal the end (for any HashTable) More... | |
constexpr const_iterator | cend () const noexcept |
const_iterator to signal the end (for any HashTable) More... | |
Ostream & | printInfo (Ostream &os) const |
Print information. More... | |
Ostream & | writeKeys (Ostream &os, const label shortLen=0) const |
Write unordered keys (list), with line-breaks when length exceeds shortLen. More... | |
bool | found (const word &key) const |
Same as contains() More... | |
Public Member Functions inherited from HashTableCore | |
ClassName ("HashTable") | |
Declare type-name (with debug switch) More... | |
HashTableCore () noexcept=default | |
Default construct. More... | |
Public Member Functions inherited from triSurface | |
ClassName ("triSurface") | |
Runtime type information. More... | |
triSurface () | |
Default construct. More... | |
triSurface (const triSurface &surf) | |
Copy construct. More... | |
triSurface (triSurface &&surf) | |
Move construct. More... | |
triSurface (const List< labelledTri > &triangles, const geometricSurfacePatchList &patches, const pointField &pts) | |
Construct from triangles, patches, points. More... | |
triSurface (List< labelledTri > &triangles, const geometricSurfacePatchList &patches, pointField &pts, const bool reuse) | |
Construct from triangles, patches, points. Reuse storage. More... | |
triSurface (const List< labelledTri > &triangles, const pointField &pts) | |
Construct from triangles, points. Set patch names to default. More... | |
triSurface (const triFaceList &triangles, const pointField &pts) | |
Construct from triangles, points. Set region to 0 and default patchName. More... | |
triSurface (const fileName &name, const scalar scaleFactor=-1) | |
Construct from file name (uses extension to determine type). More... | |
triSurface (const fileName &name, const word &fileType, const scalar scaleFactor=-1) | |
Construct from file name with given format type. More... | |
triSurface (Istream &is) | |
Construct from Istream. More... | |
triSurface (const Time &d) | |
Construct from objectRegistry by reading an ".ftr" file. More... | |
triSurface (const IOobject &io, const dictionary &dict, const bool isGlobal=true) | |
Read construct using IO to find the file location. More... | |
virtual | ~triSurface () |
Destructor. More... | |
void | clearOut () |
void | clearTopology () |
void | clearPatchMeshAddr () |
void | swap (triSurface &surf) |
const geometricSurfacePatchList & | patches () const noexcept |
geometricSurfacePatchList & | patches () noexcept |
const List< labelledTri > & | surfFaces () const noexcept |
Return const access to the faces. More... | |
const labelListList & | sortedEdgeFaces () const |
Return edge-face addressing sorted (for edges with more than. More... | |
const labelList & | edgeOwner () const |
If 2 face neighbours: label of face where ordering of edge. More... | |
const vectorField & | Sf () const |
Face area vectors (normals) More... | |
const scalarField & | magSf () const |
Face area magnitudes. More... | |
const vectorField & | Cf () const |
Face centres. More... | |
List< surfZone > | sortedZones (labelList &faceMap) const |
Sort faces according to zoneIds. More... | |
void | triFaceFaces (List< face > &plainFaceList) const |
Create a list of faces from the triFaces. More... | |
virtual void | swapPoints (pointField &pts) |
Swap points. Similar to movePoints, but returns the old points. More... | |
virtual void | scalePoints (const scalar scaleFactor) |
Scale points. A non-positive factor is ignored. More... | |
void | checkTriangles (const bool verbose) |
Check/remove duplicate/degenerate triangles. More... | |
void | checkEdges (const bool verbose) |
Check triply (or more) connected edges. More... | |
void | cleanup (const bool verbose) |
Remove non-valid triangles. More... | |
void | compactPoints (labelList &pointMap=const_cast< labelList &>(labelList::null())) |
Remove unused points and renumber faces in local visit order. More... | |
void | markZone (const boolList &borderEdge, const label facei, const label currentZone, labelList &faceZone) const |
Fill faceZone with currentZone for every face reachable. More... | |
label | markZones (const boolList &borderEdge, labelList &faceZone) const |
(size and) fills faceZone with zone of face. Zone is area More... | |
template<class BoolListType > | |
void | subsetMeshMap (const BoolListType &include, labelList &pointMap, labelList &faceMap) const |
Create mappings for a sub-surface. More... | |
triSurface | subsetMesh (const UList< bool > &include, labelList &pointMap, labelList &faceMap) const |
Return a new surface subsetted on the selected faces. More... | |
triSurface | subsetMesh (const bitSet &include, labelList &pointMap, labelList &faceMap) const |
Return a new surface subsetted on the selected faces. More... | |
triSurface | subsetMesh (const UList< bool > &include) const |
Return a new surface subsetted on the selected faces. More... | |
triSurface | subsetMesh (const bitSet &include) const |
Return a new surface subsetted on the selected faces. More... | |
triSurface | subsetMesh (const wordRes &includeNames, const wordRes &excludeNames=wordRes()) const |
Return a new surface subsetted on the selected patch names. More... | |
void | swapFaces (List< labelledTri > &faceLst) |
Swap the list of faces being addressed. More... | |
void | transfer (triSurface &surf) |
Alter contents by transferring (triangles, points) components. More... | |
void | transfer (MeshedSurface< labelledTri > &surf) |
Alter contents by transferring (triangles, points) components. More... | |
void | write (Ostream &os) const |
Write to Ostream in simple OpenFOAM format. More... | |
void | write (const fileName &, const bool sortByRegion=false) const |
Generic write routine (uses extension to determine type). More... | |
void | write (const fileName &filename, const word &fileType, const bool sortByRegion=false) const |
Generic write routine for given format type. More... | |
void | write (const Time &d) const |
Write to database. More... | |
void | writeStats (Ostream &os) const |
Write some statistics. More... | |
void | operator= (const triSurface &surf) |
Copy assignment. More... | |
void | operator= (triSurface &&surf) |
Move assignment. More... | |
void | operator= (MeshedSurface< labelledTri > &&surf) |
Move assignment. More... | |
Public Member Functions inherited from PrimitivePatch<::Foam::List< labelledTri >, pointField > | |
PrimitivePatch (const ::Foam::List< labelledTri > &faces, const pointField &points) | |
Construct from components. More... | |
PrimitivePatch (::Foam::List< labelledTri > &&faces, const pointField &points) | |
Construct from components, transferring faces. More... | |
PrimitivePatch (::Foam::List< labelledTri > &faces, pointField &points, const bool reuse) | |
Construct from components, reuse storage. More... | |
PrimitivePatch (const PrimitivePatch< ::Foam::List< labelledTri >, pointField > &pp) | |
Copy construct. More... | |
virtual | ~PrimitivePatch () |
Destructor. More... | |
void | clearOut () |
void | clearGeom () |
void | clearTopology () |
void | clearPatchMeshAddr () |
void | swap (PrimitivePatch &)=delete |
Suppress direct swapping, since storage containers may be const. More... | |
const Field< point_type > & | points () const noexcept |
Return reference to global points. More... | |
label | nFaces () const noexcept |
Number of faces in the patch. More... | |
label | nPoints () const |
Number of points supporting patch faces. More... | |
label | nEdges () const |
Number of edges in patch. More... | |
const edgeList & | edges () const |
Return list of edges, address into LOCAL point list. More... | |
const edgeList::subList | internalEdges () const |
Return sub-list of internal edges, address into LOCAL point list. More... | |
const edgeList::subList | boundaryEdges () const |
Return sub-list of boundary edges, address into LOCAL point list. More... | |
label | nInternalEdges () const |
Number of internal edges. More... | |
label | nBoundaryEdges () const |
Number of boundary edges == (nEdges() - nInternalEdges()) More... | |
bool | isInternalEdge (const label edgei) const |
Is internal edge? More... | |
const labelList & | boundaryPoints () const |
Return list of boundary points, address into LOCAL point list. More... | |
const labelListList & | faceFaces () const |
Return face-face addressing. More... | |
const labelListList & | edgeFaces () const |
Return edge-face addressing. More... | |
const labelListList & | faceEdges () const |
Return face-edge addressing. More... | |
const labelListList & | pointEdges () const |
Return point-edge addressing. More... | |
const labelListList & | pointFaces () const |
Return point-face addressing. More... | |
const List< face_type > & | localFaces () const |
Return patch faces addressing into local point list. More... | |
labelList | boundaryFaces () const |
Extract list of local faces corresponding to the boundary edges. More... | |
labelList | uniqBoundaryFaces () const |
Extract sorted list of unique local faces associated with the boundary edges. More... | |
const labelList & | meshPoints () const |
Return labelList of mesh points in patch. More... | |
const Map< label > & | meshPointMap () const |
Mesh point map. More... | |
const Field< point_type > & | localPoints () const |
Return pointField of points in patch. More... | |
const labelList & | localPointOrder () const |
Return orders the local points for most efficient search. More... | |
label | whichPoint (const label gp) const |
Given a global point index, return the local point index. More... | |
edge | meshEdge (const label edgei) const |
From patch edge to global edge using meshPoints. More... | |
edge | meshEdge (const edge &e) const |
From patch edge to global edge using meshPoints. More... | |
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. More... | |
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. More... | |
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. More... | |
labelList | meshEdges (const edgeList &allEdges, const labelListList &pointEdges) const |
Return labels of patch edges into the global edge list using basic edge addressing. More... | |
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. More... | |
const Field< point_type > & | faceCentres () const |
Return face centres for patch. More... | |
const Field< point_type > & | faceAreas () const |
Return face area vectors for patch. More... | |
const Field< scalar > & | magFaceAreas () const |
Return face area magnitudes for patch. More... | |
const Field< point_type > & | faceNormals () const |
Return face unit normals for patch. More... | |
const Field< point_type > & | pointNormals () const |
Return point normals for patch. More... | |
Pair< point_type > | box () const |
The enclosing (bounding) box for the patch points. More... | |
scalar | sphere (const label facei) const |
The enclosing (bounding) sphere radius^2 for specified face. More... | |
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. More... | |
Foam::List< Foam::objectHit > | projectPoints (const ToPatch &targetPatch, const Field< typename Foam::PrimitivePatch< ::Foam::List< labelledTri >, pointField >::point_type > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const |
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. More... | |
Foam::List< Foam::objectHit > | projectFaceCentres (const ToPatch &targetPatch, const Field< typename Foam::PrimitivePatch< ::Foam::List< labelledTri >, pointField >::point_type > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const |
const labelListList & | edgeLoops () const |
Return list of closed loops of boundary vertices. More... | |
surfaceTopo | surfaceType (labelHashSet *badEdgesPtr=nullptr) const |
Calculate surface type formed by patch, optionally recording the indices of illegal edges. More... | |
bool | checkTopology (const bool report=false, labelHashSet *pointSetPtr=nullptr) const |
Check surface formed by patch for manifoldness (see above). More... | |
bool | checkPointManifold (const bool report=false, labelHashSet *pointSetPtr=nullptr) const |
Checks primitivePatch for faces sharing point but not edge. More... | |
virtual void | movePoints (const Field< point_type > &) |
Correct patch after moving points. More... | |
void | operator= (const PrimitivePatch< ::Foam::List< labelledTri >, pointField > &rhs) |
Copy assign faces. Leave points alone (could be a reference). More... | |
void | operator= (PrimitivePatch< ::Foam::List< labelledTri >, pointField > &&rhs) |
Move assign faces. Leave points alone (could be a reference). More... | |
label | whichEdge (const edge &e) const |
Identical to findEdge. More... | |
Public Member Functions inherited from PrimitivePatchBase | |
ClassName ("PrimitivePatch") | |
Runtime type information. More... | |
PrimitivePatchBase ()=default | |
Default construct. More... | |
Public Member Functions inherited from List< labelledTri > | |
constexpr | List () noexcept |
Default construct. More... | |
List (const label len) | |
Construct with given size. More... | |
List (const label len, const labelledTri &val) | |
Construct with given size and value for all elements. More... | |
List (const label len, const Foam::zero) | |
Construct with given size initializing all elements to zero. More... | |
List (const Foam::one, const labelledTri &val) | |
Construct with length=1, copying the value as the only content. More... | |
List (const Foam::one, labelledTri &&val) | |
Construct with length=1, moving the value as the only content. More... | |
List (const Foam::one, const Foam::zero) | |
Construct with length=1, initializing content to zero. More... | |
List (const List< labelledTri > &list) | |
Copy construct from list. More... | |
List (const UList< labelledTri > &list) | |
Copy construct contents from list. More... | |
List (List< labelledTri > &list, bool reuse) | |
Construct as copy or re-use as specified. More... | |
List (const UList< labelledTri > &list, const labelUList &indices) | |
Copy construct subset of list. More... | |
List (const UList< labelledTri > &list, const FixedList< label, N > &indices) | |
Copy construct subset of list. More... | |
List (const FixedList< labelledTri, N > &list) | |
Construct as copy of FixedList<T, N> More... | |
List (const PtrList< labelledTri > &list) | |
Construct as copy of PtrList<T> More... | |
List (const IndirectListBase< labelledTri, Addr > &list) | |
Construct as copy of IndirectList contents. More... | |
List (std::initializer_list< labelledTri > list) | |
Construct from an initializer list. More... | |
List (List< labelledTri > &&list) noexcept | |
Move construct from List. More... | |
List (DynamicList< labelledTri, SizeMin > &&list) | |
Move construct from DynamicList. More... | |
List (Istream &is) | |
Construct from Istream. More... | |
List (const SLList< labelledTri > &list) | |
Copy construct from SLList. More... | |
autoPtr< List< labelledTri > > | clone () const |
Clone. More... | |
~List () | |
Destructor. More... | |
void | clear () |
Clear the list, i.e. set size to zero. More... | |
void | resize (const label len) |
Adjust allocated size of list. More... | |
void | resize (const label len, const labelledTri &val) |
Adjust allocated size of list and set val for new elements. More... | |
void | resize (const label newLen) |
void | resize_fill (const label len, const labelledTri &val) |
Adjust allocated size of list and set val for all elements. More... | |
void | resize_nocopy (const label len) |
Adjust allocated size of list without necessarily. More... | |
void | resize_unsafe (const label len) noexcept |
Change the addressed list size directly without affecting any memory management (advanced usage). More... | |
void | setSize (const label n) |
Alias for resize() More... | |
void | setSize (const label n, const labelledTri &val) |
Alias for resize() More... | |
void | transfer (List< labelledTri > &list) |
Transfer the contents of the argument List into this list and annul the argument list. More... | |
void | transfer (DynamicList< labelledTri, SizeMin > &list) |
Transfer the contents of the argument List into this list and annul the argument list. More... | |
labelledTri & | newElmt (const label i) |
Return subscript-checked element of UList and resizing the list if required. More... | |
labelledTri & | emplace_back (Args &&... args) |
Construct an element at the end of the list, return reference to the new list element. More... | |
void | push_back (const labelledTri &val) |
Append an element at the end of the list. More... | |
void | push_back (labelledTri &&val) |
Move append an element at the end of the list. More... | |
void | push_back (const UList< labelledTri > &list) |
Append a List to the end of this list. More... | |
void | push_back (const IndirectListBase< labelledTri, Addr > &list) |
Append IndirectList contents at the end of this list. More... | |
label | push_uniq (const labelledTri &val) |
Append an element if not already in the list. More... | |
void | pop_back (label n=1) |
Reduce size by 1 or more elements. Can be called on an empty list. More... | |
void | operator= (const UList< labelledTri > &list) |
Assignment to UList operator. Takes linear time. More... | |
void | operator= (const List< labelledTri > &list) |
Assignment operator. Takes linear time. More... | |
void | operator= (const IndirectListBase< labelledTri, Addr > &list) |
Assignment from IndirectList. Takes linear time. More... | |
void | operator= (const FixedList< labelledTri, N > &list) |
Copy assignment from FixedList. More... | |
void | operator= (std::initializer_list< labelledTri > list) |
Assignment to an initializer list. More... | |
void | operator= (const labelledTri &val) |
Assignment of all entries to the given value. More... | |
void | operator= (const Foam::zero) |
Assignment of all entries to zero. More... | |
void | operator= (List< labelledTri > &&list) |
Move assignment. Takes constant time. More... | |
void | operator= (DynamicList< labelledTri, SizeMin > &&list) |
Move assignment. Takes constant time. More... | |
void | operator= (const SLList< labelledTri > &list) |
Copy assign from SLList in linear time. More... | |
Istream & | readList (Istream &is) |
Read List from Istream, discarding contents of existing List. More... | |
void | shallowCopy (const UList< labelledTri > &)=delete |
No shallowCopy permitted. More... | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | set (const label i, bool val=true) |
A bitSet::set() method for a list of bool. More... | |
void | append (const labelledTri &val) |
Append an element at the end of the list. More... | |
void | append (labelledTri &&val) |
Move append an element at the end of the list. More... | |
void | append (const UList< labelledTri > &list) |
Append a List to the end of this list. More... | |
void | append (const IndirectListBase< labelledTri, Addr > &list) |
Append IndirectList contents at the end of this list. More... | |
label | appendUniq (const labelledTri &val) |
Same as push_uniq() More... | |
Public Member Functions inherited from UList< T > | |
UList (const UList< T > &)=default | |
Copy construct. More... | |
constexpr | UList () noexcept |
Default construct, zero-sized and nullptr. More... | |
UList (T *__restrict__ v, const label len) noexcept | |
Construct from components. More... | |
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. More... | |
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. More... | |
const T & | fcValue (const label i) const |
Return forward circular value (ie, next value in the list) More... | |
T & | fcValue (const label i) |
Return forward circular value (ie, next value in the list) More... | |
const T & | rcValue (const label i) const |
Return reverse circular value (ie, previous value in the list) More... | |
T & | rcValue (const label i) |
Return reverse circular value (ie, previous value in the list) More... | |
const T * | cdata () const noexcept |
Return pointer to the underlying array serving as data storage. More... | |
T * | data () noexcept |
Return pointer to the underlying array serving as data storage. More... | |
const char * | cdata_bytes () const noexcept |
Return pointer to the underlying array serving as data storage,. More... | |
char * | data_bytes () noexcept |
Return pointer to the underlying array serving as data storage,. More... | |
T & | front () |
Access first element of the list, position [0]. More... | |
const T & | front () const |
Access first element of the list. More... | |
T & | back () |
Access last element of the list, position [size()-1]. More... | |
const T & | back () const |
Access last element of the list, position [size()-1]. More... | |
std::streamsize | size_bytes () const noexcept |
Number of contiguous bytes for the List data. More... | |
std::streamsize | byteSize () const |
Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous. More... | |
void | checkStart (const label start) const |
Check start is within valid range [0,size) More... | |
void | checkSize (const label size) const |
Check size is within valid range [0,size]. More... | |
void | checkRange (const label start, const label len) const |
Check that start and length define a valid range. More... | |
void | checkIndex (const label i) const |
Check index is within valid range [0,size) More... | |
bool | uniform () const |
True if all entries have identical values, and list is non-empty. More... | |
bool | contains (const T &val) const |
True if the value is contained in the list. More... | |
bool | contains (const T &val, label pos, label len=-1) const |
Is the value contained in the list? More... | |
label | find (const T &val) const |
Find index of the first occurrence of the value. More... | |
label | find (const T &val, label pos, label len=-1) const |
Find index of the first occurrence of the value. More... | |
label | rfind (const T &val, label pos=-1) const |
Find index of the last occurrence of the value. More... | |
void | moveFirst (const label i) |
Move element to the first position. More... | |
void | moveLast (const label i) |
Move element to the last position. More... | |
void | swapFirst (const label i) |
Swap element with the first element. Fatal on an empty list. More... | |
void | swapLast (const label i) |
Swap element with the last element. Fatal on an empty list. More... | |
void | shallowCopy (T *__restrict__ ptr, const label len) noexcept |
Copy the pointer and size. More... | |
void | shallowCopy (std::nullptr_t) noexcept |
Copy nullptr and zero size. More... | |
void | shallowCopy (const UList< T > &list) noexcept |
Copy the pointer and size held by the given UList. More... | |
void | deepCopy (const UList< T > &list) |
Copy elements of the given UList. Sizes must match! More... | |
template<class Addr > | |
void | deepCopy (const IndirectListBase< T, Addr > &list) |
Copy elements of the given indirect list. Sizes must match! More... | |
SubList< T > | slice (const label pos, label len=-1) |
Return SubList slice (non-const access) - no range checking. More... | |
const SubList< T > | slice (const label pos, label len=-1) const |
Return SubList slice (const access) - no range checking. More... | |
SubList< T > | slice (const labelRange &range) |
Return SubList slice (non-const access) - with range checking. More... | |
const SubList< T > | slice (const labelRange &range) const |
Return SubList slice (const access) - with range checking. More... | |
T & | operator[] (const label i) |
Return element of UList. More... | |
const T & | operator[] (const label i) const |
Return element of constant UList. More... | |
operator const Foam::List< T > & () const | |
Allow cast to a const List<T>&. More... | |
void | operator= (const T &val) |
Assignment of all entries to the given value. More... | |
void | operator= (const Foam::zero) |
Assignment of all entries to zero. More... | |
iterator | begin () noexcept |
Return an iterator to begin traversing the UList. More... | |
iterator | end () noexcept |
Return an iterator to end traversing the UList. More... | |
iterator | begin (const label i) noexcept |
Return iterator at offset i from begin, clamped to [0,size] range. More... | |
const_iterator | cbegin () const noexcept |
Return const_iterator to begin traversing the constant UList. More... | |
const_iterator | cend () const noexcept |
Return const_iterator to end traversing the constant UList. More... | |
const_iterator | begin () const noexcept |
Return const_iterator to begin traversing the constant UList. More... | |
const_iterator | end () const noexcept |
Return const_iterator to end traversing the constant UList. More... | |
const_iterator | cbegin (const label i) const noexcept |
Return const_iterator at offset i from begin, clamped to [0,size] range. More... | |
const_iterator | begin (const label i) const noexcept |
Return const_iterator at offset i from begin, clamped to [0,size] range. More... | |
reverse_iterator | rbegin () |
Return reverse_iterator to begin reverse traversing the UList. More... | |
reverse_iterator | rend () |
Return reverse_iterator to end reverse traversing the UList. More... | |
const_reverse_iterator | crbegin () const |
Return const_reverse_iterator to begin reverse traversing the UList. More... | |
const_reverse_iterator | crend () const |
Return const_reverse_iterator to end reverse traversing the UList. More... | |
const_reverse_iterator | rbegin () const |
Return const_reverse_iterator to begin reverse traversing the UList. More... | |
const_reverse_iterator | rend () const |
Return const_reverse_iterator to end reverse traversing the UList. More... | |
bool | empty () const noexcept |
True if List is empty (ie, size() is zero) More... | |
label | size () const noexcept |
The number of elements in the container. More... | |
label | capacity () const noexcept |
Size of the underlying storage. More... | |
void | swap (UList< T > &list) noexcept |
Swap content with another UList of the same type in constant time. More... | |
bool | operator== (const UList< T > &list) const |
Equality operation on ULists of the same type. More... | |
bool | operator!= (const UList< T > &list) const |
The opposite of the equality operation. Takes linear time. More... | |
bool | operator< (const UList< T > &list) const |
Compare two ULists lexicographically. Takes linear time. More... | |
bool | operator> (const UList< T > &list) const |
Compare two ULists lexicographically. Takes linear time. More... | |
bool | operator<= (const UList< T > &list) const |
Return true if !(a > b). Takes linear time. More... | |
bool | operator>= (const UList< T > &list) const |
Return true if !(a < b). Takes linear time. More... | |
Istream & | readList (Istream &is) |
Read List contents from Istream. More... | |
void | writeEntry (const word &keyword, Ostream &os) const |
Write the List as a dictionary entry with keyword. More... | |
Ostream & | writeList (Ostream &os, const label shortLen=0) const |
Write List, with line-breaks in ASCII when length exceeds shortLen. More... | |
template<class TypeT = T> | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | test (const label i) const |
Test bool value at specified position, always false for out-of-range access. More... | |
template<class TypeT = T> | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | get (const label i) const |
Return bool value at specified position, always false for out-of-range access. More... | |
template<class TypeT = T> | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | unset (const label i) |
Unset the bool entry at specified position, always false for out-of-range access. More... | |
T & | first () |
Access first element of the list, position [0]. More... | |
const T & | first () const |
Access first element of the list. More... | |
T & | last () |
Access last element of the list, position [size()-1]. More... | |
const T & | last () const |
Access last element of the list, position [size()-1]. More... | |
bool | found (const T &val, label pos=0) const |
Same as contains() More... | |
template<> | |
const bool & | operator[] (const label i) const |
template<> | |
UPstream::commsStruct & | operator[] (const label procID) |
template<> | |
const UPstream::commsStruct & | operator[] (const label procID) const |
template<> | |
Foam::UPstream::commsStruct & | operator[] (const label procID) |
template<> | |
const Foam::UPstream::commsStruct & | operator[] (const label procID) const |
Public Member Functions inherited from triSurfaceRegionSearch | |
triSurfaceRegionSearch (const triSurface &) | |
Construct from surface. Holds reference to surface! More... | |
triSurfaceRegionSearch (const triSurface &, const dictionary &dict) | |
Construct from surface and dictionary. Holds reference to surface! More... | |
~triSurfaceRegionSearch () | |
Destructor. More... | |
void | clearOut () |
Clear storage. More... | |
const PtrList< treeType > & | treeByRegion () const |
Demand driven construction of octree for each region. More... | |
void | findNearest (const pointField &samples, const scalarField &nearestDistSqr, const labelList ®ionIndices, List< pointIndexHit > &info) const |
Find the nearest point on the surface out of the regions. More... | |
Public Member Functions inherited from triSurfaceSearch | |
triSurfaceSearch (const triSurface &surface) | |
Construct from surface. Holds reference to surface! More... | |
triSurfaceSearch (const triSurface &surface, const dictionary &dict) | |
Construct from surface and dictionary. More... | |
triSurfaceSearch (const triSurface &surface, const scalar tolerance, const label maxTreeDepth=10) | |
Construct from components. More... | |
~triSurfaceSearch () | |
Destructor. More... | |
void | clearOut () |
Clear storage. More... | |
const indexedOctree< treeDataTriSurface > & | tree () const |
Demand driven construction of the octree. More... | |
const triSurface & | surface () const |
Return reference to the surface. More... | |
scalar | tolerance () const |
Return tolerance to use in searches. More... | |
label | maxTreeDepth () const |
Return max tree depth of octree. More... | |
boolList | calcInside (const pointField &searchPoints) const |
Calculate for each searchPoint inside/outside status. More... | |
void | findNearest (const pointField &samples, const scalarField &nearestDistSqr, List< pointIndexHit > &info) const |
pointIndexHit | nearest (const point &pt, const vector &span) const |
Calculate nearest point on surface for single searchPoint. Returns. More... | |
void | findLine (const pointField &start, const pointField &end, List< pointIndexHit > &info) const |
void | findLineAny (const pointField &start, const pointField &end, List< pointIndexHit > &info) const |
void | findLineAll (const pointField &start, const pointField &end, List< List< pointIndexHit >> &info) const |
Calculate all intersections from start to end. More... | |
Static Public Attributes | |
static word | meshSubDir = "triSurface" |
Return the mesh sub-directory name (usually "triSurface") More... | |
Static Public Attributes inherited from IOobject | |
static const Enum< fileCheckTypes > | fileCheckTypesNames |
Names for the fileCheckTypes. More... | |
static char | scopeSeparator |
Character for scoping object names (':' or '_') More... | |
static fileCheckTypes | fileModificationChecking |
Type of file modification checking. More... | |
static float | fileModificationSkew |
Time skew (seconds) for file modification checks. More... | |
static int | maxFileModificationPolls |
Max number of times to poll for file modification changes. More... | |
Static Public Attributes inherited from HashTableCore | |
static const label | maxTableSize |
Maximum allowable internal table size. Approximately labelMax/4. More... | |
Protected Member Functions | |
bool | isSurfaceClosed () const |
Check whether surface is closed without calculating any permanent. More... | |
triSurfaceMesh (const triSurfaceMesh &)=delete | |
No copy construct. More... | |
void | operator= (const triSurfaceMesh &)=delete |
No copy assignment. More... | |
Protected Member Functions inherited from regIOobject | |
bool | readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName) |
Helper: check readOpt flags and read if necessary. More... | |
Protected Member Functions inherited from IOobject | |
void | setBad (const string &s) |
Set the object state to bad. More... | |
Protected Member Functions inherited from triSurface | |
pointField & | storedPoints () |
Non-const access to global points. More... | |
List< labelledTri > & | storedFaces () |
Non-const access to the faces. More... | |
Protected Member Functions inherited from UList< T > | |
void | setAddressableSize (const label n) noexcept |
Set addressed size to be inconsistent with allocated storage. More... | |
void | size (const label n) |
Older name for setAddressableSize. More... | |
void | writeEntry (Ostream &os) const |
Write the UList with its compound type. More... | |
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. More... | |
void | fill_uniform (const T &val) |
Assign all entries to the given value. More... | |
void | fill_uniform (const Foam::zero) |
Assign all entries to zero. More... | |
UList< T > & | operator= (const UList< T > &)=delete |
No copy assignment (default: shallow copy) More... | |
template<> | |
void | writeEntry (Ostream &os) const |
Character list writeEntry. More... | |
template<> | |
void | operator= (const Foam::zero) |
Character list assign zero - avoids Foam::zero casting ambiguities. More... | |
template<> | |
void | writeEntry (Ostream &os) const |
template<> | |
void | operator= (const Foam::zero) |
Static Protected Member Functions | |
static bool | addFaceToEdge (const edge &, EdgeMap< label > &) |
Helper function for isSurfaceClosed. More... | |
static void | getNextIntersections (const indexedOctree< treeDataTriSurface > &octree, const point &start, const point &end, const vector &smallVec, DynamicList< pointIndexHit > &hits) |
Steps to next intersection. Adds smallVec and starts tracking. More... | |
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. More... | |
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. More... | |
Protected Attributes | |
fileName | fName_ |
Supplied fileName override. More... | |
scalar | minQuality_ |
Optional min triangle quality. Triangles below this get. More... | |
autoPtr< indexedOctree< treeDataEdge > > | edgeTree_ |
Search tree for boundary edges. More... | |
wordList | regions_ |
Names of regions. More... | |
label | surfaceClosed_ |
Is surface closed. More... | |
volumeType | outsideVolType_ |
If surface is closed, what is type of outside points. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from searchableSurface | |
static autoPtr< searchableSurface > | New (const word &surfaceType, const IOobject &io, const dictionary &dict) |
Return a reference to the selected searchableSurface. More... | |
Static Public Member Functions inherited from regIOobject | |
template<class Type > | |
static Type & | store (Type *p) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (std::unique_ptr< Type > &&ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (autoPtr< Type > &ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (autoPtr< Type > &&ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (refPtr< Type > &ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (refPtr< Type > &&ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (tmp< Type > &ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (tmp< Type > &&ptr) |
Transfer pointer ownership to its registry. More... | |
Static Public Member Functions inherited from IOobject | |
static bool | bannerEnabled () noexcept |
Status of output file banner. More... | |
static bool | bannerEnabled (bool on) noexcept |
Enable/disable output file banner. More... | |
static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
Split path into instance, local, name components. More... | |
template<class StringType > | |
static word | groupName (StringType base, const word &group) |
Create dot-delimited name.group string. More... | |
static word | group (const word &name) |
Return group (extension part of name) More... | |
static word | member (const word &name) |
Return member (name without the extension) More... | |
static word | scopedName (const std::string &scope, const word &name) |
Create scope:name or scope_name string. More... | |
static word | scopedName (const std::string &scope, const word &name1, const word &name2) |
Create scope:name1:name2 or scope_name1_name2 string. More... | |
static IOobject | selectIO (const IOobject &io, const fileName &altFile, const word &ioName="") |
Return the IOobject, but also consider an alternative file name. More... | |
static Ostream & | writeBanner (Ostream &os, const bool noSyntaxHint=false) |
Write the standard OpenFOAM file/dictionary banner. More... | |
static Ostream & | writeDivider (Ostream &os) |
Write the standard file section divider. More... | |
static Ostream & | writeEndDivider (Ostream &os) |
Write the standard end file divider. More... | |
Static Public Member Functions inherited from IOobjectOption | |
static bool | isAnyRead (readOption opt) noexcept |
True if any reading may be required (ie, != NO_READ) More... | |
static bool | isReadRequired (readOption opt) noexcept |
True if (MUST_READ | READ_MODIFIED) bits are set. More... | |
static bool | isReadOptional (readOption opt) noexcept |
True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More... | |
static readOption | lazierRead (readOption opt) noexcept |
Downgrade readOption optional (LAZY_READ), leaves NO_READ intact. More... | |
Static Public Member Functions inherited from HashTableCore | |
static label | canonicalSize (const label requested_size) |
Return a canonical (power-of-two) of the requested size. More... | |
Static Public Member Functions inherited from triSurface | |
static fileName | triSurfInstance (const Time &) |
Name of triSurface directory to use. More... | |
static wordHashSet | readTypes () |
Known readable file-types, including via friends or proxies. More... | |
static wordHashSet | writeTypes () |
Known writable file-types, including via friends or proxies. More... | |
static bool | canReadType (const word &fileType, bool verbose=false) |
Can we read this file format? More... | |
static bool | canWriteType (const word &fileType, bool verbose=false) |
Can we write this file format? More... | |
static bool | canRead (const fileName &name, bool verbose=false) |
Can we read this file format? More... | |
static fileName | relativeFilePath (const IOobject &io, const fileName &f, const bool isGlobal=true) |
Return fileName. More... | |
static fileName | checkFile (const IOobject &io, const bool isGlobal=true) |
Return fileName to load IOobject from. More... | |
static fileName | checkFile (const IOobject &io, const dictionary &dict, const bool isGlobal=true) |
Return fileName to load IOobject from. More... | |
static fileName | findFile (const IOobject &io, const bool isGlobal=true) |
Use IOobject information to resolve file to load from, or empty if the file does not exist. More... | |
static fileName | findFile (const IOobject &io, const dictionary &dict, const bool isGlobal=true) |
Use IOobject information to resolve file to load from, or empty if the file does not exist. More... | |
static autoPtr< triSurface > | New (const fileName &name, const word &fileType) |
Read construct from filename with given file type. More... | |
static autoPtr< triSurface > | New (const fileName &name) |
Read construct from filename (file type implicit from extension) More... | |
Static Public Member Functions inherited from List< labelledTri > | |
static const List< labelledTri > & | null () noexcept |
Return a null List (reference to a nullObject). Behaves like an empty List. More... | |
Static Public Member Functions inherited from UList< T > | |
static const UList< T > & | null () noexcept |
Return a null UList (reference to a nullObject). Behaves like an empty UList. More... | |
static constexpr label | max_size () noexcept |
The size of the largest possible UList. More... | |
Static Protected Attributes inherited from regIOobject | |
static bool | masterOnlyReading = false |
To flag master-only reading of objects. More... | |
IOoject and searching on triSurface.
Note: when constructing from dictionary has the following parameters:
Dictionary parameters
Property | Description | Required | Default |
---|---|---|---|
type | triSurfaceMesh | selector | |
file | File name to locate the surface | no | |
fileType | The surface format (Eg, nastran) | no | |
scale | Scaling factor | no | 0 |
minQuality | Quality criterion | no | -1 |
Definition at line 102 of file triSurfaceMesh.H.
enum readAction |
Enumerator | |
---|---|
localOnly | |
localOrGlobal | |
masterOnly |
Definition at line 229 of file triSurfaceMesh.H.
|
protecteddelete |
No copy construct.
triSurfaceMesh | ( | const IOobject & | io, |
const triSurface & | s | ||
) |
Construct from triSurface.
Definition at line 281 of file triSurfaceMesh.C.
References searchableSurface::bounds(), and PrimitivePatch<::Foam::List< labelledTri >, pointField >::points().
triSurfaceMesh | ( | const IOobject & | io | ) |
Construct read.
Definition at line 307 of file triSurfaceMesh.C.
References searchableSurface::bounds(), and PrimitivePatch<::Foam::List< labelledTri >, pointField >::points().
triSurfaceMesh | ( | const IOobject & | io, |
const dictionary & | dict | ||
) |
Construct from IO and dictionary (used by searchableSurface).
Dictionary may contain a 'scale' entry (eg, 0.001: mm -> m)
Definition at line 336 of file triSurfaceMesh.C.
References dict, Foam::endl(), dictionary::getOrDefault(), Foam::Info, keyType::LITERAL, IOobject::name(), PrimitivePatch<::Foam::List< labelledTri >, pointField >::points(), dictionary::readIfPresent(), and triSurface::relativeFilePath().
triSurfaceMesh | ( | const IOobject & | io, |
const readAction | r | ||
) |
Definition at line 394 of file triSurfaceMesh.C.
References searchableSurface::bounds(), Pstream::broadcast(), Foam::ensightOutput::debug, Foam::endl(), io(), triSurfaceMesh::localOrGlobal, UPstream::master(), triSurfaceMesh::masterOnly, UPstream::parRun(), triSurface::patches(), PrimitivePatch<::Foam::List< labelledTri >, pointField >::points(), Foam::Pout, UList< T >::size(), and triSurface::transfer().
triSurfaceMesh | ( | const IOobject & | io, |
const dictionary & | dict, | ||
const readAction | r | ||
) |
Definition at line 497 of file triSurfaceMesh.C.
References Pstream::broadcast(), Foam::ensightOutput::debug, dict, Foam::endl(), dictionary::getOrDefault(), IOobject::globalFilePath(), Foam::Info, io(), IOobjectOption::isAnyRead(), keyType::LITERAL, IOobject::localFilePath(), UPstream::master(), IOobject::name(), word::null, IOobject::objectPath(), UPstream::parRun(), triSurface::patches(), PrimitivePatch<::Foam::List< labelledTri >, pointField >::points(), Foam::Pout, dictionary::readIfPresent(), UList< T >::size(), and triSurface::transfer().
|
virtual |
Destructor.
Definition at line 645 of file triSurfaceMesh.C.
Helper function for isSurfaceClosed.
Definition at line 44 of file triSurfaceMesh.C.
References Foam::BitOps::count(), Foam::constant::electromagnetic::e, Foam::exit(), Foam::FatalError, FatalErrorInFunction, HashTable< T, Key, Hash >::find(), and HashTable< T, Key, Hash >::insert().
Referenced by triSurfaceMesh::isSurfaceClosed().
|
protected |
Check whether surface is closed without calculating any permanent.
addressing.
Return open?
return false;
Definition at line 92 of file triSurfaceMesh.C.
References triSurfaceMesh::addFaceToEdge(), Foam::ensightOutput::debug, Foam::endl(), f(), forAll, forAllConstIters(), IOobject::name(), Foam::nl, PrimitivePatch<::Foam::List< labelledTri >, pointField >::points(), Foam::Pout, pts, UList< T >::size(), and WarningInFunction.
|
staticprotected |
Steps to next intersection. Adds smallVec and starts tracking.
from there.
|
protecteddelete |
No copy assignment.
TypeName | ( | "triSurfaceMesh" | ) |
Runtime type information.
void clearOut | ( | ) |
Clear storage.
Definition at line 651 of file triSurfaceMesh.C.
References triSurfaceRegionSearch::clearOut(), and triSurface::clearOut().
Referenced by distributedTriSurfaceMesh::clearOut().
|
virtual |
Move points.
Reimplemented from triSurface.
Definition at line 732 of file triSurfaceMesh.C.
References triSurfaceRegionSearch::clearOut(), Foam::ensightOutput::debug, Foam::endl(), regIOobject::eventNo(), IOobject::instance(), triSurface::movePoints(), PrimitivePatch<::Foam::List< labelledTri >, pointField >::points(), Foam::Pout, objectRegistry::time(), and Time::timeName().
const Foam::indexedOctree< Foam::treeDataEdge > & edgeTree | ( | ) | const |
Demand driven construction of octree for boundary edges.
Definition at line 765 of file triSurfaceMesh.C.
References PatchTools::calcBounds(), Foam::ensightOutput::debug, Foam::constant::electromagnetic::e, Foam::endl(), boundBox::inflate(), nPoints, indexedOctreeBase::perturbTol(), Foam::Pout, rndGen, and IntRange< IntType >::size().
|
virtual |
Names of regions.
Implements searchableSurface.
Definition at line 839 of file triSurfaceMesh.C.
References forAll, IOobject::name(), patches, and List< T >::setSize().
|
virtual |
Whether supports volume type (below) - i.e. whether is closed.
Reimplemented from searchableSurface.
Reimplemented in closedTriSurfaceMesh.
Definition at line 853 of file triSurfaceMesh.C.
|
virtual |
If surface is closed, what is type of points outside bounds.
Implements searchableSurface.
Definition at line 871 of file triSurfaceMesh.C.
References Foam::ensightOutput::debug, Foam::endl(), Foam::max(), volumeType::names, Foam::Pout, and volumeType::UNKNOWN.
|
inlinevirtual |
Range of local indices that can be returned.
Implements searchableSurface.
Definition at line 291 of file triSurfaceMesh.H.
References UList< T >::size().
|
virtual |
Get representative set of element coordinates.
Usually the element centres (should be of length size()).
Implements searchableSurface.
Definition at line 662 of file triSurfaceMesh.C.
References PrimitivePatch<::Foam::List< labelledTri >, pointField >::faceCentres(), PrimitivePatch<::Foam::List< labelledTri >, pointField >::hasFaceCentres(), tmp< T >::New(), PrimitivePatch<::Foam::List< labelledTri >, pointField >::points(), pts, and UList< T >::size().
|
virtual |
Get bounding spheres (centre and radius squared). Any point.
on surface is guaranteed to be inside.
Implements searchableSurface.
Definition at line 690 of file triSurfaceMesh.C.
References coordinates(), f(), forAll, Foam::max(), UList< T >::operator[](), PrimitivePatch<::Foam::List< labelledTri >, pointField >::points(), pts, List< T >::setSize(), and Foam::sqr().
|
virtual |
Get the points that define the surface.
Implements searchableSurface.
Definition at line 716 of file triSurfaceMesh.C.
References PrimitivePatch<::Foam::List< labelledTri >, pointField >::points().
Referenced by powerLawLopesdaCostaZone::powerLawLopesdaCostaZone(), triSurfaceMeshPointSet::triSurfaceMeshPointSet(), and searchableSurfaces::writeStats().
|
virtual |
Does any part of the surface overlap the supplied bound box?
Implements searchableSurface.
Definition at line 722 of file triSurfaceMesh.C.
References UList< T >::empty(), and tree().
|
virtual |
Implements searchableSurface.
Reimplemented in distributedTriSurfaceMesh.
Definition at line 906 of file triSurfaceMesh.C.
References Foam::ensightOutput::debug, Foam::endl(), triSurfaceSearch::findNearest(), Foam::max(), Foam::Pout, samples(), UList< T >::size(), Foam::sqrt(), and Foam::Zero.
Referenced by distributedTriSurfaceMesh::findNearest().
|
virtual |
Find the nearest locations for the supplied points to a.
particular region in the searchable surface.
Reimplemented from searchableSurface.
Reimplemented in distributedTriSurfaceMesh.
Definition at line 931 of file triSurfaceMesh.C.
References Foam::ensightOutput::debug, Foam::endl(), triSurfaceRegionSearch::findNearest(), Foam::max(), Foam::Pout, samples(), UList< T >::size(), Foam::sqrt(), and Foam::Zero.
|
virtual |
Find first intersection on segment from start to end.
Note: searchableSurfacesQueries expects no intersection to be found if start==end. Is problem?
Implements searchableSurface.
Reimplemented in distributedTriSurfaceMesh.
Definition at line 963 of file triSurfaceMesh.C.
References Foam::ensightOutput::debug, stdFoam::end(), Foam::endl(), triSurfaceSearch::findLine(), Foam::Pout, and UList< T >::size().
Referenced by distributedTriSurfaceMesh::findLine(), and powerLawLopesdaCostaZone::powerLawLopesdaCostaZone().
|
virtual |
Return any intersection on segment from start to end.
Implements searchableSurface.
Reimplemented in distributedTriSurfaceMesh.
Definition at line 986 of file triSurfaceMesh.C.
References Foam::ensightOutput::debug, stdFoam::end(), Foam::endl(), triSurfaceSearch::findLineAny(), Foam::Pout, and UList< T >::size().
Referenced by distributedTriSurfaceMesh::findLineAny().
|
virtual |
Get all intersections in order from start to end.
Implements searchableSurface.
Reimplemented in distributedTriSurfaceMesh.
Definition at line 1009 of file triSurfaceMesh.C.
References Foam::ensightOutput::debug, stdFoam::end(), Foam::endl(), triSurfaceSearch::findLineAll(), Foam::Pout, and UList< T >::size().
Referenced by distributedTriSurfaceMesh::findLineAll(), and triSurfaceTools::writeCloseness().
|
virtual |
From a set of points and indices get the region.
Implements searchableSurface.
Reimplemented in distributedTriSurfaceMesh.
Definition at line 1032 of file triSurfaceMesh.C.
References Foam::ensightOutput::debug, Foam::endl(), forAll, UList< T >::operator[](), Foam::Pout, List< T >::setSize(), and UList< T >::size().
|
virtual |
From a set of points and indices get the normal.
Implements searchableSurface.
Reimplemented in distributedTriSurfaceMesh.
Definition at line 1065 of file triSurfaceMesh.C.
References Foam::ensightOutput::debug, Foam::endl(), forAll, Foam::Pout, pts, s, List< T >::setSize(), UList< T >::size(), and Foam::Zero.
Referenced by distributedTriSurfaceMesh::getNormal().
|
virtual |
Determine type (inside/outside/mixed) for point.
Unknown if cannot be determined (e.g. non-manifold surface)
Implements searchableSurface.
Reimplemented in distributedTriSurfaceMesh.
Definition at line 1219 of file triSurfaceMesh.C.
References Foam::ensightOutput::debug, Foam::endl(), forAll, indexedOctreeBase::perturbTol(), points, Foam::Pout, List< T >::setSize(), UList< T >::size(), tree(), and volumeType::UNKNOWN.
Referenced by distributedTriSurfaceMesh::getVolumeType().
|
virtual |
WIP. Store element-wise field.
Reimplemented from searchableSurface.
Definition at line 1148 of file triSurfaceMesh.C.
References IOobjectOption::AUTO_WRITE, Foam::ensightOutput::debug, Foam::dimless, Foam::endl(), IOobjectOption::NO_READ, Foam::Pout, IOobjectOption::REGISTER, objectRegistry::time(), timeName, and Foam::HashTableOps::values().
|
virtual |
WIP. From a set of hits (points and.
indices) get the specified field. Misses do not get set.
Reimplemented from searchableSurface.
Reimplemented in distributedTriSurfaceMesh.
Definition at line 1188 of file triSurfaceMesh.C.
References Foam::ensightOutput::debug, Foam::endl(), fld, forAll, Foam::Pout, UList< T >::size(), and Foam::HashTableOps::values().
Referenced by distributedTriSurfaceMesh::getField().
|
inlinevirtual |
The writeData function is required by regIOobject but not used.
For this class, write is used instead
Reimplemented from objectRegistry.
Definition at line 408 of file triSurfaceMesh.H.
References NotImplemented.
|
virtual |
Write using stream options.
Reimplemented from objectRegistry.
Reimplemented in distributedTriSurfaceMesh.
Definition at line 1273 of file triSurfaceMesh.C.
References TimePaths::caseConstant(), TimePaths::caseSystem(), TimePaths::constant(), string::expand(), IOobject::instance(), fileName::isAbsolute(), Foam::isFile(), Foam::mkDir(), IOobject::objectPath(), fileName::path(), runTime, TimePaths::system(), IOobject::time(), Time::timeName(), and triSurface::write().
|
inlinevirtual |
Is object global.
Reimplemented from searchableSurface.
Reimplemented in distributedTriSurfaceMesh.
Definition at line 426 of file triSurfaceMesh.H.
|
inlinevirtual |
Return complete path + object name if the file exists.
either in the case/processor or case otherwise null
Reimplemented from searchableSurface.
Reimplemented in distributedTriSurfaceMesh.
Definition at line 436 of file triSurfaceMesh.H.
References IOobject::globalFilePath(), and Foam::type().
|
protected |
Supplied fileName override.
Definition at line 116 of file triSurfaceMesh.H.
|
protected |
Optional min triangle quality. Triangles below this get.
ignored for normal calculation
Definition at line 123 of file triSurfaceMesh.H.
|
mutableprotected |
Search tree for boundary edges.
Definition at line 128 of file triSurfaceMesh.H.
|
mutableprotected |
Names of regions.
Definition at line 133 of file triSurfaceMesh.H.
|
mutableprotected |
Is surface closed.
Definition at line 138 of file triSurfaceMesh.H.
|
mutableprotected |
If surface is closed, what is type of outside points.
Definition at line 143 of file triSurfaceMesh.H.
|
static |
Return the mesh sub-directory name (usually "triSurface")
Definition at line 199 of file triSurfaceMesh.H.