faBoundaryMesh Class Reference

Finite area boundary mesh. More...

Inheritance diagram for faBoundaryMesh:
[legend]
Collaboration diagram for faBoundaryMesh:
[legend]

Public Member Functions

 TypeName ("faBoundaryMesh")
 Runtime type information. More...
 
 faBoundaryMesh (const IOobject &io, const faMesh &fam)
 Construct from faMesh. More...
 
 faBoundaryMesh (const IOobject &io, const faMesh &fam, const label size)
 Construct from faMesh and given size. More...
 
 ~faBoundaryMesh ()=default
 Destructor. More...
 
const faMeshmesh () const noexcept
 Return the mesh reference. More...
 
UPtrList< const labelUListedgeLabels () const
 Return a list of edgeLabels for each patch. More...
 
UPtrList< const labelUListedgeFaces () const
 Return a list of edgeFaces for each patch. More...
 
lduInterfacePtrsList interfaces () const
 
label nNonProcessor () const
 The number of patches before the first processor patch. More...
 
wordList names () const
 Return a list of patch names. More...
 
wordList types () const
 Return a list of patch types. More...
 
labelList patchStarts () const
 Return a list of patch start indices. More...
 
labelList patchSizes () const
 Return a list of patch sizes (number of edges in each patch) More...
 
List< labelRangepatchRanges () const
 Return a list of patch ranges. More...
 
label start () const
 The start label of the edges in the faMesh edges list. More...
 
label nEdges () const
 The number of boundary edges for the underlying mesh. More...
 
labelRange range () const
 The edge range for all boundary edges. More...
 
labelList indices (const wordRe &matcher, const bool useGroups=true) const
 Return (sorted) patch indices for all matches. More...
 
labelList indices (const wordRes &matcher, const bool useGroups=true) const
 Return (sorted) patch indices for all matches. More...
 
label findIndex (const wordRe &key) const
 Return patch index for the first match, return -1 if not found. More...
 
label findPatchID (const word &patchName, const bool allowNotFound=true) 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...
 
const HashTable< labelList > & groupPatchIDs () const
 The patch indices per patch group. More...
 
void setGroup (const word &groupName, const labelUList &patchIDs)
 Set/add group with patches. More...
 
bool checkDefinition (const bool report=false) const
 Check boundary definition. More...
 
bool checkParallelSync (const bool report=false) const
 Check whether all procs have all patches and in same order. More...
 
void calcGeometry ()
 Calculate the geometry for the patches. More...
 
void movePoints (const pointField &)
 Correct faBoundaryMesh after moving points. More...
 
void updateMesh ()
 Correct faBoundaryMesh after topology update. More...
 
bool writeData (Ostream &os) const
 The writeData member function required by regIOobject. More...
 
virtual bool writeObject (IOstreamOption streamOpt, const bool valid) const
 Write using stream options. More...
 
labelList findIndices (const wordRe &key, bool useGroups=true) 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< Tclone (Args &&... args) const
 Make a copy by cloning each of the list elements. More...
 
const Tset (const label i) const
 
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...
 
void append (PtrList< T > &&other)
 Move append another list to the end of this list. More...
 
template<class... Args>
autoPtr< Templace (const label i, Args &&... args)
 Construct and set an element. More...
 
autoPtr< Tset (const label i, T *ptr)
 Set element to given pointer and return old element (can be null) More...
 
autoPtr< Tset (const label i, autoPtr< T > &ptr)
 Set element to given autoPtr and return old element. More...
 
autoPtr< Tset (const label i, autoPtr< T > &&ptr)
 Set element to given autoPtr and return old element. More...
 
autoPtr< Tset (const label i, std::unique_ptr< T > &&ptr)
 Set element to given unique_ptr and return old element. More...
 
autoPtr< Tset (const label i, const refPtr< T > &ptr)
 Set element to given refPtr and return old element. More...
 
autoPtr< Tset (const label i, const tmp< T > &ptr)
 Set element to given tmp and return old element. More...
 
