processorFaPatch Class Reference

Processor patch. More...

Inheritance diagram for processorFaPatch:
Collaboration diagram for processorFaPatch:

Public Member Functions

 TypeName ("processor")
 Runtime type information. More...
 
 processorFaPatch (const labelUList &edgeLabels, const label index, const faBoundaryMesh &bm, const label nbrPolyPatchi, const label myProcNo, const label neighbProcNo, const word &patchType=typeName)
 Construct from components with automatically generated standard name. More...
 
 processorFaPatch (const word &name, const dictionary &dict, const label index, const faBoundaryMesh &bm, const word &patchType=typeName)
 Construct from dictionary. More...
 
virtual ~processorFaPatch ()
 Destructor. More...
 
virtual label interfaceSize () const noexcept
 Return interface size. More...
 
int myProcNo () const noexcept
 Return processor number. More...
 
int neighbProcNo () const noexcept
 Return neighbour processor number. More...
 
virtual bool coupled () const
 Return true if running parallel. More...
 
virtual bool owner () const noexcept
 Does this side own the patch ? More...
 
virtual int tag () const
 The message tag to use for communication. More...
 
virtual label comm () const
 Return communicator used for communication. More...
 
virtual const tensorFieldforwardT () const
 Return face transformation tensor. More...
 
virtual tmp< vectorFielddelta () const
 Return delta (P to N) vectors across coupled patch. More...
 
const vectorFieldneighbEdgeCentres () const noexcept
 Return processor-neighbour patch edge centres. More...
 
const vectorFieldneighbEdgeLengths () const noexcept
 Return processor-neighbour patch edge lengths. More...
 
tmp< vectorFieldneighbEdgeNormals () const
 Return processor-neighbour patch edge unit normals. More...
 
const vectorFieldneighbEdgeFaceCentres () const noexcept
 Return processor-neighbour patch neighbour face centres. More...
 
const labelListneighbPoints () const
 Return neighbour point labels. This is for my local point the. More...
 
const labelListnonGlobalPatchPoints () const
 Return the set of labels of the processor patch points which are. More...
 
virtual tmp< labelFieldinterfaceInternalField (const labelUList &internalData) const
 Return the values of the given internal data adjacent to the interface as a field. More...
 
virtual tmp< labelFieldinterfaceInternalField (const labelUList &internalData, const labelUList &edgeFaces) const
 Return the values of the given internal data adjacent to the interface as a field using edgeFaces. More...
 
virtual void initTransfer (const Pstream::commsTypes commsType, const labelUList &interfaceData) const
 Initialise interface data transfer. More...
 
virtual tmp< labelFieldtransfer (const Pstream::commsTypes commsType, const labelUList &interfaceData) const
 Transfer and return neighbour field. More...
 
virtual void initInternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &internalData) const
 Initialise neighbour field transfer. More...
 
virtual tmp< labelFieldinternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &internalData) const
 Return neighbour field. More...
 
virtual tmp< labelFieldinternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &internalData, const labelUList &edgeCells) const
 Return neighbour field using mapping. More...
 
virtual void write (Ostream &os) const
 Write the patch data as a dictionary. More...
 
- Public Member Functions inherited from coupledFaPatch
 TypeNameNoDebug ("coupled")
 Runtime type information. More...
 
 coupledFaPatch (const word &name, const labelList &edgeLabels, const label index, const faBoundaryMesh &bm, const label nbrPolyPatchIndex, const word &patchType)
 Construct from components. More...
 
 coupledFaPatch (const word &name, const dictionary &dict, const label index, const faBoundaryMesh &bm, const word &patchType)
 Construct from dictionary. More...
 
virtual ~coupledFaPatch ()=default
 Destructor. More...
 
virtual bool neighbour () const
 Does the coupled side own the patch ? More...
 
virtual label referPatchID () const
 The referring patchID (eg, for cyclics). More...
 
bool separated () const
 Are the coupled planes separated? More...
 
const vectorFieldseparation () const
 Return the offset (distance) vector from one side of the couple. More...
 
const tensorFieldforwardT () const
 Return face transformation tensor. More...
 
const tensorFieldreverseT () const
 Return neighbour-cell transformation tensor. More...
 
bool parallel () const
 Are the cyclic planes parallel. More...
 
virtual const labelUListfaceCells () const
 Return faceCell addressing: lduInterface virtual function. More...
 
- Public Member Functions inherited from lduInterface
 TypeNameNoDebug ("lduInterface")
 Runtime type information. More...
 
 lduInterface () noexcept=default
 Default construct. More...
 
virtual ~lduInterface ()=default
 Destructor. More...
 
virtual void initInternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &iF, const labelUList &faceCells) const
 Initialise transfer of internal field adjacent to the interface using faceCells mapping. More...
 
