A surface zone on a MeshedSurface. More...

Inheritance diagram for surfZone:

Collaboration diagram for surfZone:

Public Member Functions
	ClassName ("surfZone")
	Runtime type information. More...

	surfZone ()
	Construct null with zero start, size, index. More...

	surfZone (const word &name, const label size)
	Construct with name, size. With zero start, index. More...

	surfZone (const word &name, const label size, const label start, const label index, const word &geometricType=word::null)
	Construct from components. More...

	surfZone (Istream &is, const label index)
	Construct from Istream. More...

	surfZone (const word &name, const dictionary &dict, const label index)
	Construct from dictionary. More...

	surfZone (const surfZone &)
	Construct as copy. More...

	surfZone (const surfZone &, const label index)
	Construct from another zone, resetting the index. More...

autoPtr< surfZone >	clone () const
	Return clone. More...

label	start () const
	Return start label of this zone in the face list. More...

label &	start ()
	Return start label of this zone in the face list. More...

label	size () const
	Return size of this zone in the face list. More...

label &	size ()
	Return size of this zone in the face list. More...

labelRange	range () const
	Return start/size range of this zone. More...

void	write (Ostream &) const
	Write. More...

void	writeDict (Ostream &) const
	Write dictionary. More...

bool	operator!= (const surfZone &) const

bool	operator== (const surfZone &) const
	compare. More...

Public Member Functions inherited from surfZoneIdentifier
	surfZoneIdentifier ()
	Construct null, with index zero. More...

	surfZoneIdentifier (const label index)
	Construct null with specified index. More...

	surfZoneIdentifier (const word &name, const label index, const word &geometricType=word::null)
	Construct from components. More...

	surfZoneIdentifier (const word &name, const dictionary &dict, const label index)
	Construct from dictionary. More...

	surfZoneIdentifier (const surfZoneIdentifier &p, const label index)
	Copy construct from another zone identifier, resetting the index. More...

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

const word &	name () const
	Return name. More...

word &	name ()
	Return name for modification. More...

const word &	geometricType () const
	Return the geometric type of the patch/zone. More...

word &	geometricType ()
	Return the geometric type of the patch/zone for modification. More...

label	index () const
	Return the index of this patch/zone in the surface mesh. More...

label &	index ()
	Return the index of this patch/zone for modification. More...

void	write (Ostream &os) const
	Write identifier as a dictionary. More...

Static Public Member Functions
static autoPtr< surfZone >	New (Istream &is)

Friends
Istream &	operator>> (Istream &, surfZone &)

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

Additional Inherited Members
Static Public Attributes inherited from surfZoneIdentifier
static const word	emptyType = "empty"
	The name for an 'empty' type. More...

Detailed Description

A surface zone on a MeshedSurface.

Similar in concept to a faceZone, but the face list is contiguous.

Source files

Definition at line 65 of file surfZone.H.

Constructor & Destructor Documentation

◆ surfZone() [1/7]

surfZone ( )

Construct null with zero start, size, index.

Definition at line 43 of file surfZone.C.

Referenced by surfZone::surfZone().

Here is the caller graph for this function:

◆ surfZone() [2/7]

surfZone	(	const word &	name,
		const label	size
	)

Construct with name, size. With zero start, index.

Definition at line 51 of file surfZone.C.

◆ surfZone() [3/7]

surfZone	(	const word &	name,
		const label	size,
		const label	start,
		const label	index,
		const word &	geometricType = `word::null`
	)

Construct from components.

Definition at line 60 of file surfZone.C.

◆ surfZone() [4/7]

surfZone	(	Istream &	is,
		const label	index
	)

Construct from Istream.

Definition at line 74 of file surfZone.C.

References dict, surfZoneIdentifier::index(), surfZoneIdentifier::name(), and surfZone::surfZone().

Here is the call graph for this function:

◆ surfZone() [5/7]

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

Construct from dictionary.

Definition at line 88 of file surfZone.C.

◆ surfZone() [6/7]

surfZone ( const surfZone & zone )

Construct as copy.

Definition at line 100 of file surfZone.C.

◆ surfZone() [7/7]

surfZone	(	const surfZone &	zone,
		const label	index
	)

Construct from another zone, resetting the index.

Definition at line 108 of file surfZone.C.

Member Function Documentation

◆ ClassName()

ClassName ( "surfZone" )

Runtime type information.

◆ clone()

autoPtr<surfZone> clone ( ) const

inline

Return clone.

Definition at line 120 of file surfZone.H.

References NotImplemented.

◆ New()

static autoPtr<surfZone> New ( Istream & is )

inlinestatic

Definition at line 126 of file surfZone.H.

References dict, surfZoneIdentifier::name(), and autoPtr< T >::New().

Here is the call graph for this function:

◆ start() [1/2]

label start ( ) const

inline

Return start label of this zone in the face list.

Definition at line 138 of file surfZone.H.

Referenced by surfZone::operator==(), discreteSurface::setZoneMap(), and sampledTriSurfaceMesh::setZoneMap().

Here is the caller graph for this function:

◆ start() [2/2]

label& start ( )

inline

Return start label of this zone in the face list.

Definition at line 144 of file surfZone.H.

◆ size() [1/2]

label size ( ) const

inline

Return size of this zone in the face list.

Definition at line 150 of file surfZone.H.

Referenced by surfZone::operator==(), discreteSurface::setZoneMap(), and sampledTriSurfaceMesh::setZoneMap().

Here is the caller graph for this function:

◆ size() [2/2]

label& size ( )

inline

Return size of this zone in the face list.

Definition at line 156 of file surfZone.H.

◆ range()

labelRange range ( ) const

inline

Return start/size range of this zone.

Definition at line 162 of file surfZone.H.

◆ write()

void write ( Ostream & os ) const

Write.

Definition at line 118 of file surfZone.C.

◆ writeDict()

void writeDict ( Ostream & os ) const

Write dictionary.

Definition at line 124 of file surfZone.C.

References Ostream::beginBlock(), Ostream::endBlock(), Foam::name(), Foam::start, surfZoneIdentifier::write(), and Ostream::writeEntry().

Here is the call graph for this function:

◆ operator!=()

bool operator!= ( const surfZone & rhs ) const

Definition at line 138 of file surfZone.C.

◆ operator==()

bool operator== ( const surfZone & rhs ) const

compare.

Definition at line 144 of file surfZone.C.

References surfZoneIdentifier::geometricType(), surfZone::size(), surfZone::start(), and Foam::start.

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator>>

Istream& operator>>	(	Istream &	,
		surfZone &
	)

friend

◆ operator<<

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

friend

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

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

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ surfZone() [1/7]

◆ surfZone() [2/7]

◆ surfZone() [3/7]

◆ surfZone() [4/7]

◆ surfZone() [5/7]

◆ surfZone() [6/7]

◆ surfZone() [7/7]

Member Function Documentation

◆ ClassName()

◆ clone()

◆ New()

◆ start() [1/2]

◆ start() [2/2]

◆ size() [1/2]

◆ size() [2/2]

◆ range()

◆ write()

◆ writeDict()

◆ operator!=()

◆ operator==()

Friends And Related Function Documentation

◆ operator>>

◆ operator<<