cellZone Class Reference

A subset of mesh cells. More...

Inheritance diagram for cellZone:

Collaboration diagram for cellZone:

Public Member Functions
	TypeName ("cellZone")
	declareRunTimeSelectionTable (autoPtr, cellZone, dictionary,(const word &name, const dictionary &dict, const label index, const cellZoneMesh &zm),(name, dict, index, zm))
	cellZone (const word &name, const label index, const cellZoneMesh &zm)
	cellZone (const word &name, const labelUList &addr, const label index, const cellZoneMesh &zm)
	cellZone (const word &name, labelList &&addr, const label index, const cellZoneMesh &zm)
	cellZone (const word &name, const dictionary &dict, const label index, const cellZoneMesh &zm)
	cellZone (const cellZone &origZone, const labelUList &addr, const label index, const cellZoneMesh &zm)
	cellZone (const cellZone &origZone, labelList &&addr, const label index, const cellZoneMesh &zm)
virtual autoPtr< cellZone >	clone (const cellZoneMesh &zm) const
virtual autoPtr< cellZone >	clone (const labelUList &addr, const label index, const cellZoneMesh &zm) const
virtual	~cellZone ()=default
const cellZoneMesh &	zoneMesh () const noexcept
label	whichCell (const label globalCellID) const
virtual bool	checkDefinition (const bool report=false) const
virtual bool	checkParallelSync (const bool report=false) const
virtual void	writeDict (Ostream &os) const
void	operator= (const cellZone &zn)
void	operator= (const labelUList &addr)
void	operator= (labelList &&addr)
Public Member Functions inherited from zone
	TypeName ("zone")
	zone ()
	zone (const word &name, const label index)
	zone (const word &name, const labelUList &addr, const label index)
	zone (const word &name, labelList &&addr, const label index)
	zone (const word &name, const dictionary &dict, const word &labelsName, const label index)
	zone (const zone &origZone, const labelUList &addr, const label index)
	zone (const zone &origZone, labelList &&addr, const label index)
virtual	~zone ()
const Map< label > &	lookupMap () const
label	localID (const label globalID) const
const labelList &	addressing () const noexcept
virtual void	clearAddressing ()
virtual bool	checkDefinition (const label maxSize, const bool report=false) const
virtual void	movePoints (const pointField &pts)
virtual void	write (Ostream &os) const
Public Member Functions inherited from zoneIdentifier
	zoneIdentifier (const zoneIdentifier &)=default
zoneIdentifier &	operator= (const zoneIdentifier &)=default
virtual	~zoneIdentifier ()=default
	zoneIdentifier ()
	zoneIdentifier (const word &name, const label index)
	zoneIdentifier (const word &name, const label index, const word &physicalType, const wordList &inGroups=wordList())
	zoneIdentifier (const word &name, const dictionary &dict, const label index)
	zoneIdentifier (const zoneIdentifier &ident, const label index)
const word &	name () const noexcept
word &	name () noexcept
label	index () const noexcept
label &	index () noexcept
const word &	physicalType () const noexcept
word &	physicalType () noexcept
const wordList &	inGroups () const noexcept
wordList &	inGroups () noexcept
bool	inGroup (const word &name) const
void	write (Ostream &os) const
Public Member Functions inherited from List
constexpr	List () noexcept
	List (const label len)
	List (const label len, const T &val)
	List (const label len, const Foam::zero)
	List (const Foam::one, const T &val)
	List (const Foam::one, T &&val)
	List (const Foam::one, const Foam::zero)
	List (const List< T > &a)
	List (const UList< T > &a)
	List (List< T > &a, bool reuse)
	List (const UList< T > &list, const labelUList &indices)
template<unsigned N>
	List (const UList< T > &list, const FixedList< label, N > &indices)
template<unsigned N>
	List (const FixedList< T, N > &list)
	List (const PtrList< T > &list)
	List (const SLList< T > &list)
