A surface zone on a MeshedSurface. More...

Inheritance diagram for surfZone:

Collaboration diagram for surfZone:

Public Member Functions
	surfZone (const surfZone &)=default
	Copy construct. More...

surfZone &	operator= (const surfZone &)=default
	Copy assignment. More...

	surfZone ()
	Default construct, 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 (const word &name, const dictionary &dict, const label index)
	Construct from dictionary. More...

	surfZone (const surfZone &, const label index)
	Copy construct, resetting the index. More...

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

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

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

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

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

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

void	write (Ostream &os) const
	Write dictionary, includes surrounding braces. More...

	surfZone (Istream &is, const label index)=delete
	Removed(2020-01) Construct from Istream. More...

void	writeDict (Ostream &os) const
	Deprecated(2020-01) Write dictionary. More...

Public Member Functions inherited from surfZoneIdentifier
	surfZoneIdentifier (const surfZoneIdentifier &)=default
	Copy construct. More...

surfZoneIdentifier &	operator= (const surfZoneIdentifier &)=default
	Copy assignment. More...

	surfZoneIdentifier ()
	Default construct. Uses name="", index=0. More...

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

	surfZoneIdentifier (const word &name, const label index)
	Construct from mandatory components. More...

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

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

	surfZoneIdentifier (const surfZoneIdentifier &ident, const label index)
	Copy construct, resetting the index. More...

const word &	name () const
	The patch/zone name. More...

word &	name ()
	Modifiable patch/zone name. More...

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

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

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

label &	index ()
	Modifiable index of this patch/zone in the surface mesh. More...

void	write (Ostream &os) const
	Write (geometricType) dictionary entry (without surrounding braces) More...

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

Static Public Member Functions inherited from surfZoneIdentifier
static word	defaultName (const label n=-1)
	Default zone name: "zone" or "zoneN". More...

Additional Inherited Members
Static Public Attributes inherited from surfZoneIdentifier
static constexpr const char *const	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 52 of file surfZone.H.

Constructor & Destructor Documentation

◆ surfZone() [1/7]

surfZone ( const surfZone & )

default

Copy construct.

◆ surfZone() [2/7]

surfZone ( )

Default construct, with zero start, size, index.

Definition at line 27 of file surfZone.C.

◆ surfZone() [3/7]

surfZone	(	const word &	name,
		const label	size
	)

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

Definition at line 35 of file surfZone.C.

◆ surfZone() [4/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 44 of file surfZone.C.

◆ surfZone() [5/7]

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

Construct from dictionary.

Definition at line 59 of file surfZone.C.

◆ surfZone() [6/7]

surfZone	(	const surfZone &	zone,
		const label	index
	)

Copy construct, resetting the index.

Definition at line 71 of file surfZone.C.

References surfZoneIdentifier::index().

Here is the call graph for this function:

◆ surfZone() [7/7]

surfZone	(	Istream &	is,
		const label	index
	)

delete

Removed(2020-01) Construct from Istream.

Deprecated:: (2020-01) - unused, inconsistent

Member Function Documentation

◆ operator=()

surfZone& operator= ( const surfZone & )

default

Copy assignment.

◆ clone()

autoPtr<surfZone> clone ( ) const

inline

Return clone.

Definition at line 126 of file surfZone.H.

References NotImplemented.

◆ New()

static autoPtr<surfZone> New ( Istream & is )

inlinestatic

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

The start label of this zone in the face list.

Definition at line 146 of file surfZone.H.

Referenced by MeshedSurface< Foam::face >::checkZones(), surfMesh::checkZones(), and Foam::operator==().

Here is the caller graph for this function:

◆ start() [2/2]

label& start ( )

inline

Modifiable start label of this zone in the face list.

Definition at line 154 of file surfZone.H.

◆ size() [1/2]

label size ( ) const

inline

The size of this zone in the face list.

Definition at line 162 of file surfZone.H.

Referenced by MeshedSurface< Foam::face >::checkZones(), surfMesh::checkZones(), and Foam::operator==().

Here is the caller graph for this function:

◆ size() [2/2]

label& size ( )

inline

Modifiable size of this zone in the face list.

Definition at line 170 of file surfZone.H.

◆ range()

labelRange range ( ) const

inline

The start/size range of this zone.

Definition at line 178 of file surfZone.H.

Referenced by sampledMeshedSurface::sampledMeshedSurface().

Here is the caller graph for this function:

◆ write()

void write ( Ostream & os ) const

Write dictionary, includes surrounding braces.

Warning: Prior to 2020-01 was identical to operator<< output

Definition at line 81 of file surfZone.C.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeDict()

void writeDict ( Ostream & os ) const

inline

Deprecated(2020-01) Write dictionary.

Deprecated:: (2020-01) - Write dictionary

Definition at line 206 of file surfZone.H.

References os(), and surfZone::write().

Here is the call graph for this function:

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

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

◆ operator=()

◆ clone()

◆ New()

◆ start() [1/2]

◆ start() [2/2]

◆ size() [1/2]

◆ size() [2/2]

◆ range()

◆ write()

◆ writeDict()