- Public Member Functions inherited from faPatch
 TypeName ("patch")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, faPatch, dictionary,(const word &name, const dictionary &dict, const label index, const faBoundaryMesh &bm, const word &patchType),(name, dict, index, bm, patchType))
 
 faPatch (const word &name, const labelUList &edgeLabels, const label index, const faBoundaryMesh &bm, const label nbrPolyPatchi, const word &patchType)
 Construct from components. More...
 
 faPatch (const word &name, const dictionary &dict, const label index, const faBoundaryMesh &bm, const word &patchType)
 Construct from dictionary. More...
 
 faPatch (const faPatch &p, const faBoundaryMesh &bm)
 Copy construct, resetting the boundary mesh. More...
 
 faPatch (const faPatch &p, const faBoundaryMesh &bm, const label index, const labelUList &edgeLabels, const label nbrPolyPatchi)
 Copy construct, resetting boundary mesh and addressing. More...
 
virtual autoPtr< faPatchclone (const faBoundaryMesh &bm) const
 Construct and return a clone, resetting the boundary mesh. More...
 
virtual autoPtr< faPatchclone (const faBoundaryMesh &bm, const labelUList &edgeLabels, const label index, const label nbrPolyPatchi) const
 Construct and return a clone, resetting the edge list and boundary mesh. More...
 
virtual ~faPatch ()
 Destructor. More...
 
const labelListedgeLabels () const noexcept
 Return the list of edges. More...
 
label nPoints () const
 Number of patch points. More...
 
label nEdges () const noexcept
 Number of edge labels (boundary edges) addressed by this patch. More...
 
label ngbPolyPatchIndex () const noexcept
 The neighbour polyPatch index. More...
 
const faBoundaryMeshboundaryMesh () const noexcept
 Return boundaryMesh reference. More...
 
label offset () const
 The offset where this patch starts in the boundary edge list. More...
 
label start () const
 Patch start in edge list. More...
 
virtual label size () const
 Patch size is the number of edge labels, but can be overloaded. More...
 
label whichEdge (const label edgei) const
 Return label of edge in patch from global edge label. More...
 
template<class T >
const List< T >::subList patchSlice (const List< T > &values) const
 This patch slice from the complete list of values, which has size mesh::nEdges(), using the virtual patch size. More...
 
template<class T >
const List< T >::subList boundarySlice (const List< T > &values) const
 This patch slice from the list of boundary values, which has size mesh::nBoundaryEdges(), using the virtual patch size. More...
 
List< labelPairboundaryConnections () const
 List of proc/face for the boundary edge neighbours in locally reordered edge numbering. More...
 
labelList boundaryProcs () const
 Boundary edge neighbour processors (does not include own proc) More...
 
List< labelPairboundaryProcSizes () const
 List of proc/size for the boundary edge neighbour processors (does not include own proc) More...
 
const labelListpointLabels () const
 Return patch point labels. More...
 
const labelListListpointEdges () const
 Return patch point-edge addressing. More...
 
tmp< vectorFieldngbPolyPatchFaceNormals () const
 Return normals of neighbour polyPatch faces. More...
 
tmp< vectorFieldngbPolyPatchPointNormals () const
 Return normals of neighbour polyPatch joined points. More...
 
const labelUListedgeFaces () const
 Return edge-face addressing. More...
 
const vectorFieldedgeCentres () const
 Return edge centres. More...
 
const vectorFieldedgeLengths () const
 Return edge length vectors, like the faMesh::Le() method. More...
 
const scalarFieldmagEdgeLengths () const
 Return edge length magnitudes, like the faMesh::magLe() method. More...
 
tmp< vectorFieldedgeNormals () const
 Return edge unit normals, like the faMesh::unitLe() method. More...
 
tmp< vectorFieldedgeFaceCentres () const
 Return neighbour face centres. More...
 
const scalarFieldweights () const
 Return patch weighting factors. More...
 
void makeCorrectionVectors (vectorField &) const
 
const scalarFielddeltaCoeffs () const
 Return patch edge - neighbour face distances. More...
 
void resetEdges (const labelUList &newEdges)
 Reset the list of edges (use with caution) More...
 
void resetEdges (labelList &&newEdges)
 Reset the list of edges (use with caution) More...
 
template<class Type >
void patchInternalField (const UList< Type > &internalData, const labelUList &addressing, Field< Type > &pfld) const
 Extract internal field next to patch using specified addressing. More...
 
template<class Type >
void patchInternalField (const UList< Type > &internalData, Field< Type > &pfld) const
 Extract internal field next to patch as patch field using edgeFaces() mapping. More...
 
