pointZone Class Reference

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, const Xfer< 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 &, const Xfer< labelList > &addr, const label index, const pointZoneMesh &)
	Construct given the original zone, resetting the. 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 &)
	Assign to zone, clearing demand-driven data. More...
void	operator= (const labelUList &)
	Assign addressing, clearing demand-driven data. More...
void	operator= (const Xfer< labelList > &)
	Assign 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, const Xfer< labelList > &addr, const label index)
	Construct from components, transferring 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 &, const Xfer< labelList > &addr, const label index)
	Construct given the original zone, resetting the. 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...
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...
Public Member Functions inherited from List
	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 List< T > &)
	Copy constructor. More...
	List (const Xfer< List< T > > &)
	Construct by transferring the parameter contents. 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 (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...
Xfer< List< T > >	xfer ()
	Transfer contents to the Xfer container. More...
T &	newElmt (const label)
	Return subscript-checked element of UList. More...
void	operator= (const UList< T > &)
	Assignment from UList operator. Takes linear time. More...
void	operator= (const List< T > &)
	Assignment operator. Takes linear time. More...
void	operator= (const SLList< T > &)
	Assignment from SLList operator. Takes linear time. More...
void	operator= (const UIndirectList< T > &)
	Assignment from UIndirectList operator. Takes linear time. More...
void	operator= (const BiIndirectList< T > &)
	Assignment from BiIndirectList operator. Takes linear time. More...
void	operator= (const T &)
	Assignment of all entries to the given value. More...
template<class T >
	List (const label s)
template<class T >
	List (const label s, const T &a)
template<class T >
	List (const List< T > &a)
template<class T >
	List (const Xfer< List< T > > &lst)
template<class T >
	List (List< T > &a, bool reUse)
template<class T >
	List (const UList< T > &a, const labelUList &map)
template<class T >
	List (const PtrList< T > &lst)
template<class T >
	List (const SLList< T > &lst)
template<class T >
	List (const UIndirectList< T > &lst)
template<class T >
	List (const BiIndirectList< T > &lst)
template<class T >
void	transfer (List< T > &a)
template<class T >
void	transfer (SortableList< T > &a)
template<class T >
	List ()
template<class T >
	List (Istream &is)

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
static const List< T > &	null ()
	Return a null List. More...

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

Protected Member Functions
	pointZone (const pointZone &)
	Disallow default bitwise copy construct. More...
Protected Member Functions inherited from zone
const Map< label > &	lookupMap () const
	Return a reference to the look-up map. More...
void	calcLookupMap () const
	Construct the look-up map. More...
	zone (const zone &)
	Disallow default bitwise copy construct. More...
Protected Member Functions inherited from List
void	size (const label)
	Override size to be inconsistent with allocated storage. 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
typedef SubList< T >	subList
	Declare type of subList. 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

• pointZone.H
• pointZone.C
• pointZoneNew.C

Definition at line 62 of file pointZone.H.

Constructor & Destructor Documentation

pointZone() [1/6]

pointZone ( const pointZone &  )

protected

Disallow default bitwise copy construct.

Referenced by pointZone::clone().

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

pointZone() [3/6]

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

Construct from components, transferring contents.

Definition at line 61 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 74 of file pointZone.C.

pointZone() [5/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.

pointZone() [6/6]

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 100 of file pointZone.C.

~pointZone()

~pointZone ( )

virtual

Destructor.

Definition at line 114 of file pointZone.C.

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 zone::index(), and pointZone::pointZone().

Referenced by singleCellFvMesh::agglomerateMesh().

Here is the call graph for this function:

Here is the caller 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 zone::index(), 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, Foam::Info, Foam::name(), and Foam::nl.

Here is the call graph for this function:

zoneMesh()

const Foam::pointZoneMesh & zoneMesh

(

)

const

Return zoneMesh reference.

Definition at line 120 of file pointZone.C.

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 surfaceSlipDisplacementPointPatchVectorField::calcProjection(), surfaceDisplacementPointPatchVectorField::calcProjection(), and polyTopoChange::resetZones().

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().

Here is the call 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().

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

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, and Foam::type().

Here is the call graph for this function:

operator=() [1/3]

void operator=

(

const pointZone &

zn

)

Assign to zone, clearing demand-driven data.

Definition at line 202 of file pointZone.C.

References List::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 209 of file pointZone.C.

References List::operator=().

Here is the call graph for this function:

operator=() [3/3]

void operator=

(

const Xfer< labelList > &

addr

)

Assign addressing, clearing demand-driven data.

Definition at line 216 of file pointZone.C.

References List::operator=().

Here is the call graph for this function:

Friends And Related Function Documentation

operator<<

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

friend

Ostream Operator.

Field 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 84 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