A 'patch' on surface as subset of triSurface. More...

Inheritance diagram for surfacePatch:

Collaboration diagram for surfacePatch:

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

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

	surfacePatch ()
	Default construct, with zero start, size, index=-1. More...

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

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

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

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

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

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

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

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

	operator surfZone () const
	Conversion to surfZone representation. More...

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

	surfacePatch (const word &geometricType, const word &name, const label size, const label start, const label index)
	Deprecated(2020-01) Construct from components. More...

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

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

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

	geometricSurfacePatch ()

	geometricSurfacePatch (const label index)

	geometricSurfacePatch (const word &name, const label index)
	Construct from mandatory components, type="". More...

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

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

	geometricSurfacePatch (const surfZoneIdentifier &ident)
	Implicit conversion from surfZoneIdentifier. More...

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

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

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

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

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

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

void	write (Ostream &os) const

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

	geometricSurfacePatch (const word &geometricType, const word &name, const label index)
	Deprecated(2020-01) Construct from components. More...

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

Additional Inherited Members
Static Public Member Functions inherited from geometricSurfacePatch
static word	defaultName (const label n=-1)
	Default patch name: "patch" or "patchN". More...

Static Public Attributes inherited from geometricSurfacePatch
static constexpr const char *const	emptyType = "empty"
	The name for an 'empty' type. More...

Detailed Description

A 'patch' on surface as subset of triSurface.

Source files

Definition at line 54 of file surfacePatch.H.

Constructor & Destructor Documentation

◆ surfacePatch() [1/7]

surfacePatch ( const surfacePatch & )

default

Copy construct.

◆ surfacePatch() [2/7]

surfacePatch ( )

Default construct, with zero start, size, index=-1.

Definition at line 35 of file surfacePatch.C.

◆ surfacePatch() [3/7]

surfacePatch ( const label index )

explicit

Construct null with specified index.

Definition at line 41 of file surfacePatch.C.

◆ surfacePatch() [4/7]

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

Construct from components.

Definition at line 50 of file surfacePatch.C.

◆ surfacePatch() [5/7]

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

Construct from dictionary.

Definition at line 65 of file surfacePatch.C.

◆ surfacePatch() [6/7]

surfacePatch	(	Istream &	is,
		const label	index
	)

delete

Removed(2020-01) Construct from Istream.

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

◆ surfacePatch() [7/7]

surfacePatch	(	const word &	geometricType,
		const word &	name,
		const label	size,
		const label	start,
		const label	index
	)

inline

Deprecated(2020-01) Construct from components.

Deprecated:: (2020-01) - order inconsistent with other identifiers

Definition at line 152 of file surfacePatch.H.

Member Function Documentation

◆ operator=()

surfacePatch& operator= ( const surfacePatch & )

default

Copy assignment.

◆ start() [1/2]

label start ( ) const

inlinenoexcept

Return start label of this patch in the face list.

Definition at line 108 of file surfacePatch.H.

Referenced by Foam::operator<<(), and Foam::operator==().

Here is the caller graph for this function:

◆ start() [2/2]

label& start ( )

inlinenoexcept

Return start label of this patch in the face list.

Definition at line 114 of file surfacePatch.H.

◆ size() [1/2]

label size ( ) const

inlinenoexcept

Return size of this patch in the face list.

Definition at line 120 of file surfacePatch.H.

Referenced by Foam::operator<<(), and Foam::operator==().

Here is the caller graph for this function:

◆ size() [2/2]

label& size ( )

inlinenoexcept

Return size of this patch in the face list.

Definition at line 126 of file surfacePatch.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 79 of file surfacePatch.C.

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

Referenced by surfacePatch::writeDict().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator surfZone()

operator surfZone ( ) const

explicit

Conversion to surfZone representation.

◆ writeDict()

void writeDict ( Ostream & os ) const

inline

Deprecated(2020-01) Ostream output.

Deprecated:: (2020-01) - Ostream output

Definition at line 166 of file surfacePatch.H.

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

Here is the call graph for this function:

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

src/surfMesh/triSurface/patches/surfacePatch.H
src/surfMesh/triSurface/patches/surfacePatch.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ surfacePatch() [1/7]

◆ surfacePatch() [2/7]

◆ surfacePatch() [3/7]

◆ surfacePatch() [4/7]

◆ surfacePatch() [5/7]

◆ surfacePatch() [6/7]

◆ surfacePatch() [7/7]

Member Function Documentation

◆ operator=()

◆ start() [1/2]

◆ start() [2/2]

◆ size() [1/2]

◆ size() [2/2]

◆ write()

◆ operator surfZone()

◆ writeDict()