autoPtr< Trelease (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< Tclone (Args &&... args) const
 
template<class... Args>
Foam::autoPtr< Templace (const label i, Args &&... args)
 
- Public Member Functions inherited from UPtrList< T >
constexpr UPtrList () noexcept
 Default construct. More...
 
 UPtrList (const label len)
 Construct with specified size, each element initialized to nullptr. More...
 
 UPtrList (const UPtrList< T > &list)
 Copy construct (shallow copies addresses) More...
 
 UPtrList (UPtrList< T > &&list)
 Move construct. More...
 
 UPtrList (UPtrList< T > &list, bool reuse)
 Construct as shallow copy or re-use as specified. More...
 
 UPtrList (PtrList< T > &list)
 Shallow copy from PtrList. More...
 
 UPtrList (const UList< T * > &list)
 Construct from UList of pointers (shallow copy) More...
 
 UPtrList (UList< T > &list)
 Construct from UList, taking the address of each list element. More...
 
label size () const noexcept
 The number of elements in the list. More...
 
bool empty () const noexcept
 True if the list is empty (ie, size() is zero) More...
 
Tfirst ()
 Return reference to the first element of the list. More...
 
const Tfirst () const
 Return reference to first element of the list. More...
 
Tlast ()
 Return reference to the last element of the list. More...
 
const Tlast () const
 Return reference to the last element of the list. More...
 
const Ttest (const label i) const
 
Tget (const label i)
 
const Tget (const label i) const
 
const Tset (const label i) const
 
void clear ()
 Set list size to zero. More...
 
void resize (const label newLen)
 Change the size of the list. More...
 
void setSize (const label n)
 Alias for resize() More...
 
label squeezeNull ()
 Squeeze out intermediate nullptr entries in the list of pointers. More...
 
void append (T *ptr)
 Append an element to the end of the list. More...
 
void append (UPtrList< T > &&other)
 Move append another list to the end of this list. More...
 
void swap (UPtrList< T > &list)
 Swap content. More...
 
void transfer (UPtrList< T > &list)
 Transfer contents into this list and annul the argument. More...
 
Tset (const label i, T *ptr)
 
void reorder (const labelUList &oldToNew, const bool check=false)
 
void sortOrder (const labelUList &order, const bool check=false)
 
void checkNonNull () const
 Check and raise FatalError if any nullptr exists in the list. More...
 
const Toperator[] (const label i) const
 Return const reference to the element. More...
 
Toperator[] (const label i)
 Return reference to the element. More...
 
const Toperator() (const label i) const
 Return const pointer to the element - same as get(). More...
 
void operator= (const UPtrList< T > &list)
 Copy assignment (shallow copies addresses) More...
 
void operator= (UPtrList< T > &&list)
 Move assignment. More...
 
T ** begin_ptr () noexcept
 Iterator to begin of raw pointers traversal (use with caution) More...
 
T ** end_ptr () noexcept
 Iterator beyond end of raw pointers traversal (use with caution) More...
 
iterator begin () noexcept
 Return an iterator to begin of UPtrList traversal. More...
 
iterator end () noexcept
 Return iterator beyond end of UPtrList traversal. More...
 
const_iterator cbegin () const noexcept
 Return const_iterator to begin of UPtrList traversal. More...
 
const_iterator cend () const noexcept
 Return const_iterator beyond end of UPtrList traversal. More...
 
const_iterator begin () const noexcept
 Return const_iterator to begin of UPtrList traversal. More...
 
const_iterator end () const noexcept
 Return const_iterator beyond end of UPtrList traversal. More...
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &io, const bool isTimeObject=false)
 
 regIOobject (const regIOobject &rio)
 Copy construct. More...
 
 regIOobject (const regIOobject &rio, bool registerCopy)
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 
 regIOobject (const IOobject &io, const regIOobject &rio)
 Copy construct with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
bool checkIn ()
 Add object to registry, if not already registered. More...
 
bool checkOut ()
 Remove all file watches and remove object from registry. More...
 
virtual void addWatch ()
 Add file watch on object (if registered and READ_IF_MODIFIED) More...
 
bool registered () const noexcept
 
bool ownedByRegistry () const noexcept
 Is this object owned by the registry? More...
 
bool store ()
 
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...
 
virtual void rename (const word &newName)
 Rename. More...
 
const dictionaryfindMetaData () const noexcept
 Return pointer to meta-data or nullptr. More...
 
dictionarygetMetaData () noexcept
 Get or create meta-data. More...
 
void removeMetaData ()
 Remove meta-data. More...
 
virtual void updateMetaData ()
 Update internal meta-data (eg, prior to writing) More...
 
virtual fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool headerOk ()
 Read and check header info. Does not check the headerClassName. More...
 
