pointZone Class Reference

A subset of mesh points. More...

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

Public Member Functions

 TypeName ("pointZone")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, pointZone, dictionary,(const word &name, const dictionary &dict, const label index, const pointZoneMesh &zm),(name, dict, index, zm))
 
 pointZone (const word &name, const label index, const pointZoneMesh &zm)
 Construct an empty zone. More...
 
 pointZone (const word &name, const labelUList &addr, const label index, const pointZoneMesh &zm)
 Construct from components. More...
 
 pointZone (const word &name, labelList &&addr, const label index, const pointZoneMesh &zm)
 Construct from components, transferring addressing. More...
 
 pointZone (const word &name, const dictionary &dict, const label index, const pointZoneMesh &zm)
 Construct from dictionary. More...
 
 pointZone (const pointZone &origZone, const labelUList &addr, const label index, const pointZoneMesh &zm)
 
 pointZone (const pointZone &origZone, labelList &&addr, const label index, const pointZoneMesh &zm)
 
virtual autoPtr< pointZoneclone (const pointZoneMesh &zm) const
 Construct and return a clone, resetting the zone mesh. More...
 
virtual autoPtr< pointZoneclone (const pointZoneMesh &zm, const label index, const labelUList &addr) const
 
virtual ~pointZone ()=default
 Destructor. More...
 
const pointZoneMeshzoneMesh () const noexcept
 Return reference to the zone mesh. More...
 
label whichPoint (const label globalPointID) const
 Helper function to re-direct to zone::localID(...) More...
 
virtual bool checkDefinition (const bool report=false) const
 Check zone definition. Return true if in error. More...
 
virtual bool checkParallelSync (const bool report=false) const
 Check whether zone is synchronised across coupled boundaries. More...
 
virtual void movePoints (const pointField &)
 Correct patch after moving points. More...
 
virtual void writeDict (Ostream &os) const
 Write dictionary. More...
 
void operator= (const pointZone &zn)
 Assign addressing, clearing demand-driven data. More...
 
void operator= (const labelUList &addr)
 Assign addressing, clearing demand-driven data. More...
 
void operator= (labelList &&addr)
 Assign addressing, clearing demand-driven data. More...
 
- Public Member Functions inherited from zone
 TypeName ("zone")
 Runtime type information. More...
 
 zone ()
 Default construct. More...
 
 zone (const word &name, const label index)
 Construct an empty zone. More...
 
 zone (const word &name, const labelUList &addr, const label index)
 Copy construct from components. More...
 
 zone (const word &name, labelList &&addr, const label index)
 Move construct from components. More...
 
 zone (const word &name, const dictionary &dict, const word &labelsName, const label index)
 Construct from dictionary. More...
 
 zone (const zone &origZone, const labelUList &addr, const label index)
 
 zone (const zone &origZone, labelList &&addr, const label index)
 
virtual ~zone ()
 Destructor. More...
 
const Map< label > & lookupMap () const
 Demand-driven: the look-up map from global to local id. More...
 
label localID (const label globalID) const
 Lookup local address in zone for given global index. More...
 
const labelListaddressing () const noexcept
 The addressing used by the zone. More...
 
virtual void clearAddressing ()
 Clear addressing. More...
 
virtual bool checkDefinition (const bool report=false) const =0
 Check zone definition. Return true if in error. More...
 
virtual bool checkDefinition (const label maxSize, const bool report=false) const
 Check zone definition with max size given. Return true if in error. More...
 
virtual void movePoints (const pointField &pts)
 Correct patch after moving points. More...
 
virtual void write (Ostream &os) const
 Write. More...
 
virtual void writeDict (Ostream &os) const =0
 Write dictionary. More...
 
- Public Member Functions inherited from zoneIdentifier
 zoneIdentifier (const zoneIdentifier &)=default
 Copy construct. More...
 
zoneIdentifieroperator= (const zoneIdentifier &)=default
 Copy assignment. More...
 
virtual ~zoneIdentifier ()=default
 Destructor. More...
 
 zoneIdentifier ()
 Default construct. Uses name="", index=0. More...
 
 zoneIdentifier (const word &name, const label index)
 Construct from mandatory components. More...
 
 zoneIdentifier (const word &name, const label index, const word &physicalType, const wordList &inGroups=wordList())
 Construct from components. More...
 
 zoneIdentifier (const word &name, const dictionary &dict, const label index)
 Construct from dictionary. More...
 
 zoneIdentifier (const zoneIdentifier &ident, const label index)
 Copy construct, resetting the index. More...
 
const wordname () const noexcept
 The zone name. More...
 
wordname () noexcept
 Modifiable zone name. More...
 
label index () const noexcept
 The index of this zone in the zone list. More...
 
label & index () noexcept
 Modifiable index of this zone in the zone list. More...
 