template<class Type >
tmp< Field< Type > > patchInternalField (const UList< Type > &internalData) const
 Return given internal field next to patch as patch field using edgeFaces() mapping. More...
 
template<class GeometricField , class AnyType = bool>
const GeometricField::PatchpatchField (const GeometricField &gf) const
 Return the patch field of the GeometricField corresponding to this patch. More...
 
template<class GeometricField , class AnyType = bool>
const GeometricField::PatchlookupPatchField (const word &name, const GeometricField *=nullptr, const AnyType *=nullptr) const
 Lookup the named field from the local registry and return the patch field corresponding to this patch. More...
 
template<class Type >
Foam::tmp< Foam::Field< Type > > patchInternalField (const UList< Type > &internalData) const
 
- Public Member Functions inherited from patchIdentifier
 patchIdentifier (const patchIdentifier &)=default
 Copy construct. More...
 
 patchIdentifier (patchIdentifier &&)=default
 Move construct. More...
 
patchIdentifieroperator= (const patchIdentifier &)=default
 Copy assignment. More...
 
patchIdentifieroperator= (patchIdentifier &&)=default
 Move assignment. More...
 
virtual ~patchIdentifier ()=default
 Destructor. More...
 
 patchIdentifier ()
 Default construct: name="", index=0. More...
 
 patchIdentifier (const word &name, const label index)
 Construct from mandatory components. More...
 
 patchIdentifier (const word &name, const label index, const word &physicalType, const wordList &inGroups=wordList())
 Construct from components. More...
 
 patchIdentifier (const word &name, const dictionary &dict, const label index)
 Construct from dictionary. More...
 
 patchIdentifier (const patchIdentifier &ident, const label newIndex)
 Copy construct, resetting the index (if non-negative) More...
 
 patchIdentifier (patchIdentifier &&ident, const label newIndex)
 Move construct, resetting the index (if non-negative) More...
 
const wordname () const noexcept
 The patch name. More...
 
wordname () noexcept
 Modifiable patch name. More...
 
label index () const noexcept
 The index of this patch in the boundaryMesh. More...
 
label & index () noexcept
 Modifiable index of this patch in the boundaryMesh. More...
 
const wordphysicalType () const noexcept
 The (optional) physical type of the patch. More...
 
wordphysicalType () noexcept
 Modifiable (optional) physical type of the patch. More...
 
const wordListinGroups () const noexcept
 The (optional) groups that the patch belongs to. More...
 
wordListinGroups () noexcept
 Modifiable (optional) groups that the patch belongs to. More...
 
bool inGroup (const word &name) const
 True if given name is in a group. More...
 
void addGroup (const word &name)
 Add (unique) group for the patch. More...
 
void removeGroup (const word &name)
 Remove group for the patch. More...
 
void write (Ostream &os) const
 Write (physicalType, inGroups) dictionary entries (without surrounding braces) More...
 
- Public Member Functions inherited from List< label >
constexpr List () noexcept
 Default construct. More...
 
 List (const label len)
 Construct with given size. More...
 
 List (const label len, const label &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 label &val)
 Construct with length=1, copying the value as the only content. More...
 
 List (const Foam::one, label &&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< label > &list)
 Copy construct from list. More...
 
 List (const UList< label > &list)
 Copy construct contents from list. More...
 
 List (List< label > &list, bool reuse)
 Construct as copy or re-use as specified. More...
 
 List (const UList< label > &list, const labelUList &indices)
 Copy construct subset of list. More...
 
 List (const UList< label > &list, const FixedList< label, N > &indices)
 Copy construct subset of list. More...
 
 List (const FixedList< label, N > &list)
 Construct as copy of FixedList<T, N> More...
 
 List (const PtrList< label > &list)
 Construct as copy of PtrList<T> More...
 
 List (const IndirectListBase< label, Addr > &list)
 Construct as copy of IndirectList contents. More...
 
 List (std::initializer_list< label > list)
 Construct from an initializer list. More...
 
 List (List< label > &&list) noexcept
 Move construct from List. More...
 
 List (DynamicList< label, SizeMin > &&list)
 Move construct from DynamicList. More...
 
 List (Istream &is)
 Construct from Istream. More...
 
 List (const SLList< label > &list)
 Copy construct from SLList. More...
 
autoPtr< List< label > > 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 label &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 label &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 label &val)
 Alias for resize() More...
 
void transfer (List< label > &list)
 Transfer the contents of the argument List into this list and annul the argument list. More...
 
void transfer (DynamicList< label, SizeMin > &list)
 Transfer the contents of the argument List into this list and annul the argument list. More...
 
label & newElmt (const label i)
 Return subscript-checked element of UList and resizing the list if required. More...
 