IstreamreadStream (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 labelListwatchIndices () const noexcept
 Read access to file-monitoring handles. More...
 
labelListwatchIndices () noexcept
 Write access to file-monitoring handles. More...
 
virtual bool modified () const
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeData (Ostream &) const =0
 Pure virtual writeData function. More...
 
virtual bool writeObject (IOstreamOption streamOpt, const bool valid) const
 Write using stream options. More...
 
virtual bool write (const bool valid=true) const
 Write using setting from DB. More...
 
virtual bool global () const
 Is object global. More...
 
void operator= (const IOobject &io)
 Copy assignment. More...
 
virtual bool writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const
 Write using given format, version and compression. More...
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Declare type-name, virtual type (with debug switch) More...
 
 IOobject (const IOobject &)=default
 Copy construct. More...
 
virtual ~IOobject ()=default
 Destructor. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption rOpt=NO_READ, writeOption wOpt=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 &registry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 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, readOption rOpt, writeOption wOpt)
 Copy construct, resetting read/write options. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
const objectRegistrydb () const noexcept
 Return the local objectRegistry. More...
 
const Timetime () const
 Return Time associated with the objectRegistry. More...
 
const wordname () const noexcept
 Return the object name. More...
 
const wordheaderClassName () const noexcept
 Return name of the class name read from header. More...
 
wordheaderClassName () noexcept
 Return non-constant access to the class name read from header. More...
 
const stringnote () const noexcept
 Return the optional note. More...
 
stringnote () noexcept
 Modifiable access to the optional note. More...
 
virtual void rename (const word &newName)
 Rename the object. More...
 
bool registerObject () const noexcept
 Should object created with this IOobject be registered? More...
 
bool registerObject (bool on) noexcept
 Change registration preference, return previous value. More...
 
bool globalObject () const noexcept
 Is object same for all processors? More...
 
bool globalObject (bool on) noexcept
 Change global-object status, return previous value. More...
 
unsigned labelByteSize () const noexcept
 The sizeof (label) in bytes, possibly read from the header. More...
 
unsigned scalarByteSize () const noexcept
 The sizeof (scalar) in bytes, possibly read from the header. More...
 
bool 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...
 
virtual const dictionaryfindMetaData () const noexcept
 Return pointer to meta-data (if any) or nullptr. More...
 
readOption readOpt () const noexcept
 The read option. More...
 
readOption readOpt (readOption opt) noexcept
 Change the read option, return previous value. More...
 
writeOption writeOpt () const noexcept
 The write option. More...
 
writeOption writeOpt (writeOption opt) noexcept
 Change the write option, return previous value. More...
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const
 Return the Time::rootPath() More...
 
const fileNamecaseName () const
 Return the Time::caseName() More...
 
const fileNameinstance () const noexcept
 Read access to instance path component. More...
 
fileNameinstance () noexcept
 Write access to instance path component. More...
 
const fileNamelocal () const noexcept
 Read access to local path component. More...
 
fileName path () const
 The complete path. More...
 
fileName path (const word &instance, const fileName &local=fileName::null) const
 The complete path with alternative instance and local. More...
 
fileName objectPath () const
 The complete path + object name. More...
 
fileName objectRelPath () const
 The object path relative to the root. More...
 
fileName localFilePath (const word &typeName, const bool search=true) const
 Helper for filePath that searches locally. More...
 
fileName globalFilePath (const word &typeName, const bool search=true) const
 Helper for filePath that searches up if in parallel. More...
 
IOstreamOption parseHeader (const dictionary &headerDict)
 
bool readHeader (Istream &is)
 
bool readHeader (dictionary &headerDict, Istream &is)
 
template<class Type >
bool typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
 Read header (uses typeFilePath to find file) and check its info. More...
 
template<class Type >
void warnNoRereading () const
 Helper: warn that type does not support re-reading. More...
 
bool writeHeader (Ostream &os) const
 Write header with current type() More...
 
bool writeHeader (Ostream &os, const word &objectType) const
 Write header with override of type. More...
 
void writeHeader (dictionary &dict, IOstreamOption streamOpt) const
 
void writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
 
bool good () const noexcept
 Did last readHeader() succeed? More...
 
bool bad () const noexcept
 Did last readHeader() fail? More...
 
InfoProxy< IOobjectinfo () const
 Return info proxy, for printing information to a stream. More...
 
void operator= (const IOobject &io)
 Copy assignment, copies all values (except the registry) More...
 
readOptionreadOpt () noexcept
 Access to the read option. More...
 
writeOptionwriteOpt () noexcept
 Access to the write option. More...
 
boolregisterObject () noexcept
 Access to the register object option. More...
 
boolglobalObject () noexcept
 Access to the global object option. 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)
 

Friends

Ostreamoperator<< (Ostream &, const faBoundaryMesh &)
 

