Finite area boundary mesh. More...
Public Member Functions | |
| TypeName ("faBoundaryMesh") | |
| Runtime type information. More... | |
| faBoundaryMesh (const IOobject &io, const faMesh &fam) | |
| Construct from dictionary. More... | |
| faBoundaryMesh (const IOobject &io, const faMesh &fam, const label size) | |
| Construct given size. More... | |
| ~faBoundaryMesh ()=default | |
| Destructor. More... | |
| void | calcGeometry () |
| Calculate the geometry for the patches. More... | |
| const faMesh & | mesh () const |
| Return the mesh reference. More... | |
| lduInterfacePtrsList | interfaces () const |
| wordList | names () const |
| Return a list of patch names. More... | |
| wordList | types () const |
| Return a list of patch types. More... | |
| labelList | indices (const keyType &key, const bool useGroups=false) const |
| Return patch indices for all matches. More... | |
| label | findIndex (const keyType &key) const |
| Return patch index for the first match, return -1 if not found. More... | |
| label | findPatchID (const word &patchName) const |
| Find patch index given a name, return -1 if not found. More... | |
| label | whichPatch (const label edgeIndex) const |
| Return patch index for a given edge label. More... | |
| bool | checkDefinition (const bool report=false) const |
| Check boundary definition. More... | |
| void | movePoints (const pointField &) |
| Correct faBoundaryMesh after moving points. More... | |
| void | updateMesh () |
| Correct faBoundaryMesh after topology update. More... | |
| bool | writeData (Ostream &) const |
| writeData member function required by regIOobject More... | |
| labelList | findIndices (const keyType &key, const bool useGroups=false) const |
| Identical to the indices() method (AUG-2018) More... | |
 Public Member Functions inherited from PtrList< T > | |
