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

Inheritance diagram for pointZone:

Collaboration diagram for pointZone:

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 labelUList &addr, const label index, const pointZoneMesh &)
	Construct from components. More...

	pointZone (const word &name, labelList &&addr, const label index, const pointZoneMesh &)
	Construct from components, transferring contents. More...

	pointZone (const word &name, const dictionary &, const label index, const pointZoneMesh &)
	Construct from dictionary. More...

	pointZone (const pointZone &, const labelUList &addr, const label index, const pointZoneMesh &)
	Construct given the original zone and resetting the. More...

	pointZone (const pointZone &, labelList &&addr, const label index, const pointZoneMesh &)
	Construct given the original zone, resetting the. More...

	pointZone (const pointZone &)=delete
	Disallow default bitwise copy construction. More...

virtual autoPtr< pointZone >	clone (const pointZoneMesh &zm) const
	Construct and return a clone, resetting the zone mesh. More...

virtual autoPtr< pointZone >	clone (const pointZoneMesh &zm, const label index, const labelUList &addr) const
	Construct and return a clone, resetting the point list. More...

virtual	~pointZone ()
	Destructor. More...

const pointZoneMesh &	zoneMesh () const
	Return zoneMesh reference. 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. Return. More...

virtual void	movePoints (const pointField &)
	Correct patch after moving points. More...

virtual void	writeDict (Ostream &) const
	Write dictionary. More...

void	operator= (const pointZone &)
	Assignment to zone, clearing demand-driven data. More...

void	operator= (pointZone &&)
	Move assignment to zone, clearing demand-driven data. More...

void	operator= (const labelUList &)
	Assign addressing, clearing demand-driven data. More...

void	operator= (labelList &&)
	Move addressing, clearing demand-driven data. More...

Public Member Functions inherited from zone
	TypeName ("zone")
	Runtime type information. More...

	zone (const word &name, const labelUList &addr, const label index)
	Construct from components. More...

	zone (const word &name, labelList &&addr, const label index)
	Construct from components, moving contents. More...

	zone (const word &name, const dictionary &, const word &labelsName, const label index)
	Construct from dictionary. More...

	zone (const zone &, const labelUList &addr, const label index)
	Construct given the original zone and resetting the. More...

	zone (const zone &, labelList &&addr, const label index)
	Construct given the original zone, resetting the. More...

	zone (const zone &)=delete
	Disallow default bitwise copy construction. More...

virtual	~zone ()
	Destructor. More...

const word &	name () const
	Return name. More...

label	localID (const label globalID) const
	Map storing the local index for every global index. Used to find. More...

label	index () const
	Return the index of this zone in zone list. More...

const Map< label > &	lookupMap () const
	Return a reference to the look-up map. More...

virtual void	clearAddressing ()
	Clear addressing. 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	write (Ostream &) const
	Write. More...

void	operator= (const zone &)
	Assignment operator. More...

void	operator= (zone &&)
	Move assignment operator. More...

void	operator= (const labelUList &)
	Assignment operator to addressing. More...

void	operator= (labelList &&)
	Move assignment of addressing. More...

Public Member Functions inherited from List< T >
	List ()
	Null constructor. More...

	List (const label)
	Construct with given size. More...

	List (const label, const T &)
	Construct with given size and value for all elements. More...

	List (const label, const zero)
	Construct with given size initializing all elements to zero. More...

	List (const List< T > &)
	Copy constructor. More...

template<class T2 >
	List (const List< T2 > &)
	Copy constructor from list containing another type. More...

	List (List< T > &&)
	Move constructor. More...

	List (List< T > &, bool reuse)
	Construct as copy or re-use as specified. More...

	List (const UList< T > &, const labelUList &mapAddressing)
	Construct as subset. More...

template<class InputIterator >
	List (InputIterator first, InputIterator last)
	Construct given start and end iterators. More...