label & 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 label &val)
 Append an element at the end of the list. More...
 
void push_back (label &&val)
 Move append an element at the end of the list. More...
 
void push_back (const UList< label > &list)
 Append a List to the end of this list. More...
 
void push_back (const IndirectListBase< label, Addr > &list)
 Append IndirectList contents at the end of this list. More...
 
label push_uniq (const label &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< label > &list)
 Assignment to UList operator. Takes linear time. More...
 
void operator= (const List< label > &list)
 Assignment operator. Takes linear time. More...
 
void operator= (const IndirectListBase< label, Addr > &list)
 Assignment from IndirectList. Takes linear time. More...
 
void operator= (const FixedList< label, N > &list)
 Copy assignment from FixedList. More...
 
void operator= (std::initializer_list< label > list)
 Assignment to an initializer list. More...
 
void operator= (const label &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< label > &&list)
 Move assignment. Takes constant time. More...
 
void operator= (DynamicList< label, SizeMin > &&list)
 Move assignment. Takes constant time. More...
 
void operator= (const SLList< label > &list)
 Copy assign from SLList in linear time. More...
 
IstreamreadList (Istream &is)
 Read List from Istream, discarding contents of existing List. More...
 
void shallowCopy (const UList< label > &)=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 label &val)
 Append an element at the end of the list. More...
 
void append (label &&val)
 Move append an element at the end of the list. More...
 
void append (const UList< label > &list)
 Append a List to the end of this list. More...
 
void append (const IndirectListBase< label, Addr > &list)
 Append IndirectList contents at the end of this list. More...
 
label appendUniq (const label &val)
 Same as push_uniq() More...
 
- Public Member Functions inherited from UList< label >
label size () const noexcept
 The number of elements in the container. More...
 
void writeEntry (const word &keyword, Ostream &os) const
 Write the List as a dictionary entry with keyword. More...
 
void operator= (const label &val)
 Assignment of all entries to the given value. More...
 
void operator= (const Foam::zero)
 Assignment of all entries to zero. More...
 
 UList (const UList< label > &)=default
 Copy construct. More...
 
constexpr UList () noexcept
 Default construct, zero-sized and nullptr. More...
 
 UList (label *__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 label & fcValue (const label i) const
 Return forward circular value (ie, next value in the list) More...
 
label & fcValue (const label i)
 Return forward circular value (ie, next value in the list) More...
 
const label & rcValue (const label i) const
 Return reverse circular value (ie, previous value in the list) More...
 
label & rcValue (const label i)
 Return reverse circular value (ie, previous value in the list) More...
 
const label * cdata () const noexcept
 Return pointer to the underlying array serving as data storage. More...
 
label * 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...
 
label & front ()
 Access first element of the list, position [0]. More...
 
const label & front () const
 Access first element of the list. More...
 
label & back ()
 Access last element of the list, position [size()-1]. More...
 
const label & 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 label &val) const
 True if the value is contained in the list. More...
 
bool contains (const label &val, label pos, label len=-1) const
 Is the value contained in the list? More...
 
label find (const label &val) const
 Find index of the first occurrence of the value. More...
 
label find (const label &val, label pos, label len=-1) const
 Find index of the first occurrence of the value. More...
 
label rfind (const label &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 (label *__restrict__ ptr, const label len) noexcept
 Copy the pointer and size. More...
 
void shallowCopy (const UList< label > &list) noexcept
 Copy the pointer and size held by the given UList. More...
 
void deepCopy (const UList< label > &list)
 Copy elements of the given UList. Sizes must match! More...
 
void deepCopy (const IndirectListBase< label, Addr > &list)
 Copy elements of the given indirect list. Sizes must match! More...
 
SubList< label > slice (const label pos, label len=-1)
 Return SubList slice (non-const access) - no range checking. More...
 
const SubList< label > slice (const label pos, label len=-1) const
 Return SubList slice (const access) - no range checking. More...
 
SubList< label > slice (const labelRange &range)
 Return SubList slice (non-const access) - with range checking. More...
 
const SubList< label > slice (const labelRange &range) const
 Return SubList slice (const access) - with range checking. More...
 
label & operator[] (const label i)
 Return element of UList. More...
 
const label & operator[] (const label i) const
 Return element of constant UList. More...
 
const bool & operator[] (const label i) const
 
UPstream::commsStructoperator[] (const label procID)
 
const UPstream::commsStructoperator[] (const label procID) const
 
Foam::UPstream::commsStructoperator[] (const label procID)
 
const Foam::UPstream::commsStructoperator[] (const label procID) const
 
 operator const Foam::List< label > & () const
 Allow cast to a const List<T>&. More...
 
iterator begin () noexcept
 Return an iterator to begin 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 begin () const noexcept
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator begin (const label i) const noexcept
 Return const_iterator at offset i from begin, clamped to [0,size] range. More...
 
iterator end () noexcept
 Return an iterator to end traversing the UList. More...
 
const_iterator end () const noexcept
 Return const_iterator to end traversing the constant UList. More...
 
const_iterator cbegin () const noexcept
 Return const_iterator to begin 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 cend () const noexcept
 Return const_iterator to end traversing the constant UList. More...
 
reverse_iterator rbegin ()
 Return reverse_iterator to begin reverse traversing the UList. More...
 
const_reverse_iterator rbegin () const
 Return const_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 rend () const
 Return const_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...
 
bool empty () const noexcept
 True if List is empty (ie, size() is zero) More...
 
label capacity () const noexcept
 Size of the underlying storage. More...
 
void swap (UList< label > &list) noexcept
 Swap content with another UList of the same type in constant time. More...
 
bool operator== (const UList< label > &list) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UList< label > &list) const
 The opposite of the equality operation. Takes linear time. More...
 