Additional Inherited Members

- Public Types inherited from UPtrList< T >
typedef T value_type
 Type of values the list contains. More...
 
typedef Treference
 A non-const reference to the value_type. More...
 
typedef const Tconst_reference
 A const reference to the value_type. More...
 
- Public Types inherited from IOobject
enum  readOption : char { NO_READ = 0 , MUST_READ = 1 , MUST_READ_IF_MODIFIED = 3 , READ_IF_PRESENT = 4 }
 Enumeration defining the read options. More...
 
enum  writeOption : char { NO_WRITE = 0 , AUTO_WRITE = 0x10 }
 Enumeration defining the write options. More...
 
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...
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *p)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &&ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (refPtr< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (refPtr< Type > &&ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (tmp< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (tmp< Type > &&ptr)
 Transfer pointer ownership to its registry. More...
 
- Static Public Member Functions inherited from IOobject
static bool bannerEnabled () noexcept
 Status of output file banner. More...
 
static bool bannerEnabled (bool on) noexcept
 Enable/disable output file banner. More...
 
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 Split path into instance, local, name components. More...
 
template<class StringType >
static word groupName (StringType base, const word &group)
 Create dot-delimited name.group string. More...
 
static word group (const word &name)
 Return group (extension part of name) More...
 
static word member (const word &name)
 Return member (name without the extension) More...
 
static word scopedName (const std::string &scope, const word &name)
 Create scope:name or scope_name string. More...
 
static IOobject selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
 Return the IOobject, but also consider an alternative file name. More...
 
static OstreamwriteBanner (Ostream &os, const bool noSyntaxHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
static OstreamwriteDivider (Ostream &os)
 Write the standard file section divider. More...
 
static OstreamwriteEndDivider (Ostream &os)
 Write the standard end file divider. More...
 
- Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypesfileCheckTypesNames
 Names for the fileCheckTypes. More...
 
static char scopeSeparator
 Character for scoping object names (':' or '_') More...
 
static fileCheckTypes fileModificationChecking
 Type of file modification checking. More...
 
static float fileModificationSkew
 Time skew (seconds) for file modification checks. More...
 
static int maxFileModificationPolls
 Max number of times to poll for file modification changes. More...
 
- Protected Member Functions inherited from 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 UPtrList< T >
void setAddressableSize (const label n) noexcept
 Adjust addressable size. More...
 
 UPtrList (Detail::PtrListDetail< T > &&ptrs)
 Low-level move construct. More...
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
 Helper: check readOpt flags and read if necessary. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &s)
 Set the object state to bad. More...
 
- Static Protected Member Functions inherited from IOobject
static void writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)
 
static void writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)
 
- Protected Attributes inherited from UPtrList< T >
Detail::PtrListDetail< Tptrs_
 The list of pointers. More...
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

Detailed Description

Finite area boundary mesh.

Source files
Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd.

Definition at line 66 of file faBoundaryMesh.H.

Constructor & Destructor Documentation

◆ faBoundaryMesh() [1/2]

faBoundaryMesh ( const IOobject io,
const faMesh fam 
)

Construct from faMesh.

Definition at line 157 of file faBoundaryMesh.C.

◆ faBoundaryMesh() [2/2]

faBoundaryMesh ( const IOobject io,
const faMesh fam,
const label  size 
)

Construct from faMesh and given size.

Definition at line 171 of file faBoundaryMesh.C.

◆ ~faBoundaryMesh()

~faBoundaryMesh ( )
default

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "faBoundaryMesh"  )

Runtime type information.

◆ mesh()

const faMesh & mesh ( ) const
inlinenoexcept

Return the mesh reference.

Definition at line 129 of file faBoundaryMesh.H.

Referenced by wedgeFaPatch::wedgeFaPatch().

Here is the caller graph for this function:

◆ edgeLabels()

Foam::UPtrList< const Foam::labelUList > edgeLabels ( ) const

Return a list of edgeLabels for each patch.

Definition at line 239 of file faBoundaryMesh.C.

References forAll, patches, UPtrList< T >::set(), and UPtrList< T >::size().

Here is the call graph for this function:

◆ edgeFaces()

Foam::UPtrList< const Foam::labelUList > edgeFaces ( ) const

Return a list of edgeFaces for each patch.

Definition at line 255 of file faBoundaryMesh.C.

References forAll, patches, UPtrList< T >::set(), and UPtrList< T >::size().

Referenced by interfaceTrackingFvMesh::update().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ interfaces()