template<unsigned Size>
	List (const FixedList< T, Size > &)
	Construct as copy of FixedList<T, Size> More...

	List (const PtrList< T > &)
	Construct as copy of PtrList<T> More...

	List (const SLList< T > &)
	Construct as copy of SLList<T> More...

	List (const UIndirectList< T > &)
	Construct as copy of UIndirectList<T> More...

	List (const BiIndirectList< T > &)
	Construct as copy of BiIndirectList<T> More...

	List (std::initializer_list< T >)
	Construct from an initializer list. More...

	List (Istream &)
	Construct from Istream. More...

autoPtr< List< T > >	clone () const
	Clone. More...

	~List ()
	Destructor. More...

label	size () const
	Return the number of elements in the UList. More...

void	resize (const label)
	Alias for setSize(const label) More...

void	resize (const label, const T &)
	Alias for setSize(const label, const T&) More...

void	setSize (const label)
	Reset size of List. More...

void	setSize (const label, const T &)
	Reset size of List and value for new elements. More...

void	clear ()
	Clear the list, i.e. set size to zero. More...

void	append (const T &)
	Append an element at the end of the list. More...

void	append (const UList< T > &)
	Append a List at the end of this list. More...

void	append (const UIndirectList< T > &)
	Append a UIndirectList at the end of this list. More...

void	transfer (List< T > &)
	Transfer the contents of the argument List into this list. More...

template<unsigned SizeInc, unsigned SizeMult, unsigned SizeDiv>
void	transfer (DynamicList< T, SizeInc, SizeMult, SizeDiv > &)
	Transfer the contents of the argument List into this list. More...

void	transfer (SortableList< T > &)
	Transfer the contents of the argument List into this list. More...

T &	newElmt (const label)
	Return subscript-checked element of UList. More...

void	shallowCopy (const UList< T > &)=delete
	Disallow implicit shallowCopy. More...

void	operator= (const UList< T > &)
	Assignment to UList operator. Takes linear time. More...

void	operator= (const List< T > &)
	Assignment operator. Takes linear time. More...

void	operator= (List< T > &&)
	Move assignment operator. More...

void	operator= (const SLList< T > &)
	Assignment to SLList operator. Takes linear time. More...

void	operator= (const UIndirectList< T > &)
	Assignment to UIndirectList operator. Takes linear time. More...

void	operator= (const BiIndirectList< T > &)
	Assignment to BiIndirectList operator. Takes linear time. More...

void	operator= (std::initializer_list< T >)
	Assignment to an initializer list. More...

void	operator= (const T &)
	Assignment of all entries to the given value. More...

void	operator= (const zero)
	Assignment of all entries to zero. More...

Public Member Functions inherited from UList< T >
	UList ()
	Null constructor. More...

	UList (T *__restrict__ v, label size)
	Construct from components. More...

label	fcIndex (const label i) const
	Return the forward circular index, i.e. the next index. More...

label	rcIndex (const label i) const
	Return the reverse circular index, i.e. the previous index. More...

std::streamsize	byteSize () const
	Return the binary size in number of characters of the UList. More...

const T *	cdata () const
	Return a const pointer to the first data element,. More...

T *	data ()
	Return a pointer to the first data element,. More...

T &	first ()
	Return the first element of the list. More...

const T &	first () const
	Return first element of the list. More...

T &	last ()
	Return the last element of the list. More...

const T &	last () const
	Return the last element of the list. More...

void	checkStart (const label start) const
	Check start is within valid range (0 ... size-1) More...

void	checkSize (const label size) const
	Check size is within valid range (0 ... size) More...

void	checkIndex (const label i) const
	Check index i is within valid range (0 ... size-1) More...

void	shallowCopy (const UList< T > &)
	Copy the pointer held by the given UList. More...

void	deepCopy (const UList< T > &)
	Copy elements of the given UList. More...

T &	operator[] (const label)
	Return element of UList. More...

const T &	operator[] (const label) 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 &)
	Assignment of all entries to the given value. More...

void	operator= (const zero)
	Assignment of all entries to zero. More...

iterator	begin ()
	Return an iterator to begin traversing the UList. More...

iterator	end ()
	Return an iterator to end traversing the UList. More...