bool operator< (const UList< label > &list) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator> (const UList< label > &list) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator<= (const UList< label > &list) const
 Return true if !(a > b). Takes linear time. More...
 
bool operator>= (const UList< label > &list) const
 Return true if !(a < b). Takes linear time. More...
 
IstreamreadList (Istream &is)
 Read List contents from Istream. More...
 
OstreamwriteList (Ostream &os, const label shortLen=0) const
 Write List, with line-breaks in ASCII when length exceeds shortLen. More...
 
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...
 
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...
 
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...
 
label & first ()
 Access first element of the list, position [0]. More...
 
const label & first () const
 Access first element of the list. More...
 
label & last ()
 Access last element of the list, position [size()-1]. More...
 
const label & last () const
 Access last element of the list, position [size()-1]. More...
 
bool found (const label &val, label pos=0) const
 Same as contains() More...
 
- Public Member Functions inherited from processorLduInterface
 TypeNameNoDebug ("processorLduInterface")
 Runtime type information. More...
 
 processorLduInterface () noexcept=default
 Default construct. More...
 
virtual ~processorLduInterface ()=default
 Destructor. More...
 
template<class Type >
void send (const UPstream::commsTypes commsType, const UList< Type > &f) const
 Raw send function. More...
 
template<class Type >
void receive (const UPstream::commsTypes commsType, UList< Type > &f) const
 Raw receive function. More...
 
template<class Type >
tmp< Field< Type > > receive (const UPstream::commsTypes commsType, const label size) const
 Raw receive function returning field. More...
 
template<class Type >
void compressedSend (const UPstream::commsTypes commsType, const UList< Type > &f) const
 Raw send function with data compression. More...
 
template<class Type >
void compressedReceive (const UPstream::commsTypes commsType, UList< Type > &f) const
 Raw receive function with data compression. More...
 
template<class Type >
tmp< Field< Type > > compressedReceive (const UPstream::commsTypes commsType, const label size) const
 Raw receive function with data compression returning field. More...
 
template<class Type >
Foam::tmp< Foam::Field< Type > > receive (const UPstream::commsTypes commsType, const label size) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > compressedReceive (const UPstream::commsTypes commsType, const label size) const
 

Protected Member Functions

 processorFaPatch (const word &name, const labelUList &edgeLabels, const label index, const faBoundaryMesh &bm, const label nbrPolyPatchi, const label myProcNo, const label neighbProcNo, const word &patchType=typeName)
 Construct from components with specified name. More...
 
void makeWeights (scalarField &) const
 Make patch weighting factors. More...
 
void makeDeltaCoeffs (scalarField &) const
 Make patch face - neighbour cell distances. More...
 
void makeNonGlobalPatchPoints () const
 Find non-globa patch points. More...
 
void initGeometry (PstreamBuffers &)
 Initialise the calculation of the patch geometry. More...
 
void calcGeometry (PstreamBuffers &)
 Calculate the patch geometry. More...
 
void initMovePoints (PstreamBuffers &, const pointField &)
 Initialise the patches for moving points. More...
 
void movePoints (PstreamBuffers &, const pointField &)
 Correct patches after moving points. More...
 
virtual void initUpdateMesh (PstreamBuffers &)
 Initialise the update of the patch topology. More...
 
virtual void updateMesh (PstreamBuffers &)
 Update of the patch topology. More...
 
- Protected Member Functions inherited from coupledFaPatch
void calcTransformTensors (const vector &Cf, const vector &Cr, const vector &nf, const vector &nr) const
 Calculate the uniform transformation tensors. More...
 
void calcTransformTensors (const vectorField &Cf, const vectorField &Cr, const vectorField &nf, const vectorField &nr) const
 Calculate the transformation tensors. More...
 
