A subset of mesh points. 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 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< 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

virtual	~pointZone ()=default
	Destructor. More...

const pointZoneMesh &	zoneMesh () 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 labelList &	addressing () const noexcept
	The addressing used by the zone. 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 &os) const
	Write. More...

Public Member Functions inherited from zoneIdentifier
	zoneIdentifier (const zoneIdentifier &)=default
	Copy construct. More...

zoneIdentifier &	operator= (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 word &	name () const noexcept
	The zone name. More...

word &	name () 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 word &	physicalType () const noexcept
	The (optional) type of the zone. More...

word &	physicalType () noexcept
	Modifiable (optional) type of the zone. More...

const wordList &	inGroups () const noexcept
	The (optional) groups that the zone belongs to. More...

wordList &	inGroups () 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 (SortableList< label > &&list)
	Move construct from SortableList. 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)

void	transfer (SortableList< label > &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= (SortableList< label > &&list)
	Move assignment. Takes constant time. More...

void	operator= (SLList< label > &&list)
	Move assignment. Takes constant time. More...

Istream &	readList (Istream &is)
	Read List from Istream, discarding contents of existing List. More...

Istream &	readList (Istream &is)

Istream &	readList (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...

Static Public Member Functions
static autoPtr< pointZone >	New (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 Attributes
static const char *const	labelsName = "pointLabels"

Friends
Ostream &	operator<< (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...

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

◆ pointZone() [2/6]

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

Construct from components.

Definition at line 63 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 76 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 89 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 102 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 115 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 autoPtr< T >::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 178 of file pointZone.H.

References zoneIdentifier::index(), and autoPtr< T >::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 35 of file pointZoneNew.C.

References DebugInFunction, dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, and Foam::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 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.

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(), zoneIdentifier::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< T >::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< T >::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 List< T >::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:

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

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/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ labelsName