const_iterator	cbegin () const
	Return const_iterator to begin traversing the constant UList. More...

const_iterator	cend () const
	Return const_iterator to end traversing the constant UList. More...

const_iterator	begin () const
	Return const_iterator to begin traversing the constant UList. More...

const_iterator	end () const
	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
	Return the number of elements in the UList. More...

label	max_size () const
	Return size of the largest possible UList. More...

bool	empty () const
	Return true if the UList is empty (ie, size() is zero) More...

void	swap (UList< T > &)
	Swap two ULists of the same type in constant time. More...

bool	operator== (const UList< T > &) const
	Equality operation on ULists of the same type. More...

bool	operator!= (const UList< T > &) const
	The opposite of the equality operation. Takes linear time. More...

bool	operator< (const UList< T > &) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator> (const UList< T > &) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator<= (const UList< T > &) const
	Return true if !(a > b). Takes linear time. More...

bool	operator>= (const UList< T > &) const
	Return true if !(a < b). Takes linear time. More...

template<>
const bool &	operator[] (const label i) const

Static Public Member Functions
static autoPtr< pointZone >	New (const word &name, const dictionary &, const label index, const pointZoneMesh &)
	Return a pointer to a new point zone. More...

Static Public Member Functions inherited from List< T >
static const List< T > &	null ()
	Return a null List. More...

Static Public Member Functions inherited from UList< T >
static const UList< T > &	null ()
	Return a null UList. More...

Static Public Attributes
static const char *const	labelsName = "pointLabels"
	The name associated with the zone-labels dictionary entry. More...

Protected Attributes
const pointZoneMesh &	zoneMesh_
	Reference to zone list. More...

Protected Attributes inherited from zone
word	name_
	Name of zone. More...

label	index_
	Index of zone. More...

Map< label > *	lookupMapPtr_
	Map of labels in zone for fast location lookup. More...

Friends
Ostream &	operator<< (Ostream &, const pointZone &)
	Ostream Operator. More...

Additional Inherited Members
Public Types inherited from List< T >
typedef SubList< T >	subList
	Declare type of subList. More...

Public Types inherited from UList< T >
typedef T	value_type
	Type of values the UList contains. More...

typedef T &	reference
	Type that can be used for storing into. More...

typedef const T &	const_reference
	Type that can be used for storing into. More...

typedef label	difference_type
	The type that can represent the difference between any two. More...

typedef label	size_type
	The type that can represent the size of a UList. More...

typedef T *	iterator
	Random access iterator for traversing UList. More...

typedef const T *	const_iterator
	Random access iterator for traversing UList. More...

typedef T *	reverse_iterator
	Reverse iterator for reverse traversal of UList. More...

typedef const T *	const_reverse_iterator
	Reverse iterator for reverse traversal of constant UList. More...

Protected Member Functions inherited from zone
void	calcLookupMap () const
	Construct the look-up map. More...

Protected Member Functions inherited from List< T >
void	size (const label)
	Override size to be inconsistent with allocated storage. More...

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

Constructor & Destructor Documentation

◆ pointZone() [1/6]

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

Construct from components.

Definition at line 48 of file pointZone.C.

Referenced by pointZone::clone(), and pointZone::pointZone().

Here is the caller graph for this function:

◆ pointZone() [2/6]

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

Construct from components, transferring contents.

Definition at line 61 of file pointZone.C.

References pointZone::pointZone().

Here is the call graph for this function:

◆ pointZone() [3/6]

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

Construct from dictionary.

Definition at line 74 of file pointZone.C.

References pointZone::pointZone().

Here is the call graph for this function:

◆ pointZone() [4/6]

pointZone	(	const pointZone &	pz,
		const labelUList &	addr,
		const label	index,
		const pointZoneMesh &	zm
	)

Construct given the original zone and resetting the.

point list and zone mesh information

Definition at line 87 of file pointZone.C.

References pointZone::pointZone().

Here is the call graph for this function:

◆ pointZone() [5/6]

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

Construct given the original zone, resetting the.

face list and zone mesh information

