FreeFOAM The Cross-Platform CFD Toolkit
pointZone Class Reference

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

#include <OpenFOAM/pointZone.H>


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 67 of file pointZone.H.

+ Inheritance diagram for pointZone:
+ Collaboration diagram for pointZone:

List of all members.

Public Member Functions

 TypeName ("pointZone")
 Runtime type information.
 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 labelList &addr, const label index, const pointZoneMesh &)
 Construct from components.
 pointZone (const word &name, const Xfer< labelList > &addr, const label index, const pointZoneMesh &)
 Construct from components, transferring contents.
 pointZone (const word &name, const dictionary &, const label index, const pointZoneMesh &)
 Construct from dictionary.
 pointZone (const pointZone &, const labelList &addr, const label index, const pointZoneMesh &)
 Construct given the original zone and resetting the.
 pointZone (const pointZone &, const Xfer< labelList > &addr, const label index, const pointZoneMesh &)
 Construct given the original zone, resetting the.
virtual autoPtr< pointZoneclone (const pointZoneMesh &zm) const
 Construct and return a clone, resetting the zone mesh.
virtual autoPtr< pointZoneclone (const pointZoneMesh &zm, const label index, const labelList &addr) const
 Construct and return a clone, resetting the point list.
virtual ~pointZone ()
 Destructor.
const wordname () const
 Return name.
label whichPoint (const label globalPointID) const
 Map storing the local point index for every global point.
label index () const
 Return the index of this zone in zone list.
const pointZoneMeshzoneMesh () const
 Return zoneMesh reference.
void clearAddressing ()
 Clear addressing.
bool checkDefinition (const bool report=false) const
 Check zone definition. Return true if in error.
virtual void movePoints (const pointField &)
 Correct patch after moving points.
virtual void write (Ostream &) const
 Write.
virtual void writeDict (Ostream &) const
 Write dictionary.
void operator= (const pointZone &)
 Assign to zone clearing demand-driven data.
void operator= (const labelList &)
 Assign addressing clearing demand-driven data.
- Public Member Functions inherited from List< T >
 List ()
 Null constructor.
 List (const label)
 Construct with given size.
 List (const label, const T &)
 Construct with given size and value for all elements.
 List (const List< T > &)
 Copy constructor.
 List (const Xfer< List< T > > &)
 Construct by transferring the parameter contents.
 List (List< T > &, bool reUse)
 Construct as copy or re-use as specified.
 List (const UList< T > &, const unallocLabelList &mapAddressing)
 Construct as subset.
template<class InputIterator >
 List (InputIterator first, InputIterator last)
 Construct given start and end iterators.
template<unsigned Size>
 List (const FixedList< T, Size > &)
 Construct as copy of FixedList<T, Size>
 List (const PtrList< T > &)
 Construct as copy of PtrList<T>
 List (const SLList< T > &)
 Construct as copy of SLList<T>
 List (const IndirectList< T > &)
 Construct as copy of IndirectList<T>
 List (const UIndirectList< T > &)
 Construct as copy of UIndirectList<T>
 List (const BiIndirectList< T > &)
 Construct as copy of BiIndirectList<T>
 List (Istream &)
 Construct from Istream.
autoPtr< List< T > > clone () const
 Clone.
 ~List ()
label size () const
 Return the number of elements in the UList.
void resize (const label)
 Reset size of List.
void resize (const label, const T &)
 Reset size of List and value for new elements.
void setSize (const label)
 Reset size of List.
void setSize (const label, const T &)
 Reset size of List and value for new elements.
void clear ()
 Clear the list, i.e. set size to zero.
void append (const UList< T > &)
 Append a List at the end of this list.
void append (const UIndirectList< T > &)
 Append a UIndirectList at the end of this list.
void transfer (List< T > &)
 Transfer the contents of the argument List into this list.
template<unsigned SizeInc, unsigned SizeMult, unsigned SizeDiv>
void transfer (DynamicList< T, SizeInc, SizeMult, SizeDiv > &)
 Transfer the contents of the argument List into this list.
void transfer (SortableList< T > &)
 Transfer the contents of the argument List into this list.
Xfer< List< T > > xfer ()
 Transfer contents to the Xfer container.