Foam::lduInterfacePtrsList interfaces ( ) const

Return a list of pointers for each patch with only those pointing to interfaces being set

Definition at line 270 of file faBoundaryMesh.C.

References forAll, patches, UPtrList< T >::set(), and UPtrList< T >::size().

Referenced by dynamicOversetFvMesh::addInterpolation(), dynamicOversetFvMesh::interfaces(), and dynamicOversetFvMesh::updateAddressing().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ nNonProcessor()

Foam::label nNonProcessor ( ) const

The number of patches before the first processor patch.

Definition at line 290 of file faBoundaryMesh.C.

References p, and patches.

Referenced by faMeshSubset::reset().

Here is the caller graph for this function:

◆ names()

Foam::wordList names ( ) const

Return a list of patch names.

Definition at line 365 of file faBoundaryMesh.C.

◆ types()

Foam::wordList types ( ) const

Return a list of patch types.

Definition at line 371 of file faBoundaryMesh.C.

◆ patchStarts()

Foam::labelList patchStarts ( ) const

Return a list of patch start indices.

Definition at line 377 of file faBoundaryMesh.C.

References forAll, patches, and UPtrList< T >::size().

Referenced by Foam::createReconstructMap(), faMeshDistributor::distribute(), and faFieldDecomposer::reset().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ patchSizes()

Foam::labelList patchSizes ( ) const

Return a list of patch sizes (number of edges in each patch)

Definition at line 396 of file faBoundaryMesh.C.

References p.

◆ patchRanges()

Foam::List< Foam::labelRange > patchRanges ( ) const

Return a list of patch ranges.

Definition at line 407 of file faBoundaryMesh.C.

References forAll, patches, and UPtrList< T >::size().

Here is the call graph for this function:

◆ start()

Foam::label start ( ) const

The start label of the edges in the faMesh edges list.

Same as mesh.nInternalEdges()

Definition at line 424 of file faBoundaryMesh.C.

Referenced by faBoundaryMesh::checkDefinition().

Here is the caller graph for this function:

◆ nEdges()

Foam::label nEdges ( ) const

The number of boundary edges for the underlying mesh.

Same as mesh.nBoundaryEdges()

Definition at line 430 of file faBoundaryMesh.C.

◆ range()

Foam::labelRange range ( ) const

The edge range for all boundary edges.

Spans [nInternalEdges, nEdges) of the underlying mesh

Definition at line 436 of file faBoundaryMesh.C.

◆ indices() [1/2]

Foam::labelList indices ( const wordRe matcher,
const bool  useGroups = true 
) const

Return (sorted) patch indices for all matches.

Optionally matches patch groups. A no-op (returns empty list) for an empty matcher

Definition at line 442 of file faBoundaryMesh.C.

References HashTable< T, Key, Hash >::empty(), Foam::PtrListOps::findMatching(), Foam::PtrListOps::firstMatching(), forAllConstIters, HashSet< Key, Hash >::insert(), wordRe::isPattern(), wordRe::match(), patchId(), and HashTable< T, Key, Hash >::sortedToc().

Referenced by faBoundaryMesh::findIndices().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ indices() [2/2]

Foam::labelList indices ( const wordRes matcher,
const bool  useGroups = true 
) const

Return (sorted) patch indices for all matches.

Optionally matches patch groups. A no-op (returns empty list) for an empty matcher

Definition at line 509 of file faBoundaryMesh.C.

References HashTable< T, Key, Hash >::empty(), UList< T >::empty(), Foam::PtrListOps::findMatching(), UList< T >::first(), forAllConstIters, HashSet< Key, Hash >::insert(), wordRes::match(), HashTable< T, Key, Hash >::resize(), UList< T >::size(), and HashTable< T, Key, Hash >::sortedToc().

Here is the call graph for this function:

◆ findIndex()