Definition at line 100 of file pointZone.C.

◆ pointZone() [6/6]

pointZone ( const pointZone & )

delete

Disallow default bitwise copy construction.

◆ ~pointZone()

~pointZone ( )

virtual

Destructor.

Definition at line 114 of file pointZone.C.

Referenced by pointZone::clone().

Here is the caller graph for this function:

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

References List< T >::clone(), zone::index(), and pointZone::pointZone().

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

References pointZone::checkDefinition(), pointZone::checkParallelSync(), pointZone::New(), pointZone::pointZone(), pointZone::whichPoint(), pointZone::zoneMesh(), and pointZone::~pointZone().

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 32 of file pointZoneNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, InfoInFunction, dictionary::lookup(), Foam::name(), and Foam::nl.

Referenced by pointZone::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ zoneMesh()

const Foam::pointZoneMesh & zoneMesh ( ) const

Return zoneMesh reference.

Definition at line 120 of file pointZone.C.

Referenced by pointZone::clone().

Here is the caller graph for this function:

◆ whichPoint()

Foam::label whichPoint ( const label globalPointID ) const

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

Definition at line 126 of file pointZone.C.

References zone::localID().

Referenced by pointZone::clone(), and NamedEnum< directionType, 3 >::names().

Here is the call graph for this function:

Here is the caller 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 132 of file pointZone.C.

References zone::checkDefinition().

Referenced by pointZone::clone().

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. Return.

true if in error.

Definition at line 138 of file pointZone.C.

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

Referenced by pointZone::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ movePoints()

virtual void movePoints ( const pointField & )

inlinevirtual

Correct patch after moving points.

Reimplemented from zone.

Definition at line 215 of file pointZone.H.

References pointZone::operator<<, pointZone::operator=(), and pointZone::writeDict().

Here is the call graph for this function:

◆ writeDict()

void writeDict ( Ostream & os ) const

virtual

Write dictionary.

Implements zone.

Definition at line 189 of file pointZone.C.

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

Referenced by pointZone::movePoints().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=() [1/4]

void operator= ( const pointZone & zn )

Assignment to zone, clearing demand-driven data.

Definition at line 202 of file pointZone.C.

References zone::operator=().

Referenced by pointZone::movePoints().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=() [2/4]

void operator= ( pointZone && zn )

Move assignment to zone, clearing demand-driven data.

Definition at line 209 of file pointZone.C.

References zone::operator=().

Here is the call graph for this function:

◆ operator=() [3/4]

void operator= ( const labelUList & addr )

Assign addressing, clearing demand-driven data.

Definition at line 216 of file pointZone.C.

References zone::operator=().

Here is the call graph for this function:

◆ operator=() [4/4]

void operator= ( labelList && addr )

Move addressing, clearing demand-driven data.

Definition at line 223 of file pointZone.C.

References zone::operator=().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator<<

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

friend

Ostream Operator.

Referenced by pointZone::movePoints().

Member Data Documentation

◆ zoneMesh_

const pointZoneMesh& zoneMesh_

protected

Reference to zone list.

Definition at line 72 of file pointZone.H.

◆ labelsName

const char *const labelsName = "pointLabels"

static

The name associated with the zone-labels dictionary entry.

Definition at line 80 of file pointZone.H.

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

src/OpenFOAM/meshes/polyMesh/zones/pointZone/pointZone.H
src/OpenFOAM/meshes/polyMesh/zones/pointZone/pointZone.C
src/OpenFOAM/meshes/polyMesh/zones/pointZone/pointZoneNew.C

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ pointZone() [1/6]

◆ pointZone() [2/6]

◆ pointZone() [3/6]

◆ pointZone() [4/6]

◆ pointZone() [5/6]

◆ pointZone() [6/6]

◆ ~pointZone()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ clone() [1/2]

◆ clone() [2/2]

◆ New()

◆ zoneMesh()

◆ whichPoint()

◆ checkDefinition()

◆ checkParallelSync()

◆ movePoints()

◆ writeDict()

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ zoneMesh_

◆ labelsName