The geometricSurfacePatch is like patchIdentifier but for surfaces. Holds type, name and index. More...

Inheritance diagram for geometricSurfacePatch:

Classes
struct	fromIdentifier
	Helper to convert identifier types as an operation. More...

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

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

	geometricSurfacePatch ()
	Default construct, use index=0, name="patch". More...

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

	geometricSurfacePatch (const word &name, const label index)
	Construct from mandatory components. 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
	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

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

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

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

Detailed Description

The geometricSurfacePatch is like patchIdentifier but for surfaces. Holds type, name and index.

Source files

Definition at line 52 of file geometricSurfacePatch.H.

Constructor & Destructor Documentation

◆ geometricSurfacePatch() [1/9]

geometricSurfacePatch ( const geometricSurfacePatch & )

default

Copy construct.

◆ geometricSurfacePatch() [2/9]

geometricSurfacePatch ( )

Default construct, use index=0, name="patch".

Definition at line 57 of file geometricSurfacePatch.C.

Referenced by geometricSurfacePatch::fromIdentifier::operator()().

Here is the caller graph for this function:

◆ geometricSurfacePatch() [3/9]

geometricSurfacePatch ( const label index )

explicit

Construct null with specified index.

Definition at line 63 of file geometricSurfacePatch.C.

◆ geometricSurfacePatch() [4/9]

geometricSurfacePatch	(	const word &	name,
		const label	index
	)

Construct from mandatory components.

Definition at line 72 of file geometricSurfacePatch.C.

◆ geometricSurfacePatch() [5/9]

geometricSurfacePatch	(	const word &	name,
		const label	index,
		const word &	geometricType
	)

Construct from components.

Definition at line 84 of file geometricSurfacePatch.C.

◆ geometricSurfacePatch() [6/9]

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

Construct from dictionary.

Definition at line 97 of file geometricSurfacePatch.C.

References dict, and dictionary::readIfPresent().

Here is the call graph for this function:

◆ geometricSurfacePatch() [7/9]

geometricSurfacePatch ( const surfZoneIdentifier & ident )

Implicit conversion from surfZoneIdentifier.

Definition at line 112 of file geometricSurfacePatch.C.

◆ geometricSurfacePatch() [8/9]

geometricSurfacePatch	(	Istream &	is,
		const label	index
	)

delete

Removed(2020-01) Construct from Istream.

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

◆ geometricSurfacePatch() [9/9]

geometricSurfacePatch	(	const word &	geometricType,
		const word &	name,
		const label	index
	)

Deprecated(2020-01) Construct from components.

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

Definition at line 197 of file geometricSurfacePatch.C.

Member Function Documentation

◆ defaultName()

static word defaultName ( const label n = -1 )

inlinestatic

Default patch name: "patch" or "patchN".

Definition at line 76 of file geometricSurfacePatch.H.

References n.

Referenced by boundaryMesh::readTriSurface().

Here is the caller graph for this function:

◆ operator=()

geometricSurfacePatch& operator= ( const geometricSurfacePatch & )

default

Copy assignment.

◆ name() [1/2]

const word& name ( ) const

inline

The patch/zone name.

Definition at line 144 of file geometricSurfacePatch.H.

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

Here is the caller graph for this function:

◆ name() [2/2]

word& name ( )

inline

Modifiable patch/zone name.

Definition at line 150 of file geometricSurfacePatch.H.

◆ geometricType() [1/2]

const word& geometricType ( ) const

inline

The geometric type of the patch/zone.

Definition at line 156 of file geometricSurfacePatch.H.

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

Here is the caller graph for this function:

◆ geometricType() [2/2]

word& geometricType ( )

inline

Modifiable geometric type of the patch/zone.

Definition at line 162 of file geometricSurfacePatch.H.

◆ index() [1/2]

label index ( ) const

inline

The index of this patch/zone in the surface mesh.

Definition at line 168 of file geometricSurfacePatch.H.

◆ index() [2/2]

label& index ( )

inline

Modifiable index of this patch/zone in the surface mesh.

Definition at line 174 of file geometricSurfacePatch.H.

◆ write()

void write ( Ostream & os ) const

Write (geometricType) dictionary entry (without surrounding braces)

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

Definition at line 122 of file geometricSurfacePatch.C.

References Ostream::writeEntry().

Referenced by surfacePatch::write(), and geometricSurfacePatch::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 204 of file geometricSurfacePatch.H.

References geometricSurfacePatch::write().

Here is the call graph for this function:

Member Data Documentation

◆ emptyType

constexpr const char* const emptyType = "empty"

staticconstexpr

The name for an 'empty' type.

Definition at line 70 of file geometricSurfacePatch.H.

Referenced by boundaryMesh::readTriSurface().

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

src/OpenFOAM/meshes/Identifiers/surface/geometricSurfacePatch.H
src/OpenFOAM/meshes/Identifiers/surface/geometricSurfacePatch.C

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ geometricSurfacePatch() [1/9]

◆ geometricSurfacePatch() [2/9]

◆ geometricSurfacePatch() [3/9]

◆ geometricSurfacePatch() [4/9]

◆ geometricSurfacePatch() [5/9]

◆ geometricSurfacePatch() [6/9]

◆ geometricSurfacePatch() [7/9]

◆ geometricSurfacePatch() [8/9]

◆ geometricSurfacePatch() [9/9]

Member Function Documentation

◆ defaultName()

◆ operator=()

◆ name() [1/2]

◆ name() [2/2]

◆ geometricType() [1/2]

◆ geometricType() [2/2]

◆ index() [1/2]

◆ index() [2/2]

◆ write()

◆ writeDict()

Member Data Documentation

◆ emptyType