surfZone Class Reference

A surface zone on a MeshedSurface. More...

#include <surfZone.H>

Inheritance diagram for surfZone:

Collaboration diagram for surfZone:

Public Member Functions
	surfZone (const surfZone &)=default
	Copy construct.
surfZone &	operator= (const surfZone &)=default
	Copy assignment.
	surfZone ()
	Default construct, with zero start, size, index.
	surfZone (const word &name, const label size)
	Construct with name, size. With zero start, index.
	surfZone (const word &name, const label size, const label start, const label index, const word &geometricType=word::null)
	Construct from components.
	surfZone (const word &name, const dictionary &dict, const label index)
	Construct from dictionary.
	surfZone (const surfZone &, const label index)
	Copy construct, resetting the index.
autoPtr< surfZone >	clone () const
	Return clone.
label	start () const
	The start label of this zone in the face list.
label &	start ()
	Modifiable start label of this zone in the face list.
label	size () const
	The size of this zone in the face list.
label &	size ()
	Modifiable size of this zone in the face list.
labelRange	range () const
	The start/size range of this zone.
void	write (Ostream &os) const
	Write dictionary, includes surrounding braces.
	surfZone (Istream &is, const label index)=delete
	Removed(2020-01) Construct from Istream.
void	writeDict (Ostream &os) const
	Deprecated(2020-01) Write dictionary.
Public Member Functions inherited from surfZoneIdentifier
	surfZoneIdentifier (const surfZoneIdentifier &)=default
	Copy construct.
	surfZoneIdentifier (surfZoneIdentifier &&)=default
	Move construct.
surfZoneIdentifier &	operator= (const surfZoneIdentifier &)=default
	Copy assignment.
surfZoneIdentifier &	operator= (surfZoneIdentifier &&)=default
	Move assignment.
	surfZoneIdentifier ()
	Default construct. Uses name="", index=0.
	surfZoneIdentifier (const label index)
	Construct with name="" and specified index.
	surfZoneIdentifier (const word &name, const label index)
	Construct from mandatory components.
	surfZoneIdentifier (const word &name, const label index, const word &geometricType)
	Construct from components.
	surfZoneIdentifier (const word &name, const dictionary &dict, const label index)
	Construct from dictionary.
	surfZoneIdentifier (const surfZoneIdentifier &ident, const label newIndex)
	Copy construct, resetting the index (if non-negative).
	surfZoneIdentifier (surfZoneIdentifier &&ident, const label newIndex)
	Move construct, resetting the index (if non-negative).
const word &	name () const noexcept
	The patch/zone name.
word &	name () noexcept
	Modifiable patch/zone name.
const word &	geometricType () const noexcept
	The (optional) geometric type of the patch/zone.
word &	geometricType () noexcept
	Modifiable (optional) geometric type of the patch/zone.
label	index () const noexcept
	The index of this patch/zone in the surface mesh.
label &	index () noexcept
	Modifiable index of this patch/zone in the surface mesh.
void	write (Ostream &os) const
	Write (geometricType) dictionary entry (without surrounding braces).

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".

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

Detailed Description

A surface zone on a MeshedSurface.

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

Source files

• surfZone.H
• surfZone.C

Definition at line 52 of file surfZone.H.

Constructor & Destructor Documentation

surfZone() [1/7]

surfZone ( const surfZone & )

default

Copy construct.

References surfZone().

Referenced by operator=(), surfZone(), and surfZone().

Here is the call graph for this function:

Here is the caller graph for this function:

surfZone() [2/7]

surfZone

(

)

Default construct, with zero start, size, index.

Definition at line 27 of file surfZone.C.

References surfZoneIdentifier::surfZoneIdentifier().

Here is the call graph for this function:

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.

References surfZoneIdentifier::name(), size(), and surfZoneIdentifier::surfZoneIdentifier().

Here is the call graph for this function:

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 43 of file surfZone.C.

References surfZoneIdentifier::geometricType(), surfZoneIdentifier::index(), surfZoneIdentifier::name(), size(), start(), and surfZoneIdentifier::surfZoneIdentifier().

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 58 of file surfZone.C.

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

Here is the call graph for this function:

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(), and surfZone().

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

References surfZoneIdentifier::index().

Here is the call graph for this function:

Member Function Documentation

operator=()

surfZone & operator= ( const surfZone & )

default

Copy assignment.

References dict, surfZoneIdentifier::geometricType(), surfZoneIdentifier::index(), surfZoneIdentifier::name(), word::null, size(), start(), and surfZone().

Here is the call graph for this function:

clone()

autoPtr< surfZone > clone ( ) const

inline

Return clone.

Definition at line 126 of file surfZone.H.

References NotImplemented.

New()

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< Face >::checkZones(), surfMesh::checkZones(), operator=(), Foam::operator==(), surfZone(), and write().

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< Face >::checkZones(), surfMesh::checkZones(), operator=(), Foam::operator==(), surfZone(), surfZone(), and write().

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.

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 name, os(), size(), start(), and surfZoneIdentifier::write().

Referenced by Foam::operator<<().

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(), write(), and writeDict().

Referenced by writeDict().

Here is the call graph for this function:

Here is the caller 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