- Protected Member Functions inherited from faPatch
void calcPointLabels () const
 Calculate patch point labels. More...
 
void calcPointEdges () const
 Calculate patch point-edge addressing. More...
 
- Protected Member Functions inherited from UList< label >
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...
 
void writeEntry (Ostream &os) const
 Character list writeEntry. More...
 
void writeEntry (Ostream &os) const
 
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 label &val)
 Assign all entries to the given value. More...
 
void fill_uniform (const Foam::zero)
 Assign all entries to zero. More...
 
UList< label > & operator= (const UList< label > &)=delete
 No copy assignment (default: shallow copy) More...
 
void operator= (const Foam::zero)
 Character list assign zero - avoids Foam::zero casting ambiguities. More...
 
void operator= (const Foam::zero)
 

Additional Inherited Members

- Public Types inherited from faPatch
typedef faBoundaryMesh BoundaryMesh
 The boundary type associated with the patch. More...
 
- Public Types inherited from List< label >
typedef SubList< label > subList
 Declare type of subList. More...
 
- Public Types inherited from UList< label >
typedef label value_type
 The value type the list contains. More...
 
typedef label * pointer
 The pointer type for non-const access to value_type items. More...
 
typedef const label * const_pointer
 The pointer type for const access to value_type items. More...
 
typedef label & reference
 The type used for storing into value_type objects. More...
 
typedef const label & const_reference
 The type used for reading from constant value_type objects. More...
 
typedef label * iterator
 Random access iterator for traversing a UList. More...
 
typedef const label * 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< iteratorreverse_iterator
 Reverse iterator (non-const access) More...
 
typedef std::reverse_iterator< const_iteratorconst_reverse_iterator
 Reverse iterator (const access) More...
 
- Static Public Member Functions inherited from faPatch
static autoPtr< faPatchNew (const word &name, const dictionary &dict, const label index, const faBoundaryMesh &bm)
 Return pointer to a new patch created on freestore from dictionary. More...
 
static autoPtr< faPatchNew (const word &patchType, const word &name, const dictionary &dict, const label index, const faBoundaryMesh &bm)
 Return pointer to a new patch created on freestore from dictionary. More...
 
static bool constraintType (const word &patchType)
 Return true if the given type is a constraint type. More...
 
static wordList constraintTypes ()
 Return a list of all the constraint patch types. More...
 
- Static Public Member Functions inherited from patchIdentifier
static word defaultName (const label n=-1)
 Default patch name: "patch" or "patchN". More...
 
- Static Public Member Functions inherited from List< label >
static const List< label > & null ()
 Return a null List. More...
 
- Static Public Member Functions inherited from UList< label >
static const UList< label > & null ()
 Return a UList reference to a nullObject. More...
 
static constexpr label max_size () noexcept
 The size of the largest possible UList. More...
 

Detailed Description

Processor patch.

Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd.

Source files

Definition at line 52 of file processorFaPatch.H.

Constructor & Destructor Documentation

◆ processorFaPatch() [1/3]

processorFaPatch ( const word name,
const labelUList edgeLabels,
const label  index,
const faBoundaryMesh bm,
const label  nbrPolyPatchi,
const label  myProcNo,
const label  neighbProcNo,
const word patchType = typeName 
)
protected

Construct from components with specified name.

Definition at line 50 of file processorFaPatch.C.

◆ processorFaPatch() [2/3]

processorFaPatch ( const labelUList edgeLabels,
const label  index,
const faBoundaryMesh bm,
const label  nbrPolyPatchi,
const label  myProcNo,
const label  neighbProcNo,
const word patchType = typeName 
)

Construct from components with automatically generated standard name.

Definition at line 73 of file processorFaPatch.C.

◆ processorFaPatch() [3/3]

processorFaPatch ( const word name,
const dictionary dict,
const label  index,
const faBoundaryMesh bm,
const word patchType = typeName 
)

Construct from dictionary.

Definition at line 98 of file processorFaPatch.C.

◆ ~processorFaPatch()

~processorFaPatch ( )
virtual

Destructor.

Definition at line 40 of file processorFaPatch.C.

Member Function Documentation

◆ makeWeights()

void makeWeights ( scalarField w) const
protectedvirtual

Make patch weighting factors.

Implements coupledFaPatch.

Definition at line 391 of file processorFaPatch.C.

References coupledFaPatch::delta(), and UPstream::parRun().

Here is the call graph for this function:

◆ makeDeltaCoeffs()

void makeDeltaCoeffs ( scalarField dc) const
protectedvirtual

Make patch face - neighbour cell distances.

Implements coupledFaPatch.

