An identifier for a surface zone on a meshed surface. More...

#include <surfMesh/surfZoneIdentifier.H>

Detailed Description

An identifier for a surface zone on a meshed surface.

Similar in concept to a faceZone on the surface, but can also have a "geometricType" as well.

Source files

Definition at line 61 of file surfZoneIdentifier.H.

Inheritance diagram for surfZoneIdentifier:

List of all members.

Public Member Functions
	surfZoneIdentifier ()
	Construct null.
	surfZoneIdentifier (const word &name, const label index, const word &geometricType=word::null)
	Construct from components.
	surfZoneIdentifier (const word &name, const dictionary &, const label index)
	Construct from dictionary.
	surfZoneIdentifier (const surfZoneIdentifier &, const label index)
	Construct from another zone identifier, resetting the index.
virtual	~surfZoneIdentifier ()
const word &	name () const
	Return name.
word &	name ()
	Return name for modification.
const word &	geometricType () const
	Return the geometric type of the zone.
word &	geometricType ()
	Return the geometric type of the zone for modification.
label	index () const
	Return the index of this zone in the surface mesh.
void	write (Ostream &) const
	Write surfZoneIdentifier as a dictionary.

Friends
Ostream &	operator<< (Ostream &, const surfZoneIdentifier &)
	Write surfZoneIdentifier as a dictionary.

Constructor & Destructor Documentation

surfZoneIdentifier ( )

Construct null.

Definition at line 31 of file surfZoneIdentifier.C.

surfZoneIdentifier	(	const word &	name,
		const label	index,
		const word &	geometricType = `word::null`
	)

Construct from components.

Definition at line 40 of file surfZoneIdentifier.C.

surfZoneIdentifier	(	const word &	name,
		const dictionary &	dict,
		const label	index
	)

Construct from dictionary.

Definition at line 53 of file surfZoneIdentifier.C.

References dictionary::readIfPresent().

surfZoneIdentifier	(	const surfZoneIdentifier &	p,
		const label	index
	)

Construct from another zone identifier, resetting the index.

Definition at line 67 of file surfZoneIdentifier.C.

~surfZoneIdentifier ( )

virtual

Definition at line 80 of file surfZoneIdentifier.C.

Member Function Documentation

const word& name ( ) const

inline

Return name.

Definition at line 115 of file surfZoneIdentifier.H.

Referenced by surfZone::New(), surfZone::surfZone(), OBJsurfaceFormat< Face >::write(), AC3DsurfaceFormat< Face >::write(), and STLsurfaceFormat< Face >::writeAscii().

word& name ( )

inline

Return name for modification.

Definition at line 121 of file surfZoneIdentifier.H.

const word& geometricType ( ) const

inline

Return the geometric type of the zone.

Definition at line 127 of file surfZoneIdentifier.H.

Referenced by surfZone::operator==().

word& geometricType ( )

inline

Return the geometric type of the zone for modification.

Definition at line 133 of file surfZoneIdentifier.H.

label index ( ) const

inline

Return the index of this zone in the surface mesh.

Definition at line 139 of file surfZoneIdentifier.H.

void write ( Ostream & os ) const

Write surfZoneIdentifier as a dictionary.

Reimplemented in surfZone.

Definition at line 87 of file surfZoneIdentifier.C.

References token::END_STATEMENT, Foam::nl, and Ostream::writeKeyword().

Referenced by Foam::operator<<(), and surfZone::writeDict().

Friends And Related Function Documentation

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

friend

Write surfZoneIdentifier as a dictionary.

void writeDict(Ostream&) const;

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

src/surfMesh/surfZone/surfZoneIdentifier/surfZoneIdentifier.H
src/surfMesh/surfZone/surfZoneIdentifier/surfZoneIdentifier.C

Detailed Description

Public Member Functions

Friends

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation