Detailed Description

template<class ZoneType, class MeshType>
class Foam::ZoneMesh< ZoneType, MeshType >

List of mesh zones.

Source files

Definition at line 62 of file ZoneMesh.H.

Inheritance diagram for ZoneMesh< ZoneType, MeshType >:

Collaboration diagram for ZoneMesh< ZoneType, MeshType >:

List of all members.

Public Member Functions
	ZoneMesh (const IOobject &, const MeshType &)
	Read constructor given IOobject and a MeshType reference.
	ZoneMesh (const IOobject &, const MeshType &, const label size)
	Construct given size.
	~ZoneMesh ()
const MeshType &	mesh () const
	Return the mesh reference.
const Map< label > &	zoneMap () const
	Map of zones containing zone index for all zoned elements.
label	whichZone (const label objectIndex) const
	Given a global object index, return the zone it is in. If.
wordList	types () const
	Return a list of zone types.
wordList	names () const
	Return a list of zone names.
label	findZoneID (const word &zoneName) const
	Find zone index given a name.
void	clearAddressing ()
	Clear addressing.
void	clear ()
	Clear the zones.
bool	checkDefinition (const bool report=false) const
	Check zone definition. Return true if in error.
void	movePoints (const pointField &)
	Correct zone mesh after moving points.
bool	writeData (Ostream &) const
	writeData member function required by regIOobject
Public Member Functions inherited from PtrList< ZoneType >
	PtrList ()
	Null Constructor.
	PtrList (const label)
	Construct with length specified.
	PtrList (const PtrList< ZoneType > &)
	Copy constructor.
	PtrList (const PtrList< ZoneType > &, const CloneArg &)
	Copy constructor with additional argument for clone.
	PtrList (const Xfer< PtrList< ZoneType > > &)
	Construct by transferring the parameter contents.
	PtrList (PtrList< ZoneType > &, bool reUse)
	Construct as copy or re-use as specified.
	PtrList (const SLPtrList< ZoneType > &)
	Construct as copy of SLPtrList<T>
	PtrList (Istream &, const INew &)
	Construct from Istream using given Istream constructor class.
	PtrList (Istream &)
	Construct from Istream using default Istream constructor class.
	~PtrList ()
label	size () const
	Return the number of elements in the PtrList.
bool	empty () const
	Return true if the PtrList is empty (ie, size() is zero).
void	setSize (const label)
	Reset size of PtrList. This can only be used to set the size.
void	resize (const label)
	Reset size of PtrList. This can only be used to set the size.
void	transfer (PtrList< ZoneType > &)
	Transfer the contents of the argument PtrList into this PtrList.
Xfer< PtrList< ZoneType > >	xfer ()
	Transfer contents to the Xfer container.
bool	set (const label) const
	Is element set.
autoPtr< ZoneType >	set (const label, ZoneType *)
	Set element. Return old element (can be NULL).
autoPtr< ZoneType >	set (const label, const autoPtr< ZoneType > &)
autoPtr< ZoneType >	set (const label, const tmp< ZoneType > &)
void	reorder (const UList< label > &)
	Reorders elements. Ordering does not have to be done in.
const ZoneType &	operator[] (const label) const
	Return element const reference.
ZoneType &	operator[] (const label)
	Return element reference.
const ZoneType *	operator() (const label) const
	Return element const pointer.
PtrList< ZoneType > &	operator= (const PtrList< ZoneType > &)
	Assignment.
iterator	begin ()
	Return an iterator to begin traversing the PtrList.
iterator	end ()
	Return an iterator to end traversing the PtrList.
Public Member Functions inherited from regIOobject
	TypeName ("regIOobject")
	Runtime type information.
	regIOobject (const IOobject &, const bool isTime=false)
	Construct from IOobject. Optional flag for if IOobject is the.
	regIOobject (const regIOobject &)
	Construct as copy.
	regIOobject (const regIOobject &, bool registerCopy)
	Construct as copy, and transferring registry registration to copy.