TnewElmt (const label)
 Return subscript-checked element of UList.
void operator= (const UList< T > &)
 Assignment from UList operator. Takes linear time.
void operator= (const List< T > &)
 Assignment operator. Takes linear time.
void operator= (const SLList< T > &)
 Assignment from SLList operator. Takes linear time.
void operator= (const IndirectList< T > &)
 Assignment from IndirectList operator. Takes linear time.
void operator= (const UIndirectList< T > &)
 Assignment from UIndirectList operator. Takes linear time.
void operator= (const BiIndirectList< T > &)
 Assignment from BiIndirectList operator. Takes linear time.
void operator= (const T &)
 Assignment of all entries to the given value.
- Public Member Functions inherited from UList< T >
 UList ()
 Null constructor.
 UList (T *__restrict__ v, label size)
 Construct from components.
label fcIndex (const label i) const
 Return the forward circular index, i.e. the next index.
label rcIndex (const label i) const
 Return the reverse circular index, i.e. the previous index.
label byteSize () const
 Return the binary size in number of characters of the UList.
const Tcdata () const
 Return a const pointer to the first data element,.
Tdata ()
 Return a pointer to the first data element,.
void checkStart (const label start) const
 Check start is within valid range (0 ... size-1).
void checkSize (const label size) const
 Check size is within valid range (0 ... size).
void checkIndex (const label i) const
 Check index i is within valid range (0 ... size-1).
void writeEntry (Ostream &) const
 Write the UList as a dictionary entry.
void writeEntry (const word &keyword, Ostream &) const
 Write the UList as a dictionary entry with keyword.
void assign (const UList< T > &)
 Assign elements to those from UList.
Toperator[] (const label)
 Return element of UList.
const Toperator[] (const label) const
 Return element of constant UList.
 operator const Foam::List< T > & () const
 Allow cast to a const List<T>&.
iterator begin ()
 Return an iterator to begin traversing the UList.
iterator end ()
 Return an iterator to end traversing the UList.
const_iterator cbegin () const
 Return const_iterator to begin traversing the constant UList.
const_iterator cend () const
 Return const_iterator to end traversing the constant UList.
const_iterator begin () const
 Return const_iterator to begin traversing the constant UList.
const_iterator end () const
 Return const_iterator to end traversing the constant UList.
reverse_iterator rbegin ()
 Return reverse_iterator to begin reverse traversing the UList.
reverse_iterator rend ()
 Return reverse_iterator to end reverse traversing the UList.
const_reverse_iterator crbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator crend () const
 Return const_reverse_iterator to end reverse traversing the UList.
const_reverse_iterator rbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator rend () const
 Return const_reverse_iterator to end reverse traversing the UList.
label max_size () const
 Return size of the largest possible UList.
bool empty () const
 Return true if the UList is empty (ie, size() is zero).
void swap (UList< T > &)
 Swap two ULists of the same type in constant time.
bool operator== (const UList< T > &) const
 Equality operation on ULists of the same type.
bool operator!= (const UList< T > &) const
 The opposite of the equality operation. Takes linear time.
bool operator< (const UList< T > &) const
 Compare two ULists lexicographically. Takes linear time.
bool operator> (const UList< T > &) const
 Compare two ULists lexicographically. Takes linear time.
bool operator<= (const UList< T > &) const
 Return true if !(a > b). Takes linear time.
bool operator>= (const UList< T > &) const
 Return true if !(a < b). Takes linear time.
template<>
const bool & operator[] (const label i) const

Static Public Member Functions

static autoPtr< pointZoneNew (const word &name, const dictionary &, const label index, const pointZoneMesh &)
 Return a pointer to a new point zone.
- Static Public Member Functions inherited from List< T >
static const List< T > & null ()
 Return a null List.

Friends

Ostreamoperator<< (Ostream &, const pointZone &)

Additional Inherited Members

- Public Types inherited from List< T >
typedef SubList< TsubList
 Declare type of subList.
- Public Types inherited from UList< T >
typedef T value_type
 Type of values the UList contains.
typedef Treference
 Type that can be used for storing into.
typedef const Tconst_reference
 Type that can be used for storing into.