| constexpr | PtrList () noexcept |
| Default construct. More... | |
| PtrList (const label len) | |
| Construct with specified size, each element initialized to nullptr. More... | |
| PtrList (const PtrList< T > &list) | |
| Copy construct using 'clone()' method on each element. More... | |
| PtrList (PtrList< T > &&list) | |
| Move construct. More... | |
| PtrList (UList< T * > &list) | |
| Take ownership of pointers in the list, set old pointers to null. More... | |
| template<class CloneArg > | |
| PtrList (const PtrList< T > &list, const CloneArg &cloneArgs) | |
| Copy construct using 'clone()' method on each element. More... | |
| PtrList (PtrList< T > &list, bool reuse) | |
| Construct as copy or re-use as specified. More... | |
| PtrList (const SLPtrList< T > &list) | |
| Copy construct using 'clone()' on each element of SLPtrList<T> More... | |
| template<class INew > | |
| PtrList (Istream &is, const INew &inew) | |
| Construct from Istream using given Istream constructor class. More... | |
| PtrList (Istream &is) | |
| Construct from Istream using default Istream constructor class. More... | |
| ~PtrList () | |
| Destructor. More... | |
| template<class... Args> | |
| PtrList< T > | clone (Args &&... args) const |
| Make a copy by cloning each of the list elements. More... | |
| const T * | set (const label i) const |
| Return const pointer to element (can be nullptr),. More... | |
| void | clear () |
| Clear the PtrList. Delete allocated entries and set size to zero. More... | |
| void | resize (const label newLen) |
| Adjust size of PtrList. More... | |
| void | setSize (const label newLen) |
| Same as resize() More... | |
| template<class... Args> | |
| void | emplace_append (Args &&... args) |
| Construct and append an element to the end of the list. More... | |
| void | append (T *ptr) |
| Append an element to the end of the list. More... | |
| void | append (autoPtr< T > &ptr) |
| Move append an element to the end of the list. More... | |
| void | append (autoPtr< T > &&ptr) |
| Move append an element to the end of the list. More... | |
| void | append (std::unique_ptr< T > &&ptr) |
| Move append an element to the end of the list. More... | |
| void | append (const refPtr< T > &ptr) |
| Move or clone append a refPtr to the end of the list. More... | |
| void | append (const tmp< T > &ptr) |
| Move or clone append a tmp to the end of the list. More... | |
| template<class... Args> | |
| autoPtr< T > | emplace (const label i, Args &&... args) |
| Construct and set an element. More... | |
| autoPtr< T > | set (const label i, T *ptr) |
| Set element to given pointer and return old element (can be null) More... | |
| autoPtr< T > | set (const label i, autoPtr< T > &ptr) |
| Set element to given autoPtr and return old element. More... | |
| autoPtr< T > | set (const label i, autoPtr< T > &&ptr) |
| Set element to given autoPtr and return old element. More... | |
| autoPtr< T > | set (const label i, std::unique_ptr< T > &&ptr) |
| Set element to given unique_ptr and return old element. More... | |
| autoPtr< T > | set (const label i, const refPtr< T > &ptr) |
| Set element to given refPtr and return old element. More... | |
| autoPtr< T > | set (const label i, const tmp< T > &ptr) |
| Set element to given tmp and return old element. More... | |
| autoPtr< T > | release (const label i) |
| Release ownership of the pointer at the given position. More... | |
| void | transfer (PtrList< T > &list) |
| Transfer into this list and annul the argument list. More... | |
| void | operator= (const PtrList< T > &list) |
| Copy assignment. More... | |
| void | operator= (PtrList< T > &&list) |
| Move assignment. More... | |
| template<class... Args> | |
| Foam::PtrList< T > | clone (Args &&... args) const |
| template<class... Args> | |
| Foam::autoPtr< T > | emplace (const label i, Args &&... args) |
| Public Member Functions inherited from regIOobject | |
| TypeName ("regIOobject") | |
| Runtime type information. More... | |
| regIOobject (const IOobject &io, const bool isTime=false) | |
| regIOobject (const regIOobject &rio) | |
| Copy construct. More... | |
| regIOobject (const regIOobject &rio, bool registerCopy) | |
| regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
| regIOobject (const IOobject &io, const regIOobject &rio) | |
| Copy construct with new IO parameters. More... | |
| virtual | ~regIOobject () |
| Destructor. More... | |
| bool | checkIn () |
| Add object to registry, if not already registered. More... | |
| bool | checkOut () |
| Remove all file watches and remove object from registry. More... | |
| virtual void | addWatch () |
| Add file watch on object (if registered and READ_IF_MODIFIED) More... | |
| bool | ownedByRegistry () const |
| Is this object owned by the registry? More... | |
| bool | store () |
| void | release (const bool unregister=false) |
| Release ownership of this object from its registry. More... | |
| label | eventNo () const |
| Event number at last update. More... | |
| label & | eventNo () |
| Event number at last update. More... | |
| bool | upToDate (const regIOobject &) const |
| Return true if up-to-date with respect to given object. More... | |
| bool | upToDate (const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More... | |
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More... | |
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More... | |
| void | setUpToDate () |
| Set as up-to-date. More... | |
| virtual void | rename (const word &newName) |
| Rename. More... | |
| virtual fileName | filePath () const |
| Return complete path + object name if the file exists. More... | |
| bool | headerOk () |
| Read and check header info. More... | |
| Istream & | readStream (const word &, const bool valid=true) |
| Return Istream and check object type against that given. More... | |
| void | close () |
| Close Istream. More... | |
| virtual bool | readData (Istream &) |
| Virtual readData function. More... | |
| virtual bool | read () |
| Read object. More... | |
| virtual label | addWatch (const fileName &) |
| Add file watch for fileName on object if not yet watched. More... | |
| const labelList & | watchIndices () const |
| Return file-monitoring handles. More... | |
| labelList & | watchIndices () |
| Return file-monitoring handles. More... | |
| virtual bool | modified () const |
| virtual bool | readIfModified () |
| Read object if modified (as set by call to modified) More... | |
| virtual bool | writeObject (IOstreamOption streamOpt, const bool valid) const |
| Write using stream options. More... | |
| virtual bool | write (const bool valid=true) const |
| Write using setting from DB. More... | |
| virtual bool | global () const |
| Is object global. More... | |
| void | operator= (const IOobject &io) |
| Copy assignment. More... | |
| virtual bool | writeObject (IOstream::streamFormat fmt, IOstream::versionNumber ver, IOstream::compressionType comp, const bool valid) const |
| Write using given format, version and compression. More... | |
| Public Member Functions inherited from IOobject | |
| TypeName ("IOobject") | |
| Declare type-name, virtual type (with debug switch) More... | |
| IOobject (const IOobject &)=default | |
| Copy construct. More... | |
| virtual | ~IOobject ()=default |
| Destructor. More... | |
| IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
| Construct from name, instance, registry, io options. More... | |
| IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
| Construct from name, instance, local, registry, io options. More... | |
| IOobject (const fileName &path, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
| Construct from path, registry, io options. More... | |
| IOobject (const IOobject &io, const objectRegistry ®istry) | |
| Copy construct, resetting registry. More... | |
| IOobject (const IOobject &io, const word &name) | |
| Copy construct, resetting name. More... | |
| IOobject (const IOobject &io, readOption, writeOption) | |
| Copy construct, resetting io options. More... | |
| autoPtr< IOobject > | clone () const |
| Clone. More... | |
| autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
| Clone resetting registry. More... | |
| const objectRegistry & | db () const |
| Return the local objectRegistry. More... | |
| const Time & | time () const |
| Return time. More... | |
| const word & | name () const |
| Return name. More... | |
| const word & | headerClassName () const |
| Return name of the class name read from header. More... | |
| word & | headerClassName () |
| Return non-constant access to the class name read from header. More... | |
| const string & | note () const |
| Return the optional note. More... | |
| string & | note () |
| Return non-constant access to the optional note. More... | |
| bool | registerObject () const |
| Should object created with this IOobject be registered? More... | |
| bool & | registerObject () |
| Should object created with this IOobject be registered? More... | |
| bool | globalObject () const |
| Is object same for all processors? More... | |
| bool & | globalObject () |
| Is object same for all processors? More... | |
| unsigned | labelByteSize () const |
| The label byte-size, possibly read from the header. More... | |
| unsigned | scalarByteSize () const |
| The scalar byte-size, possibly read from the header. More... | |
| bool | isHeaderClassName (const word &clsName) const |
| Test if headerClassName() equals the given class name. More... | |
| template<class Type > | |
| bool | isHeaderClassName () const |
| Test if headerClassName() equals Type::typeName. More... | |
| readOption | readOpt () const |
| The read option. More... | |
| readOption & | readOpt () |
| Non-constant access to the read option. More... | |
| writeOption | writeOpt () const |
| The write option. More... | |
| writeOption & | writeOpt () |
| Non-constant access to the write option. More... | |
| word | group () const |
| Return group (extension part of name) More... | |
| word | member () const |
| Return member (name without the extension) More... | |
| const fileName & | rootPath () const |
| const fileName & | caseName () const |
| const fileName & | instance () const |
| fileName & | instance () |
| const fileName & | local () const |
| fileName | path () const |
| The complete path. More... | |
| fileName | path (const word &instance, const fileName &local=fileName::null) const |
| The complete path with alternative instance and local. More... | |
| fileName | objectPath () const |
| The complete path + object name. More... | |
| fileName | localFilePath (const word &typeName, const bool search=true) const |
| Helper for filePath that searches locally. More... | |
| fileName | globalFilePath (const word &typeName, const bool search=true) const |
| Helper for filePath that searches up if in parallel. More... | |
| bool | readHeader (Istream &is) |
| Read header. More... | |
| template<class Type > | |
| bool | typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true) |
| Read header (uses typeFilePath to find file) and check its info. More... | |
| template<class Type > | |
| void | warnNoRereading () const |
| Helper: warn that type does not support re-reading. More... | |
| bool | writeHeader (Ostream &os) const |
| Write header. More... | |
| bool | writeHeader (Ostream &os, const word &objectType) const |
| Write header. Allow override of type. More... | |
| bool | good () const |
| bool | bad () const |
| InfoProxy< IOobject > | info () const |
| Return info proxy. More... | |
| void | operator= (const IOobject &io) |
| template<> | |
| bool | isHeaderClassName () const |
Specialization for void always returns true (no headerClassName check). More... | |
| template<class StringType > | |
| Foam::word | groupName (StringType base, const word &group) |
| template<class StringType > | |
| Foam::word | scopedName (StringType scope, const word &name) |
Friends | |
| Ostream & | operator<< (Ostream &, const faBoundaryMesh &) |
Additional Inherited Members | |
| Public Types inherited from IOobject | |
| enum | objectState : char { GOOD, BAD } |
| Enumeration defining the valid states of an IOobject. More... | |
| enum | readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ } |
| Enumeration defining the read options. More... | |
| enum | writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 } |
| Enumeration defining the write options. More... | |
| enum | fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster } |
| Enumeration defining the file checking options. More... | |
| Static Public Member Functions inherited from regIOobject | |
| template<class Type > | |
| static Type & | store (Type *p) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (autoPtr< Type > &ptr) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (autoPtr< Type > &&ptr) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (refPtr< Type > &ptr) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (refPtr< Type > &&ptr) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (tmp< Type > &ptr) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (tmp< Type > &&ptr) |
| Transfer pointer ownership to its registry. More... | |
| Static Public Member Functions inherited from IOobject | |
| static bool | 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... | |
| template<class StringType > | |
| static word | scopedName (StringType scope, const word &name) |
| Create scope:name or scope_name string. More... | |
| static IOobject | selectIO (const IOobject &io, const fileName &altFile, const word &ioName="") |
| Return the IOobject, but also consider an alternative file name. More... | |
| static Ostream & | writeBanner (Ostream &os, bool noHint=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 Attributes inherited from regIOobject | |
| static float | fileModificationSkew |
| static int | maxFileModificationPolls |
| 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... | |
| Protected Member Functions inherited from PtrList< T > | |
| template<class INew > | |
| void | readIstream (Istream &is, const INew &inew) |
| Read from Istream using Istream constructor class. More... | |
| void | free () |
| Delete the allocated entries, but retain the list size. More... | |
| Protected Member Functions inherited from regIOobject | |
| bool | readHeaderOk (const IOstream::streamFormat PstreamFormat, const word &typeName) |
| Helper: check readOpt flags and read if necessary. More... | |
| Istream * | objectStream () |
| Construct and return an IFstream for the object. More... | |
| Protected Member Functions inherited from IOobject | |
| void | setBad (const string &s) |
| Set the object state to bad. More... | |
| Static Protected Attributes inherited from regIOobject | |
| static bool | masterOnlyReading = false |
| To flag master-only reading of objects. More... | |
Finite area boundary mesh.
Definition at line 66 of file faBoundaryMesh.H.
| faBoundaryMesh | ( | const IOobject & | io, |
| const faMesh & | fam | ||
| ) |
Construct from dictionary.
Definition at line 119 of file faBoundaryMesh.C.
References IOstream::check(), dict, forAll, FUNCTION_NAME, Foam::New(), and patches.
| faBoundaryMesh | ( | const IOobject & | io, |
| const faMesh & | fam, | ||
| const label | size | ||
| ) |
Construct given size.
Definition at line 161 of file faBoundaryMesh.C.
|
default |
Destructor.
| TypeName | ( | "faBoundaryMesh" | ) |
Runtime type information.
| void calcGeometry | ( | ) |
Calculate the geometry for the patches.
(transformation tensors etc.)
Definition at line 175 of file faBoundaryMesh.C.
References forAll, and faMesh::pointAreaNormals().
Referenced by faMesh::faMesh(), and faMesh::updateMesh().
| const Foam::faMesh & mesh | ( | ) | const |
Return the mesh reference.
Definition at line 195 of file faBoundaryMesh.C.
Referenced by wedgeFaPatch::wedgeFaPatch().
| Foam::lduInterfacePtrsList interfaces | ( | ) | const |
Return a list of pointers for each patch with only those pointing to interfaces being set
Definition at line 201 of file faBoundaryMesh.C.
References forAll, and UPtrList< T >::set().
| Foam::wordList names | ( | ) | const |
Return a list of patch names.
Definition at line 221 of file faBoundaryMesh.C.
| Foam::wordList types | ( | ) | const |
Return a list of patch types.
Definition at line 227 of file faBoundaryMesh.C.
| Foam::labelList indices | ( | const keyType & | key, |
| const bool | useGroups = false |
||
| ) | const |
Return patch indices for all matches.
A no-op (returns -1) for an empty key
Definition at line 234 of file faBoundaryMesh.C.
References Foam::findIndexImpl(), Foam::indicesImpl(), keyType::isPattern(), and patchId().
Referenced by faBoundaryMesh::findIndices().
| Foam::label findIndex | ( | const keyType & | key | ) | const |
Return patch index for the first match, return -1 if not found.
A no-op (returns -1) for an empty key
Definition at line 269 of file faBoundaryMesh.C.
References Foam::findIndexImpl(), and keyType::isPattern().
| Foam::label findPatchID | ( | const word & | patchName | ) | const |
Find patch index given a name, return -1 if not found.
A no-op (returns -1) for an empty name
Definition at line 290 of file faBoundaryMesh.C.
References Foam::findIndexImpl().
Referenced by interfaceTrackingFvMesh::update().
| Foam::label whichPatch | ( | const label | edgeIndex | ) | const |
Return patch index for a given edge label.
Definition at line 301 of file faBoundaryMesh.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, forAll, mesh, and primitiveMesh::nEdges().
Check boundary definition.
Definition at line 343 of file faBoundaryMesh.C.
References Foam::expressions::patchExpr::debug, Foam::endl(), forAll, Foam::Info, InfoInFunction, mesh, IOobject::name(), primitiveMesh::nInternalEdges(), and SeriousErrorInFunction.
| void movePoints | ( | const pointField & | p | ) |
Correct faBoundaryMesh after moving points.
Definition at line 390 of file faBoundaryMesh.C.
References forAll, polyBoundaryMesh::movePoints(), p, and patches.
| void updateMesh | ( | ) |
Correct faBoundaryMesh after topology update.
Definition at line 412 of file faBoundaryMesh.C.
References forAll, patches, and polyBoundaryMesh::updateMesh().
Referenced by faMesh::faMesh(), and faMesh::updateMesh().
writeData member function required by regIOobject
Implements regIOobject.
Definition at line 428 of file faBoundaryMesh.C.
References token::BEGIN_LIST, Ostream::beginBlock(), IOstream::check(), Foam::decrIndent(), token::END_LIST, Ostream::endBlock(), FUNCTION_NAME, IOstream::good(), Foam::incrIndent(), Foam::nl, p, and patches.
Referenced by Foam::operator<<().
Identical to the indices() method (AUG-2018)
Definition at line 178 of file faBoundaryMesh.H.
References faBoundaryMesh::indices().
|
friend |
1.8.17 