surfacePatch Class Reference

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

#include <surfacePatch.H>

Inheritance diagram for surfacePatch:

Collaboration diagram for surfacePatch:

Public Member Functions
	surfacePatch (const surfacePatch &)=default
	Copy construct.
surfacePatch &	operator= (const surfacePatch &)=default
	Copy assignment.
	surfacePatch ()
	Default construct, with zero start, size, index=-1.
	surfacePatch (const label index)
	Default construct, with zero start, size, and specified index.
	surfacePatch (const word &name, const label size, const label start, const label index, const word &geometricType=word::null)
	Construct from components.
	surfacePatch (const word &name, const dictionary &dict, const label index)
	Construct from dictionary.
label	start () const noexcept
	Return start label of this patch in the face list.
label &	start () noexcept
	Return start label of this patch in the face list.
label	size () const noexcept
	Return size of this patch in the face list.
label &	size () noexcept
	Return size of this patch in the face list.
void	write (Ostream &os) const
	Write dictionary, includes surrounding braces.
	operator surfZone () const
	Conversion to surfZone representation.
	surfacePatch (Istream &is, const label index)=delete
	Removed(2020-01) Construct from Istream.
	surfacePatch (const word &geometricType, const word &name, const label size, const label start, const label index)
	Deprecated(2020-01) Construct from components.
void	writeDict (Ostream &os) const
	Deprecated(2020-01) Ostream output.
Public Member Functions inherited from geometricSurfacePatch
	geometricSurfacePatch (const geometricSurfacePatch &)=default
	Copy construct.
	geometricSurfacePatch (geometricSurfacePatch &&)=default
	Move construct.
geometricSurfacePatch &	operator= (const geometricSurfacePatch &)=default
	Copy assignment.
geometricSurfacePatch &	operator= (geometricSurfacePatch &&)=default
	Move assignment.
	geometricSurfacePatch ()
	Default construct. Uses name="patch", index=0, type="".
	geometricSurfacePatch (const label index)
	Construct null with specified index. Uses name="patch", type="".
	geometricSurfacePatch (const word &name, const label index)
	Construct from mandatory components, type="".
	geometricSurfacePatch (const word &name, const label index, const word &geometricType)
	Construct from components.
	geometricSurfacePatch (const word &name, const dictionary &dict, const label index)
	Construct from dictionary.
	geometricSurfacePatch (const surfZoneIdentifier &ident)
	Implicit conversion from surfZoneIdentifier.
const word &	name () const noexcept
	The patch/zone name.
word &	name () noexcept
	Modifiable patch/zone name.
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.
const word &	geometricType () const noexcept
	The geometric type of the patch/zone.
word &	geometricType () noexcept
	Modifiable geometric type of the patch/zone.
void	write (Ostream &os) const
	Write (geometricType) dictionary entry (without surrounding braces).
	geometricSurfacePatch (Istream &is, const label index)=delete
	Removed(2020-01) Construct from Istream.
	geometricSurfacePatch (const word &geometricType, const word &name, const label index)
	Deprecated(2020-01) Construct from components.
void	writeDict (Ostream &os) const
	Deprecated(2020-01) Write dictionary.

Additional Inherited Members
Static Public Member Functions inherited from geometricSurfacePatch
static word	defaultName (const label n=-1)
	Default patch name: "patch" or "patchN".
Static Public Attributes inherited from geometricSurfacePatch
static constexpr const char *const	emptyType = "empty"
	The name for an 'empty' type.

Detailed Description

A 'patch' on surface as subset of triSurface.

Source files

• surfacePatch.H
• surfacePatch.C

Definition at line 50 of file surfacePatch.H.

Constructor & Destructor Documentation

surfacePatch() [1/7]

surfacePatch ( const surfacePatch & )

default

Copy construct.

References surfacePatch().

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

Here is the call graph for this function:

Here is the caller graph for this function:

surfacePatch() [2/7]

surfacePatch

(

)

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

Definition at line 28 of file surfacePatch.C.

References surfacePatch().

Here is the call graph for this function:

surfacePatch() [3/7]

surfacePatch ( const label index )

explicit

Default construct, with zero start, size, and specified index.

Definition at line 34 of file surfacePatch.C.

References geometricSurfacePatch::geometricSurfacePatch(), and geometricSurfacePatch::index().

Here is the call graph for this function:

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 42 of file surfacePatch.C.

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

Here is the call graph for this function:

surfacePatch() [5/7]

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

Construct from dictionary.

Definition at line 57 of file surfacePatch.C.

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

Here is the call graph for this function:

surfacePatch() [6/7]

surfacePatch ( Istream & is, const label index )

delete

Removed(2020-01) Construct from Istream.

Deprecated

(2020-01) - unused, inconsistent

References geometricSurfacePatch::index().

Here is the call graph for this function:

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 182 of file surfacePatch.H.

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

Here is the call graph for this function:

Member Function Documentation

operator=()

surfacePatch & operator= ( const surfacePatch & )

default

Copy assignment.

References dict, geometricSurfacePatch::geometricType(), geometricSurfacePatch::index(), geometricSurfacePatch::name(), word::null, size(), start(), and surfacePatch().

Here is the call graph for this function:

start() [1/2]

label start ( ) const

inlinenoexcept

Return start label of this patch in the face list.

Definition at line 122 of file surfacePatch.H.

References Foam::noexcept.

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

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 130 of file surfacePatch.H.

References Foam::noexcept.

size() [1/2]

label size ( ) const

inlinenoexcept

Return size of this patch in the face list.

Definition at line 138 of file surfacePatch.H.

References Foam::noexcept.

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

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 146 of file surfacePatch.H.

References Foam::noexcept.

write()

void write

(

Ostream &

os

)

const

Write dictionary, includes surrounding braces.

Warning

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

Definition at line 72 of file surfacePatch.C.

References name, os(), size(), start(), and geometricSurfacePatch::write().

Here is the call 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 200 of file surfacePatch.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/triSurface/patches/surfacePatch.H
• src/surfMesh/triSurface/patches/surfacePatch.C