const wordphysicalType () const noexcept
 The (optional) type of the zone. More...
 
wordphysicalType () noexcept
 Modifiable (optional) type of the zone. More...
 
const wordListinGroups () const noexcept
 The (optional) groups that the zone belongs to. More...
 
wordListinGroups () noexcept
 Modifiable (optional) groups that the zone belongs to. More...
 
bool inGroup (const word &name) const
 True if given name is in a group. More...
 
void write (Ostream &os) const
 
- 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 > &a)
 Copy construct from list. More...
 
 List (const UList< label > &a)
 Copy construct contents from list. More...
 
 List (List< label > &a, 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 SLList< label > &list)
 Construct as copy of SLList<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)
 Move construct from List. More...
 
 List (DynamicList< label, SizeMin > &&list)
 Move construct from DynamicList. More...
 
 List (SLList< label > &&list)
 Move construct from SLList. More...
 
 List (Istream &is)
 Construct from Istream. 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_nocopy (const label len)
 Adjust allocated size of list without necessarily. More...
 
void setSize (const label n)
 Alias for resize() More...
 
void setSize (const label n, const label &val)
 Alias for resize() 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)
 Append an element if not already in the list. More...
 
void transfer (List< label > &list)
 
void transfer (DynamicList< label, SizeMin > &list)
 
label & newElmt (const label i)
 
void operator= (const UList< label > &a)
 Assignment to UList operator. Takes linear time. More...
 
void operator= (const List< label > &list)
 Assignment operator. Takes linear time. More...
 
void operator= (const SLList< label > &list)
 Assignment to SLList 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= (SLList< label > &&list)
 Move assignment. Takes constant time. More...
 
IstreamreadList (Istream &is)
 Read List from Istream, discarding contents of existing List. More...
 
IstreamreadList (Istream &is)
 
IstreamreadList (Istream &is)
 
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...
 
- Public Member Functions inherited from UList< T >
 UList (const UList< T > &)=default
 Copy construct. More...
 
constexpr UList () noexcept
 Default construct, zero-sized and nullptr. More...
 
 UList (T *__restrict__ v, const label len) noexcept
 Construct from components. More...
 
label fcIndex (const label i) const noexcept
 
label rcIndex (const label i) const noexcept
 
const TfcValue (const label i) const
 Return forward circular value (ie, next value in the list) More...
 
TfcValue (const label i)
 Return forward circular value (ie, next value in the list) More...
 
const TrcValue (const label i) const
 Return reverse circular value (ie, previous value in the list) More...
 
TrcValue (const label i)
 Return reverse circular value (ie, previous value in the list) More...
 
const Tcdata () const noexcept
 Return pointer to the underlying array serving as data storage. More...
 
Tdata () 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...
 
Tfirst ()
 Return the first element of the list. More...
 
const Tfirst () const
 Return first element of the list. More...
 
Tlast ()
 Return the last element of the list. More...
 
const Tlast () const
 Return the last element of the list. More...
 
std::streamsize size_bytes () const noexcept
 Number of contiguous bytes for the List data. More...
 
std::streamsize byteSize () const
 
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...
 
label find (const T &val, label pos=0) const
 Find index of the first occurrence of the value. More...
 
label rfind (const T &val, label pos=-1) const
 Find index of the last occurrence of the value. More...
 
bool found (const T &val, label pos=0) const
 True if the value if found in the list. 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 (const UList< T > &list)
 Copy the pointer and size held by the given UList. More...
 
void deepCopy (const UList< T > &list)
 Copy elements of the given UList. Sizes must match! More...
 
template<class Addr >
void deepCopy (const IndirectListBase< T, Addr > &list)
 Copy elements of the given indirect list. Sizes must match! More...
 
SubList< Tslice (const label pos, label len=-1)
 Return SubList slice (non-const access) - no range checking. More...
 
const SubList< Tslice (const label pos, label len=-1) const
 Return SubList slice (const access) - no range checking. More...
 
SubList< Tslice (const labelRange &range)
 Return SubList slice (non-const access) - with range checking. More...
 
const SubList< Tslice (const labelRange &range) const
 Return SubList slice (const access) - with range checking. More...
 
Toperator[] (const label i)
 Return element of UList. More...
 
const Toperator[] (const label i) const
 Return element of constant UList. More...
 
 operator const Foam::List< T > & () const
 Allow cast to a const List<T>&. More...
 
void operator= (const T &val)
 Assignment of all entries to the given value. More...
 
void operator= (const Foam::zero)
 Assignment of all entries to zero. More...
 
iterator begin () noexcept
 Return an iterator to begin traversing the UList. More...
 
iterator end () noexcept
 Return an iterator to end traversing the UList. More...
 
const_iterator cbegin () const noexcept
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator cend () const noexcept
 Return const_iterator to end traversing the constant UList. More...
 