template<class Addr >
	List (const IndirectListBase< T, Addr > &list)
	List (std::initializer_list< T > list)
	List (List< T > &&list)
template<int SizeMin>
	List (DynamicList< T, SizeMin > &&list)
	List (SortableList< T > &&list)
	List (SLList< T > &&list)
	List (Istream &is)
autoPtr< List< T > >	clone () const
	~List ()
void	clear ()
void	resize (const label len)
void	resize (const label len, const T &val)
void	resize_nocopy (const label len)
void	setSize (const label n)
void	setSize (const label n, const T &val)
void	append (const T &val)
void	append (T &&val)
void	append (const UList< T > &list)
template<class Addr >
void	append (const IndirectListBase< T, Addr > &list)
label	appendUniq (const T &val)
void	transfer (List< T > &list)
template<int SizeMin>
void	transfer (DynamicList< T, SizeMin > &list)
void	transfer (SortableList< T > &list)
T &	newElmt (const label i)
void	operator= (const UList< T > &a)
void	operator= (const List< T > &list)
void	operator= (const SLList< T > &list)
template<class Addr >
void	operator= (const IndirectListBase< T, Addr > &list)
template<unsigned N>
void	operator= (const FixedList< T, N > &list)
void	operator= (std::initializer_list< T > list)
void	operator= (const T &val)
void	operator= (const Foam::zero)
void	operator= (List< T > &&list)
template<int SizeMin>
void	operator= (DynamicList< T, SizeMin > &&list)
void	operator= (SortableList< T > &&list)
void	operator= (SLList< T > &&list)
Istream &	readList (Istream &is)
void	shallowCopy (const UList< T > &)=delete
template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	set (const label i, bool val=true)
template<class T >
	List (const label len)
template<class T >
	List (const label len, const T &val)
template<class T >
	List (const label len, const Foam::zero)
template<class T >
	List (const Foam::one, const T &val)
template<class T >
	List (const Foam::one, T &&val)
template<class T >
	List (const Foam::one, const Foam::zero)
template<class T >
	List (const UList< T > &a)
template<class T >
	List (const List< T > &a)
template<class T >
	List (List< T > &a, bool reuse)
template<class T >
	List (const UList< T > &list, const labelUList &indices)
template<class T >
	List (const PtrList< T > &list)
template<class T >
	List (const SLList< T > &list)
template<class T >
	List (std::initializer_list< T > list)
template<class T >
	List (List< T > &&list)
template<class T >
	List (SortableList< T > &&list)
template<class T >
	List (SLList< T > &&list)
template<class T >
void	transfer (List< T > &list)
template<class T >
void	transfer (SortableList< T > &list)
template<class T >
void	operator= (const UList< T > &a)
template<class T >
void	operator= (const List< T > &list)
template<class T >
void	operator= (const SLList< T > &list)
template<class T >
void	operator= (std::initializer_list< T > list)
template<class T >
void	operator= (List< T > &&list)
template<class T >
void	operator= (SortableList< T > &&list)
template<class T >
void	operator= (SLList< T > &&list)
Istream &	readList (Istream &is)
template<class T >
constexpr	List () noexcept
void	resize (const label newLen)
template<class T >
void	append (const T &val)
template<class T >
void	append (T &&val)
template<class T >
void	append (const UList< T > &list)
template<class T >
void	operator= (const T &val)
template<class T >
void	operator= (const Foam::zero)
template<class T >
	List (Istream &is)
Istream &	readList (Istream &is)

Static Public Member Functions
static autoPtr< cellZone >	New (const word &name, const dictionary &dict, const label index, const cellZoneMesh &zm)
Static Public Member Functions inherited from List
static const List< T > &	null ()

Static Public Attributes
static const char *const	labelsName = "cellLabels"

Friends
Ostream &	operator<< (Ostream &os, const cellZone &zn)

Additional Inherited Members
Public Types inherited from List
typedef SubList< T >	subList

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 cellZoneMesh, where all the zoned cells are registered with their zone number.