virtual	~regIOobject ()
bool	checkIn ()
	Add object to registry.
bool	checkOut ()
	Remove object from registry.
bool	ownedByRegistry () const
	Is this object owned by the registry?
void	store ()
	Transfer ownership of this object to its registry.
void	release ()
	Release ownership of this object from its registry.
label	eventNo () const
	Event number at last update.
label &	eventNo ()
	Event number at last update.
bool	upToDate (const word &) const
	Am I uptodate with respect to other regIOobjects.
bool	upToDate (const word &, const word &) const
bool	upToDate (const word &, const word &, const word &) const
bool	upToDate (const word &, const word &, const word &, const word &) const
void	setUpToDate ()
	Flag me as up to date.
virtual void	rename (const word &newName)
	Rename.
Istream &	readStream (const word &)
	Return Istream and check object type against that given.
void	close ()
	Close Istream.
virtual bool	readData (Istream &)
	Virtual readData function.
virtual bool	read ()
	Read object.
virtual bool	modified () const
	Return true if the object's file has been modified.
virtual bool	readIfModified ()
	Read object if modified.
virtual bool	writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType) const
	Write using given format, version and compression.
virtual bool	write () const
	Write using setting from DB.
void	operator= (const IOobject &)
Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Runtime type information.
	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, registry, io options.
	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, local, registry, io options.
	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from path, registry, io options.
Foam::autoPtr< IOobject >	clone () const
	Clone.
virtual	~IOobject ()
const Time &	time () const
	Return time.
const objectRegistry &	db () const
	Return the local objectRegistry.
const word &	name () const
	Return name.
const word &	headerClassName () const
	Return name of the class name read from header.
string &	note ()
	Return non-constant access to the optional note.
const string &	note () const
	Return the optional note.
bool	registerObject () const
	Register object created from this IOobject with registry if true.
readOption	readOpt () const
readOption &	readOpt ()
writeOption	writeOpt () const
writeOption &	writeOpt ()
const fileName &	rootPath () const
const fileName &	caseName () const
const fileName &	instance () const
fileName &	instance ()
const fileName &	local () const
fileName	path () const
	Return complete path.
fileName	path (const word &instance, const fileName &local="") const
	Return complete path with alternative instance and local.
fileName	objectPath () const
	Return complete path + object name.
fileName	filePath () const
	Return complete path + object name if the file exists.
bool	readHeader (Istream &)
	Read header.
bool	headerOk ()
	Read and check header info.
bool	writeHeader (Ostream &) const
	Write header.
bool	good () const
bool	bad () const
InfoProxy< IOobject >	info () const
	Return info proxy.

Friends
Ostream &	operator (Ostream &, const ZoneMesh< ZoneType, MeshType > &)

Additional Inherited Members
Public Types inherited from PtrList< ZoneType >
typedef ZoneType	value_type
	Type of values the PtrList contains.
typedef ZoneType &	reference
	Type that can be used for storing into PtrList::value_type objects.
typedef const ZoneType &	const_reference
	Type that can be used for storing into constant PtrList::value_type.
Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *)
	Transfer ownership of the given object pointer to its registry.
template<class Type >
static Type &	store (autoPtr< Type > &)
	Transfer ownership of the given object pointer to its registry.
Static Public Member Functions inherited from IOobject
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components.
template<class Stream >
static Stream &	writeBanner (Stream &os, bool noHint=false)
	Write the standard OpenFOAM file/dictionary banner.
template<class Stream >
static Stream &	writeDivider (Stream &os)
	Write the standard file section divider.
template<class Stream >
static Stream &	writeEndDivider (Stream &os)
	Write the standard end file divider.
Static Public Attributes inherited from regIOobject
static int	fileModificationSkew
Protected Member Functions inherited from PtrList< ZoneType >
void	read (Istream &, const INew &inewt)
	Read from Istream using given Istream constructor class.