Definition at line 415 of file processorFaPatch.C.

References coupledFaPatch::delta(), and UPstream::parRun().

Here is the call graph for this function:

◆ makeNonGlobalPatchPoints()

void makeNonGlobalPatchPoints ( ) const
protected

Find non-globa patch points.

Definition at line 125 of file processorFaPatch.C.

References forAll, UList< T >::found(), Foam::identity(), boundaryMesh::mesh(), PrimitivePatch< FaceList, PointField >::meshPoints(), nPoints, UPstream::parRun(), pointLabels(), and List< T >::resize().

Here is the call graph for this function:

◆ initGeometry()

void initGeometry ( PstreamBuffers pBufs)
protectedvirtual

Initialise the calculation of the patch geometry.

Implements coupledFaPatch.

Definition at line 170 of file processorFaPatch.C.

References edgeCentres(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::name(), Foam::nl, PstreamBuffers::nProcs(), and UPstream::parRun().

Here is the call graph for this function:

◆ calcGeometry()

void calcGeometry ( PstreamBuffers pBufs)
protectedvirtual

Calculate the patch geometry.

Implements coupledFaPatch.

Definition at line 194 of file processorFaPatch.C.

References Foam::constant::electromagnetic::e, edgeCentres(), forAll, Foam::mag(), Foam::nl, UPstream::parRun(), and WarningInFunction.

Referenced by processorFaPatch::movePoints().

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

◆ initMovePoints()

void initMovePoints ( PstreamBuffers pBufs,
const pointField p 
)
protectedvirtual

Initialise the patches for moving points.

Implements coupledFaPatch.

Definition at line 238 of file processorFaPatch.C.

References faPatch::movePoints(), and p.

Here is the call graph for this function:

◆ movePoints()

void movePoints ( PstreamBuffers pBufs,
const pointField  
)
protectedvirtual

Correct patches after moving points.

Implements coupledFaPatch.

Definition at line 249 of file processorFaPatch.C.

References processorFaPatch::calcGeometry().

Here is the call graph for this function:

◆ initUpdateMesh()

void initUpdateMesh ( PstreamBuffers pBufs)
protectedvirtual

Initialise the update of the patch topology.

Reimplemented from faPatch.

Definition at line 258 of file processorFaPatch.C.

References Foam::constant::electromagnetic::e, Foam::exit(), Foam::FatalError, FatalErrorInFunction, faPatch::initUpdateMesh(), mesh, Foam::name(), Foam::nl, nPoints, PstreamBuffers::nProcs(), UPstream::parRun(), and pointLabels().

Here is the call graph for this function:

◆ updateMesh()

void updateMesh ( PstreamBuffers pBufs)
protectedvirtual

Update of the patch topology.

Reimplemented from faPatch.

Definition at line 306 of file processorFaPatch.C.

References Foam::constant::electromagnetic::e, UList< T >::find(), forAll, mesh, nPoints, UPstream::parRun(), pointLabels(), UList< T >::size(), and faPatch::updateMesh().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "processor"  )

Runtime type information.

◆ interfaceSize()

virtual label interfaceSize ( ) const
inlinevirtualnoexcept

Return interface size.

Definition at line 215 of file processorFaPatch.H.

References faPatch::size().

Here is the call graph for this function:

◆ myProcNo()

int myProcNo ( ) const
inlinevirtualnoexcept

Return processor number.

Implements processorLduInterface.

Definition at line 223 of file processorFaPatch.H.

Referenced by processorFaPatchField< Type >::myProcNo().

Here is the caller graph for this function:

◆ neighbProcNo()

int neighbProcNo ( ) const
inlinevirtualnoexcept

Return neighbour processor number.

Implements processorLduInterface.

Definition at line 231 of file processorFaPatch.H.

Referenced by processorFaPatchField< Type >::neighbProcNo().

Here is the caller graph for this function:

◆ coupled()

virtual bool coupled ( ) const
inlinevirtual

Return true if running parallel.

Reimplemented from coupledFaPatch.

Definition at line 239 of file processorFaPatch.H.

References UPstream::parRun().

Here is the call graph for this function:

◆ owner()

virtual bool owner ( ) const
inlinevirtualnoexcept

Does this side own the patch ?

Implements coupledFaPatch.

Definition at line 247 of file processorFaPatch.H.

◆ tag()

virtual int tag ( ) const
inlinevirtual

The message tag to use for communication.

Implements processorLduInterface.

Definition at line 256 of file processorFaPatch.H.

References UPstream::msgType().

Here is the call graph for this function:

◆ comm()

Foam::label comm ( ) const
virtual

Return communicator used for communication.

Implements processorLduInterface.

Definition at line 119 of file processorFaPatch.C.