Foam::label findIndex ( const wordRe 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 555 of file faBoundaryMesh.C.

References Foam::PtrListOps::firstMatching().

Here is the call graph for this function:

◆ findPatchID()

Foam::label findPatchID ( const word patchName,
const bool  allowNotFound = true 
) const

Find patch index given a name, return -1 if not found.

A no-op (returns -1) for an empty name

Definition at line 565 of file faBoundaryMesh.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::PtrListOps::firstMatching(), patchId(), and Foam::Pout.

Referenced by interfaceTrackingFvMesh::update().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ whichPatch()

Foam::label whichPatch ( const label  edgeIndex) const

Return patch index for a given edge label.

Definition at line 604 of file faBoundaryMesh.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, forAll, mesh, primitiveMesh::nEdges(), and nEdges().

Here is the call graph for this function:

◆ groupPatchIDs()

const Foam::HashTable< Foam::labelList > & groupPatchIDs ( ) const

The patch indices per patch group.

Definition at line 311 of file faBoundaryMesh.C.

◆ setGroup()

void setGroup ( const word groupName,
const labelUList patchIDs 
)

Set/add group with patches.

Definition at line 322 of file faBoundaryMesh.C.

References forAll, UList< T >::found(), patches, List< T >::resize(), and UPtrList< T >::size().

Here is the call graph for this function:

◆ checkDefinition()

bool checkDefinition ( const bool  report = false) const

Check boundary definition.

Returns
True if in error.

Definition at line 734 of file faBoundaryMesh.C.

References faBoundaryMesh::checkDefinition(), Foam::endl(), forAll, Foam::Info, InfoInFunction, mesh, IOobject::name(), primitiveMesh::nInternalEdges(), SeriousErrorInFunction, and faBoundaryMesh::start().

Referenced by faMesh::addFaPatches(), and faBoundaryMesh::checkDefinition().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ checkParallelSync()

bool checkParallelSync ( const bool  report = false) const

Check whether all procs have all patches and in same order.

Returns
True if in error.

Definition at line 646 of file faBoundaryMesh.C.

References Foam::endl(), forAll, globalIndex::gather(), Foam::Info, splitCell::master(), IOobject::name(), UPstream::parRun(), Foam::Pout, procAddr(), globalIndex::range(), Foam::reduce(), List< T >::resize(), UPtrList< T >::size(), UList< T >::slice(), and globalIndex::subProcs().

Here is the call graph for this function:

◆ calcGeometry()

void calcGeometry ( )

Calculate the geometry for the patches.

(transformation tensors etc.)

Definition at line 186 of file faBoundaryMesh.C.

References UPstream::blocking, PstreamBuffers::commsType(), UPstream::defaultCommsType, PstreamBuffers::finishedSends(), forAll, polyMesh::globalData(), mesh, UPstream::nonBlocking, globalMeshData::patchSchedule(), and UPstream::scheduled.

Referenced by cyclicFaPatch::calcGeometry(), cyclicACMIPolyPatch::calcGeometry(), mappedPolyPatch::calcGeometry(), mappedWallPolyPatch::calcGeometry(), processorCyclicPolyPatch::calcGeometry(), processorFaPatch::movePoints(), processorPolyPatch::movePoints(), and faMesh::updateMesh().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ movePoints()

void movePoints ( const pointField p)

Correct faBoundaryMesh after moving points.

Definition at line 781 of file faBoundaryMesh.C.

References UPstream::blocking, PstreamBuffers::commsType(), UPstream::defaultCommsType, PstreamBuffers::finishedSends(), forAll, polyMesh::globalData(), mesh, UPstream::nonBlocking, p, globalMeshData::patchSchedule(), and UPstream::scheduled.

Here is the call graph for this function:

◆ updateMesh()

void updateMesh ( )

Correct faBoundaryMesh after topology update.

Definition at line 833 of file faBoundaryMesh.C.

References UPstream::blocking, PstreamBuffers::commsType(), UPstream::defaultCommsType, PstreamBuffers::finishedSends(), forAll, polyMesh::globalData(), mesh, UPstream::nonBlocking, globalMeshData::patchSchedule(), and UPstream::scheduled.

Referenced by faMesh::updateMesh().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ writeData()

bool writeData ( Ostream os) const
virtual

The writeData member function required by regIOobject.

Implements regIOobject.

Definition at line 879 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(), IOobject::name(), Foam::nl, os(), p, patches, UPtrList< T >::size(), and faBoundaryMesh::writeData().

Referenced by Foam::operator<<(), and faBoundaryMesh::writeData().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ writeObject()

bool writeObject ( IOstreamOption  streamOpt,
const bool  valid 
) const
virtual

Write using stream options.

Reimplemented from regIOobject.

Definition at line 899 of file faBoundaryMesh.C.

References regIOobject::writeObject().

Here is the call graph for this function:

◆ findIndices()

labelList findIndices ( const wordRe key,
bool  useGroups = true 
) const
inline

Identical to the indices() method (AUG-2018)

Definition at line 255 of file faBoundaryMesh.H.

References faBoundaryMesh::indices().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator<<

Ostream & operator<< ( Ostream ,
const faBoundaryMesh  
)
friend

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