A subset of mesh cells. More...

Inheritance diagram for cellZone:

Collaboration diagram for cellZone:

Public Member Functions
	TypeName ("cellZone")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, cellZone, dictionary,(const word &name, const dictionary &dict, const label index, const meshCellZones &mz),(name, dict, index, mz))

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

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

	cellZone (const word &name, const dictionary &, const label index, const meshCellZones &)
	Construct from dictionary. More...

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

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

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

virtual autoPtr< cellZone >	clone (const meshCellZones &mz) const
	Construct and return a clone, resetting the mesh zones. More...

virtual autoPtr< cellZone >	clone (const labelUList &addr, const label index, const meshCellZones &mz) const
	Construct and return a clone, resetting the cell list. More...

virtual	~cellZone ()
	Destructor. More...

label	whichCell (const label globalCellID) const
	Helper function to re-direct to zone::localID(...) More...

const meshCellZones &	meshZones () const
	Return meshZones reference. 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	writeDict (Ostream &) const
	Write dictionary. More...

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

void	operator= (cellZone &&)
	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	movePoints (const pointField &)
	Correct patch after moving points. 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< label >
	List ()
	Null constructor. More...

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

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

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

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

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

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

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

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

	List (InputIterator first, InputIterator last)
	Construct given start and end iterators. More...

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

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

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

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

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

	List (std::initializer_list< label >)
	Construct from an initialiser list. More...

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

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

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

	~List ()
	Destructor. More...

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

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

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

void	setSize (const label, const label &)
	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 label &)
	Append an element at the end of the list. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	operator= (const label &)
	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< cellZone >	New (const word &name, const dictionary &, const label index, const meshCellZones &)
	Return a pointer to a new cell 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 null UList. More...

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

Protected Attributes
const meshCellZones &	meshZones_
	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 cellZone &)
	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
	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 std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator for reverse traversal of UList. More...

typedef std::reverse_iterator< const_iterator >	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< label >
void	size (const label)
	Override size to be inconsistent with allocated storage. More...

Detailed Description

A subset of mesh cells.

Currently set up as an indirect list but will be extended to use a primitive mesh. For quick check whether a cell belongs to the zone use the lookup mechanism in meshCellZones, where all the zoned cells are registered with their zone number.

Source files

Definition at line 61 of file cellZone.H.

Constructor & Destructor Documentation

◆ cellZone() [1/6]

cellZone	(	const word &	name,
		const labelUList &	addr,
		const label	index,
		const meshCellZones &	mz
	)

Construct from components.

Definition at line 48 of file cellZone.C.

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

Here is the caller graph for this function:

◆ cellZone() [2/6]

cellZone	(	const word &	name,
		labelList &&	addr,
		const label	index,
		const meshCellZones &	mz
	)

Construct from components, transferring contents.

Definition at line 61 of file cellZone.C.

References cellZone::cellZone().

Here is the call graph for this function:

◆ cellZone() [3/6]

cellZone	(	const word &	name,
		const dictionary &	dict,
		const label	index,
		const meshCellZones &	mz
	)

Construct from dictionary.

Definition at line 74 of file cellZone.C.

References cellZone::cellZone().

Here is the call graph for this function:

◆ cellZone() [4/6]

cellZone	(	const cellZone &	cz,
		const labelUList &	addr,
		const label	index,
		const meshCellZones &	mz
	)

Construct given the original zone and resetting the.

cell list and mesh zones information

Definition at line 87 of file cellZone.C.

References cellZone::cellZone().

Here is the call graph for this function:

◆ cellZone() [5/6]

cellZone	(	const cellZone &	cz,
		labelList &&	addr,
		const label	index,
		const meshCellZones &	mz
	)

Construct given the original zone, resetting the.

cell list and mesh zones information

Definition at line 100 of file cellZone.C.

◆ cellZone() [6/6]

cellZone ( const cellZone & )

delete

Disallow default bitwise copy construction.

◆ ~cellZone()

~cellZone ( )

virtual

Destructor.

Definition at line 114 of file cellZone.C.