const_iterator begin () const noexcept
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator end () const noexcept
 Return const_iterator to end traversing the constant UList. More...
 
reverse_iterator rbegin ()
 Return reverse_iterator to begin reverse traversing the UList. More...
 
reverse_iterator rend ()
 Return reverse_iterator to end reverse traversing the UList. More...
 
const_reverse_iterator crbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList. More...
 
const_reverse_iterator crend () const
 Return const_reverse_iterator to end reverse traversing the UList. More...
 
const_reverse_iterator rbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList. More...
 
const_reverse_iterator rend () const
 Return const_reverse_iterator to end reverse traversing the UList. More...
 
label size () const noexcept
 The number of elements in the UList. More...
 
bool empty () const noexcept
 True if the UList is empty (ie, size() is zero) More...
 
void swap (UList< T > &list)
 Swap content with another UList of the same type in constant time. More...
 
bool operator== (const UList< T > &a) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UList< T > &a) const
 The opposite of the equality operation. Takes linear time. More...
 
bool operator< (const UList< T > &list) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator> (const UList< T > &a) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator<= (const UList< T > &a) const
 Return true if !(a > b). Takes linear time. More...
 
bool operator>= (const UList< T > &a) const
 Return true if !(a < b). Takes linear time. More...
 
IstreamreadList (Istream &is)
 Read List contents from Istream. More...
 
void writeEntry (const word &keyword, Ostream &os) const
 Write the List as a dictionary entry with keyword. More...
 
OstreamwriteList (Ostream &os, const label shortLen=0) const
 Write List, with line-breaks in ASCII when length exceeds shortLen. More...
 
template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type test (const label i) const
 
template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type get (const label i) const
 
template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type unset (const label i)
 
IstreamreadList (Istream &is)
 
OstreamwriteList (Ostream &os, const label) const
 
const booloperator[] (const label i) const
 
Foam::UPstream::commsStructoperator[] (const label procID)
 
const Foam::UPstream::commsStructoperator[] (const label procID) const
 
UPstream::commsStructoperator[] (const label procID)
 
const UPstream::commsStructoperator[] (const label procID) const
 
OstreamwriteList (Ostream &os, const label) const
 
IstreamreadList (Istream &is)
 

Static Public Member Functions

static autoPtr< pointZoneNew (const word &name, const dictionary &dict, const label index, const pointZoneMesh &zm)
 Return a pointer to a new point zone. 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< T >
static const UList< T > & null ()
 Return a UList reference to a nullObject. More...
 
static constexpr label max_size () noexcept
 The size of the largest possible UList. More...
 

Static Public Attributes

static const char *const labelsName = "pointLabels"
 

Friends

Ostreamoperator<< (Ostream &os, const pointZone &zn)
 Ostream Operator. More...
 

Additional Inherited Members

- Public Types inherited from List< label >
typedef SubList< label > subList
 Declare type of subList. More...
 
- Public Types inherited from UList< T >
typedef T value_type
 The value type the list contains. More...
 
typedef Tpointer
 The pointer type for non-const access to value_type items. More...
 
typedef const Tconst_pointer
 The pointer type for const access to value_type items. More...
 
typedef Treference
 The type used for storing into value_type objects. More...
 
typedef const Tconst_reference
 The type used for reading from constant value_type objects. More...
 
typedef Titerator
 Random access iterator for traversing a UList. More...
 
typedef const Tconst_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...
 
- Protected Member Functions inherited from UList< T >
void setAddressableSize (const label n) noexcept
 Set addressed size to be inconsistent with allocated storage. More...
 
void size (const label n)
 Older name for setAddressableSize. More...
 
void writeEntry (Ostream &os) const
 Write the UList with its compound type. More...
 
labelRange validateRange (const labelRange &requestedRange) const
 
UList< T > & operator= (const UList< T > &)=delete
 No copy assignment (default: shallow copy) More...
 
void writeEntry (Ostream &os) const
 
void writeEntry (Ostream &os) const
 

Detailed Description

A subset of mesh points.

The labels of points in the zone can be obtained from the addressing() list.

For quick check whether a point belongs to the zone use the lookup mechanism in pointZoneMesh, where all the zoned points are registered with their zone number.

Source files

Definition at line 65 of file pointZone.H.

Constructor & Destructor Documentation

◆ pointZone() [1/6]

pointZone ( const word name,
const label  index,
const pointZoneMesh zm 
)

Construct an empty zone.

Definition at line 50 of file pointZone.C.

References Foam::name().

Here is the call graph for this function:

◆ pointZone() [2/6]

pointZone ( const word name,
const labelUList addr,
const label  index,
const pointZoneMesh zm 
)

Construct from components.

Definition at line 62 of file pointZone.C.

◆ pointZone() [3/6]