References boundaryMesh::mesh().

Referenced by processorFaPatchField< Type >::comm().

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

◆ forwardT()

virtual const tensorField& forwardT ( ) const
inlinevirtual

Return face transformation tensor.

Implements processorLduInterface.

Definition at line 270 of file processorFaPatch.H.

References coupledFaPatch::forwardT().

Referenced by processorFaPatchField< Type >::forwardT().

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

◆ delta()

Foam::tmp< Foam::vectorField > delta ( ) const
virtual

Return delta (P to N) vectors across coupled patch.

Implements coupledFaPatch.

Definition at line 430 of file processorFaPatch.C.

References coupledFaPatch::delta(), UPstream::parRun(), and Foam::transform().

Here is the call graph for this function:

◆ neighbEdgeCentres()

const vectorField& neighbEdgeCentres ( ) const
inlinenoexcept

Return processor-neighbour patch edge centres.

Definition at line 284 of file processorFaPatch.H.

◆ neighbEdgeLengths()

const vectorField& neighbEdgeLengths ( ) const
inlinenoexcept

Return processor-neighbour patch edge lengths.

Definition at line 292 of file processorFaPatch.H.

◆ neighbEdgeNormals()

Foam::tmp< Foam::vectorField > neighbEdgeNormals ( ) const

Return processor-neighbour patch edge unit normals.

Definition at line 360 of file processorFaPatch.C.

References tmp< T >::New().

Here is the call graph for this function:

◆ neighbEdgeFaceCentres()

const vectorField& neighbEdgeFaceCentres ( ) const
inlinenoexcept

Return processor-neighbour patch neighbour face centres.

Definition at line 305 of file processorFaPatch.H.

◆ neighbPoints()

const Foam::labelList & neighbPoints ( ) const

Return neighbour point labels. This is for my local point the.

corresponding local point on the other side. Call faBoundaryMesh::updateMesh() on all processors before using this.

Definition at line 368 of file processorFaPatch.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Foam::name(), and Foam::nl.

Here is the call graph for this function:

◆ nonGlobalPatchPoints()

const Foam::labelList & nonGlobalPatchPoints ( ) const

Return the set of labels of the processor patch points which are.

non-global, i.e. present in this processorFaPatch

Definition at line 465 of file processorFaPatch.C.

◆ interfaceInternalField() [1/2]

Foam::tmp< Foam::labelField > interfaceInternalField ( const labelUList internalData) const
virtual

Return the values of the given internal data adjacent to the interface as a field.

Implements coupledFaPatch.

Definition at line 477 of file processorFaPatch.C.

◆ interfaceInternalField() [2/2]

Foam::tmp< Foam::labelField > interfaceInternalField ( const labelUList internalData,
const labelUList edgeFaces 
) const
virtual

Return the values of the given internal data adjacent to the interface as a field using edgeFaces.

Implements lduInterface.

Definition at line 486 of file processorFaPatch.C.

References tmp< T >::New().

Here is the call graph for this function:

◆ initTransfer()

void initTransfer ( const Pstream::commsTypes  commsType,
const labelUList interfaceData 
) const
virtual

Initialise interface data transfer.

Reimplemented from coupledFaPatch.

Definition at line 498 of file processorFaPatch.C.

◆ transfer()

Foam::tmp< Foam::labelField > transfer ( const Pstream::commsTypes  commsType,
const labelUList interfaceData 
) const
virtual

Transfer and return neighbour field.

Implements coupledFaPatch.

Definition at line 508 of file processorFaPatch.C.

◆ initInternalFieldTransfer()

void initInternalFieldTransfer ( const Pstream::commsTypes  commsType,
const labelUList internalData 
) const
virtual

Initialise neighbour field transfer.

Reimplemented from coupledFaPatch.

Definition at line 518 of file processorFaPatch.C.

◆ internalFieldTransfer() [1/2]

Foam::tmp< Foam::labelField > internalFieldTransfer ( const Pstream::commsTypes  commsType,
const labelUList internalData 
) const
virtual

Return neighbour field.

Implements coupledFaPatch.

Definition at line 528 of file processorFaPatch.C.

◆ internalFieldTransfer() [2/2]

Foam::tmp< Foam::labelField > internalFieldTransfer ( const Pstream::commsTypes  commsType,
const labelUList internalData,
const labelUList edgeCells 
) const
virtual

Return neighbour field using mapping.

Definition at line 538 of file processorFaPatch.C.

◆ write()

void write ( Ostream os) const
virtual

Write the patch data as a dictionary.

Reimplemented from faPatch.

Definition at line 548 of file processorFaPatch.C.

References os(), faPatch::write(), and Ostream::writeEntry().

Here is the call graph for this function:

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