typedef label difference_type
 The type that can represent the difference between any two.
typedef label size_type
 The type that can represent the size of a UList.
typedef Titerator
 Random access iterator for traversing UList.
typedef const Tconst_iterator
 Random access iterator for traversing UList.
typedef Treverse_iterator
 Reverse iterator for reverse traversal of UList.
typedef const Tconst_reverse_iterator
 Reverse iterator for reverse traversal of constant UList.
- Protected Member Functions inherited from List< T >
void size (const label)
 Override size to be inconsistent with allocated storage.

Constructor & Destructor Documentation

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

Construct from components.

Definition at line 99 of file pointZone.C.

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

Construct from components, transferring contents.

Definition at line 115 of file pointZone.C.

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

Construct from dictionary.

Definition at line 132 of file pointZone.C.

pointZone ( const pointZone pz,
const labelList addr,
const label  index,
const pointZoneMesh zm 
)

Construct given the original zone and resetting the.

point list and zone mesh information

Definition at line 150 of file pointZone.C.

pointZone ( const pointZone pz,
const Xfer< labelList > &  addr,
const label  index,
const pointZoneMesh zm 
)

Construct given the original zone, resetting the.

face list and zone mesh information

Definition at line 166 of file pointZone.C.

~pointZone ( )
virtual

Destructor.

Definition at line 183 of file pointZone.C.


Member Function Documentation

TypeName ( "pointZone"  )

Runtime type information.

declareRunTimeSelectionTable ( autoPtr  ,
pointZone  ,
dictionary  ,
(const word &name, const dictionary &dict, const label index, const pointZoneMesh &zm)  ,
(name, dict, index, zm)   
)
virtual autoPtr<pointZone> clone ( const pointZoneMesh zm) const
inlinevirtual

Construct and return a clone, resetting the zone mesh.

Definition at line 174 of file pointZone.H.

References pointZone::index().

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

Construct and return a clone, resetting the point list.

and zone mesh

Definition at line 185 of file pointZone.H.

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 36 of file newPointZone.C.

References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, Foam::Info, dictionary::lookup(), and name().

const word& name ( ) const
inline

Return name.

Definition at line 219 of file pointZone.H.

Referenced by fvMeshDistribute::printMeshInfo().

Foam::label whichPoint ( const label  globalPointID) const

Map storing the local point index for every global point.

index. Used to find out the index of point in the zone from the known global point index. If the point is not in the zone, returns -1

Definition at line 191 of file pointZone.C.

References HashTable< T, Key, Hash >::end(), and HashTable< T, Key, Hash >::find().

label index ( ) const
inline

Return the index of this zone in zone list.

Definition at line 231 of file pointZone.H.

Referenced by pointZone::clone().

const Foam::pointZoneMesh & zoneMesh ( ) const

Return zoneMesh reference.

Definition at line 208 of file pointZone.C.

void clearAddressing ( )

Clear addressing.

Definition at line 214 of file pointZone.C.

References Foam::deleteDemandDrivenData().

bool checkDefinition ( const bool  report = false) const

Check zone definition. Return true if in error.

Definition at line 220 of file pointZone.C.

References Foam::endl(), forAll, Foam::name(), Foam::nl, SeriousErrorIn, and List< T >::size().

virtual void movePoints ( const pointField )
inlinevirtual

Correct patch after moving points.

Definition at line 246 of file pointZone.H.

void write ( Ostream os) const
virtual

Write.

Definition at line 249 of file pointZone.C.

References Foam::name(), and Foam::nl.

Referenced by Foam::operator<<().

void writeDict ( Ostream os) const
virtual

Write dictionary.

Definition at line 256 of file pointZone.C.

References token::BEGIN_BLOCK, token::END_BLOCK, token::END_STATEMENT, Foam::endl(), Foam::name(), Foam::nl, and Foam::type().

void operator= ( const pointZone cz)

Assign to zone clearing demand-driven data.

Definition at line 269 of file pointZone.C.

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

void operator= ( const labelList addr)

Assign addressing clearing demand-driven data.

Definition at line 276 of file pointZone.C.

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


Friends And Related Function Documentation

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

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