Source files

• cellZone.H
• cellZone.C
• cellZoneNew.C

Definition at line 58 of file cellZone.H.

Constructor & Destructor Documentation

cellZone() [1/6]

cellZone	(	const word &	name,
		const label	index,
		const cellZoneMesh &	zm
	)

Definition at line 44 of file cellZone.C.

cellZone() [2/6]

cellZone	(	const word &	name,
		const labelUList &	addr,
		const label	index,
		const cellZoneMesh &	zm
	)

Definition at line 56 of file cellZone.C.

cellZone() [3/6]

cellZone	(	const word &	name,
		labelList &&	addr,
		const label	index,
		const cellZoneMesh &	zm
	)

Definition at line 69 of file cellZone.C.

cellZone() [4/6]

cellZone	(	const word &	name,
		const dictionary &	dict,
		const label	index,
		const cellZoneMesh &	zm
	)

Definition at line 82 of file cellZone.C.

cellZone() [5/6]

cellZone	(	const cellZone &	origZone,
		const labelUList &	addr,
		const label	index,
		const cellZoneMesh &	zm
	)

Definition at line 95 of file cellZone.C.

cellZone() [6/6]

cellZone	(	const cellZone &	origZone,
		labelList &&	addr,
		const label	index,
		const cellZoneMesh &	zm
	)

Definition at line 108 of file cellZone.C.

~cellZone()

virtual ~cellZone ( )

virtualdefault

Member Function Documentation

TypeName()

TypeName

(

"cellZone"

)

declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		cellZone	,
		dictionary	,
		(const word &name, const dictionary &dict, const label index, const cellZoneMesh &zm)	,
		(name, dict, index, zm)
	)

clone() [1/2]

virtual autoPtr<cellZone> clone ( const cellZoneMesh &  zm ) const

inlinevirtual

Definition at line 163 of file cellZone.H.

References zoneIdentifier::index(), and autoPtr::New().

Here is the call graph for this function:

clone() [2/2]

virtual autoPtr<cellZone> clone ( const labelUList &  addr, const label  index, const cellZoneMesh &  zm  ) const

inlinevirtual

Definition at line 171 of file cellZone.H.

References zoneIdentifier::index(), and autoPtr::New().

Here is the call graph for this function:

New()

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

static

Definition at line 28 of file cellZoneNew.C.

References DebugInFunction, dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, and Foam::name().

Here is the call graph for this function:

zoneMesh()

const cellZoneMesh& zoneMesh ( ) const

inlinenoexcept

Definition at line 201 of file cellZone.H.

whichCell()

Foam::label whichCell

(

const label

globalCellID

)

const

Definition at line 122 of file cellZone.C.

References zone::localID().

Here is the call graph for this function:

checkDefinition()

bool checkDefinition ( const bool  report = false ) const

virtual

Implements zone.

Definition at line 128 of file cellZone.C.

References zone::checkDefinition().

Here is the call graph for this function:

checkParallelSync()

virtual bool checkParallelSync ( const bool  report = false ) const

inlinevirtual

Definition at line 215 of file cellZone.H.

writeDict()

void writeDict ( Ostream &  os ) const

virtual

Implements zone.

Definition at line 134 of file cellZone.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 cellZone &

zn

)

Definition at line 148 of file cellZone.C.

References List::operator=().

Here is the call graph for this function:

operator=() [2/3]

void operator=

(

const labelUList &

addr

)

Definition at line 155 of file cellZone.C.

References List::operator=().

Here is the call graph for this function:

operator=() [3/3]

void operator=

(

labelList &&

addr

)

Definition at line 162 of file cellZone.C.

References List::transfer().

Here is the call graph for this function:

Friends And Related Function Documentation

operator<<

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

friend

Member Data Documentation

labelsName

const char *const labelsName = "cellLabels"

static

Definition at line 80 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