pointZone ( const word name,
labelList &&  addr,
const label  index,
const pointZoneMesh zm 
)

Construct from components, transferring addressing.

Definition at line 75 of file pointZone.C.

◆ pointZone() [4/6]

pointZone ( const word name,
const dictionary dict,
const label  index,
const pointZoneMesh zm 
)

Construct from dictionary.

Definition at line 88 of file pointZone.C.

◆ pointZone() [5/6]

pointZone ( const pointZone origZone,
const labelUList addr,
const label  index,
const pointZoneMesh zm 
)

Construct with a new index and zone mesh information, the name of the original zone, resetting the point addressing.

Definition at line 101 of file pointZone.C.

◆ pointZone() [6/6]

pointZone ( const pointZone origZone,
labelList &&  addr,
const label  index,
const pointZoneMesh zm 
)

Construct with a new index and zone mesh information, the name of the original zone, (move) resetting the point addressing.

Definition at line 114 of file pointZone.C.

◆ ~pointZone()

virtual ~pointZone ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "pointZone"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
pointZone  ,
dictionary  ,
(const word &name, const dictionary &dict, const label index, const pointZoneMesh &zm)  ,
(name, dict, index, zm)   
)

◆ clone() [1/2]

virtual autoPtr< pointZone > clone ( const pointZoneMesh zm) const
inlinevirtual

Construct and return a clone, resetting the zone mesh.

Definition at line 170 of file pointZone.H.

References zoneIdentifier::index(), and Time::New().

Here is the call graph for this function:

◆ clone() [2/2]

virtual autoPtr< pointZone > clone ( const pointZoneMesh zm,
const label  index,
const labelUList addr 
) const
inlinevirtual

Construct and return a clone, resetting the point list and zone mesh

Definition at line 177 of file pointZone.H.

References zoneIdentifier::index(), and Time::New().

Here is the call graph for this function:

◆ New()

Foam::autoPtr< Foam::pointZone > New ( const word name,
const dictionary dict,
const label  index,
const pointZoneMesh zm 
)
static

Return a pointer to a new point zone.

created on freestore from dictionary

Definition at line 34 of file pointZoneNew.C.

References DebugInFunction, dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, dictionary::get(), zoneIdentifier::index(), and zoneIdentifier::name().

Here is the call graph for this function:

◆ zoneMesh()

const pointZoneMesh & zoneMesh ( ) const
inlinenoexcept

Return reference to the zone mesh.

Definition at line 208 of file pointZone.H.

◆ whichPoint()

Foam::label whichPoint ( const label  globalPointID) const

Helper function to re-direct to zone::localID(...)

Definition at line 129 of file pointZone.C.

References zone::localID().

Here is the call graph for this function:

◆ checkDefinition()

bool checkDefinition ( const bool  report = false) const
virtual

Check zone definition. Return true if in error.

Implements zone.

Definition at line 135 of file pointZone.C.

References pointZone::checkDefinition().

Referenced by pointZone::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
virtual

Check whether zone is synchronised across coupled boundaries.

Returns
True if any errors.

Definition at line 141 of file pointZone.C.

References Foam::endl(), forAll, Foam::Info, Foam::labelMax, mesh, Foam::name(), Foam::nl, primitiveMesh::nPoints(), polyMesh::points(), and syncTools::syncPointList().

Here is the call graph for this function:

◆ movePoints()

virtual void movePoints ( const pointField )
inlinevirtual

Correct patch after moving points.

Reimplemented from zone.

Definition at line 225 of file pointZone.H.

◆ writeDict()

void writeDict ( Ostream os) const
virtual

Write dictionary.

Implements zone.

Definition at line 195 of file pointZone.C.

References Ostream::beginBlock(), Ostream::endBlock(), Foam::name(), os(), Foam::type(), ObukhovLength::write(), and Ostream::writeEntry().

Here is the call graph for this function:

◆ operator=() [1/3]

void operator= ( const pointZone zn)

Assign addressing, clearing demand-driven data.

Definition at line 209 of file pointZone.C.

References List< label >::operator=().

Here is the call graph for this function:

◆ operator=() [2/3]

void operator= ( const labelUList addr)

Assign addressing, clearing demand-driven data.

Definition at line 216 of file pointZone.C.

References List< label >::operator=().

Here is the call graph for this function:

◆ operator=() [3/3]

void operator= ( labelList &&  addr)

Assign addressing, clearing demand-driven data.

Definition at line 223 of file pointZone.C.

References kinematicSingleLayer::transfer().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator<<

Ostream & operator<< ( Ostream os,
const pointZone zn 
)
friend

Ostream Operator.

Member Data Documentation

◆ labelsName

const char *const labelsName = "pointLabels"
static

The name associated with the zone-labels dictionary entry ("pointLabels")

Definition at line 87 of file pointZone.H.


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