Referenced by cellZone::clone().

Here is the caller graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "cellZone" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		cellZone	,
		dictionary	,
		(const word &name, const dictionary &dict, const label index, const meshCellZones &mz)	,
		(name, dict, index, mz)
	)

◆ clone() [1/2]

virtual autoPtr<cellZone> clone ( const meshCellZones & mz ) const

inlinevirtual

Construct and return a clone, resetting the mesh zones.

Definition at line 157 of file cellZone.H.

References cellZone::cellZone(), List< label >::clone(), and zone::index().

Here is the call graph for this function:

◆ clone() [2/2]

virtual autoPtr<cellZone> clone	(	const labelUList &	addr,
		const label	index,
		const meshCellZones &	mz
	)		const

inlinevirtual

Construct and return a clone, resetting the cell list.

and mesh zones

Definition at line 168 of file cellZone.H.

References cellZone::cellZone(), cellZone::checkDefinition(), cellZone::checkParallelSync(), cellZone::meshZones(), cellZone::New(), cellZone::operator<<, cellZone::operator=(), cellZone::whichCell(), cellZone::writeDict(), and cellZone::~cellZone().

Here is the call graph for this function:

◆ New()

Foam::autoPtr< Foam::cellZone > New	(	const word &	name,
		const dictionary &	dict,
		const label	index,
		const meshCellZones &	mz
	)

static

Return a pointer to a new cell zone.

created on freestore from dictionary

Definition at line 32 of file cellZoneNew.C.

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

Referenced by cellZone::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ whichCell()

Foam::label whichCell ( const label globalCellID ) const

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

Definition at line 120 of file cellZone.C.

References zone::localID().

Referenced by cellZone::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ meshZones()

const Foam::meshCellZones & meshZones ( ) const

Return meshZones reference.

Definition at line 126 of file cellZone.C.

Referenced by cellZone::clone().

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 cellZone.C.

References zone::checkDefinition().

Referenced by cellZone::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkParallelSync()

virtual bool checkParallelSync ( const bool report = false ) const

inlinevirtual

Check whether zone is synchronised across coupled boundaries. Return.

true if in error.

Definition at line 211 of file cellZone.H.

Referenced by cellZone::clone().

Here is the caller graph for this function:

◆ writeDict()

void writeDict ( Ostream & os ) const

virtual

Write dictionary.

Implements zone.

Definition at line 138 of file cellZone.C.

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

Referenced by cellZone::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=() [1/4]

void operator= ( const cellZone & zn )

Assignment to zone, clearing demand-driven data.

Definition at line 151 of file cellZone.C.

References zone::operator=().

Referenced by cellZone::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=() [2/4]

void operator= ( cellZone && zn )

Move assignment to zone, clearing demand-driven data.

Definition at line 158 of file cellZone.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 165 of file cellZone.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 172 of file cellZone.C.

References zone::operator=().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator<<

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

friend

Ostream Operator.

Referenced by cellZone::clone().

Member Data Documentation

◆ meshZones_

const meshCellZones& meshZones_

protected

Reference to zone list.

Definition at line 71 of file cellZone.H.

◆ labelsName

const char *const labelsName = "cellLabels"

static

The name associated with the zone-labels dictionary entry.

Definition at line 79 of file cellZone.H.

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

src/OpenFOAM/meshes/polyMesh/zones/cellZone/cellZone.H
src/OpenFOAM/meshes/polyMesh/zones/cellZone/cellZone.C
src/OpenFOAM/meshes/polyMesh/zones/cellZone/cellZoneNew.C

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ cellZone() [1/6]

◆ cellZone() [2/6]

◆ cellZone() [3/6]

◆ cellZone() [4/6]

◆ cellZone() [5/6]

◆ cellZone() [6/6]

◆ ~cellZone()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ clone() [1/2]

◆ clone() [2/2]

◆ New()

◆ whichCell()

◆ meshZones()

◆ checkDefinition()

◆ checkParallelSync()

◆ writeDict()

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ meshZones_

◆ labelsName