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

Inheritance diagram for geometricSurfacePatch:

Collaboration diagram for geometricSurfacePatch:

Public Member Functions
	ClassName ("geometricSurfacePatch")
	Runtime type information. More...

	geometricSurfacePatch ()
	Construct null. More...

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

	geometricSurfacePatch (Istream &, const label index)
	Construct from Istream. More...

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

const word &	name () const
	Return name. More...

word &	name ()
	Return name. More...

const word &	geometricType () const
	Return the type of the patch. More...

word &	geometricType ()
	Return the type of the patch. More...

label	index () const
	Return the index of this patch in the boundaryMesh. More...

label &	index ()
	Return the index of this patch in the boundaryMesh. More...

void	write (Ostream &) const
	Write. More...

void	writeDict (Ostream &) const
	Write dictionary. More...

bool	operator!= (const geometricSurfacePatch &) const

bool	operator== (const geometricSurfacePatch &) const
	compare. More...

	ClassName ("geometricSurfacePatch")
	Runtime type information. More...

	geometricSurfacePatch ()
	Construct null. More...

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

	geometricSurfacePatch (Istream &, const label index)
	Construct from Istream. More...

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

const word &	name () const
	Return name. More...

word &	name ()
	Return name. More...

const word &	geometricType () const
	Return the type of the patch. More...

word &	geometricType ()
	Return the type of the patch. More...

label	index () const
	Return the index of this patch in the boundaryMesh. More...

label &	index ()
	Return the index of this patch in the boundaryMesh. More...

void	write (Ostream &) const
	Write. More...

void	writeDict (Ostream &) const
	Write dictionary. More...

bool	operator!= (const geometricSurfacePatch &) const

bool	operator== (const geometricSurfacePatch &) const
	compare. More...

Private Attributes
word	geometricType_
	Type name of patch. More...

word	name_
	Name of patch. More...

label	index_
	Index of patch in boundary. More...

Friends
Ostream &	operator<< (Ostream &, const geometricSurfacePatch &)

Istream &	operator>> (Istream &, geometricSurfacePatch &)

Ostream &	operator<< (Ostream &, const geometricSurfacePatch &)

Istream &	operator>> (Istream &, geometricSurfacePatch &)

Detailed Description

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

Source files

Definition at line 53 of file geometricSurfacePatch.H.

Constructor & Destructor Documentation

◆ geometricSurfacePatch() [1/8]

geometricSurfacePatch ( )

Construct null.

Definition at line 41 of file geometricSurfacePatch.C.

◆ geometricSurfacePatch() [2/8]

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

Construct from components.

Definition at line 51 of file geometricSurfacePatch.C.

◆ geometricSurfacePatch() [3/8]

geometricSurfacePatch	(	Istream &	is,
		const label	index
	)

Construct from Istream.

Definition at line 70 of file geometricSurfacePatch.C.

References geometricSurfacePatch::geometricType_.

◆ geometricSurfacePatch() [4/8]

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

Construct from dictionary.

Definition at line 85 of file geometricSurfacePatch.C.

◆ geometricSurfacePatch() [5/8]

geometricSurfacePatch ( )

Construct null.

◆ geometricSurfacePatch() [6/8]

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

Construct from components.

◆ geometricSurfacePatch() [7/8]

geometricSurfacePatch	(	Istream &	,
		const label	index
	)

Construct from Istream.

◆ geometricSurfacePatch() [8/8]

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

Construct from dictionary.

Member Function Documentation

◆ ClassName() [1/2]

ClassName ( "geometricSurfacePatch" )

Runtime type information.

◆ name() [1/4]

const word& name ( ) const

inline

Return name.

Definition at line 101 of file geometricSurfacePatch.H.

References geometricSurfacePatch::name_.

Referenced by triSurface::calcPatches(), triSurfaceMetaData::createMetaData(), boundaryMesh::readTriSurface(), triSurface::writeAC(), and triSurface::writeSTLASCII().

Here is the caller graph for this function:

◆ name() [2/4]

word& name ( )

inline

Return name.

Definition at line 107 of file geometricSurfacePatch.H.

References geometricSurfacePatch::name_.

◆ geometricType() [1/4]

const word& geometricType ( ) const

inline

Return the type of the patch.

Definition at line 113 of file geometricSurfacePatch.H.

References geometricSurfacePatch::geometricType_.

Referenced by triSurface::calcPatches(), triSurfaceMetaData::createMetaData(), and boundaryMesh::readTriSurface().

Here is the caller graph for this function:

◆ geometricType() [2/4]

word& geometricType ( )

inline

Return the type of the patch.

Definition at line 119 of file geometricSurfacePatch.H.

References geometricSurfacePatch::geometricType_.

◆ index() [1/4]

label index ( ) const

inline

Return the index of this patch in the boundaryMesh.

Definition at line 125 of file geometricSurfacePatch.H.

References geometricSurfacePatch::index_.

Referenced by triSurface::calcPatches().

Here is the caller graph for this function:

◆ index() [2/4]

label& index ( )

inline

Return the index of this patch in the boundaryMesh.

Definition at line 131 of file geometricSurfacePatch.H.

References geometricSurfacePatch::index_.

◆ write() [1/2]

void write ( Ostream & os ) const

Write.

Definition at line 105 of file geometricSurfacePatch.C.

References geometricSurfacePatch::geometricType_, geometricSurfacePatch::name_, and Foam::nl.

Referenced by Foam::operator<<().

Here is the caller graph for this function:

◆ writeDict() [1/2]

void writeDict ( Ostream & os ) const

Write dictionary.

Definition at line 112 of file geometricSurfacePatch.C.

References geometricSurfacePatch::geometricType_, and Foam::nl.

Referenced by surfacePatch::writeDict().

Here is the caller graph for this function:

◆ operator!=() [1/2]

bool operator!= ( const geometricSurfacePatch & p ) const

Definition at line 120 of file geometricSurfacePatch.C.

References p.

◆ operator==() [1/2]

bool operator== ( const geometricSurfacePatch & p ) const

compare.

Definition at line 127 of file geometricSurfacePatch.C.

References Foam::name(), and p.

Here is the call graph for this function:

◆ ClassName() [2/2]

ClassName ( "geometricSurfacePatch" )

Runtime type information.

◆ name() [3/4]

const word& name ( ) const

inline

Return name.

Definition at line 100 of file geometricSurfacePatch.H.

References geometricSurfacePatch::name_.

◆ name() [4/4]

word& name ( )

inline

Return name.

Definition at line 106 of file geometricSurfacePatch.H.

References geometricSurfacePatch::name_.

◆ geometricType() [3/4]

const word& geometricType ( ) const

inline

Return the type of the patch.

Definition at line 112 of file geometricSurfacePatch.H.

References geometricSurfacePatch::geometricType_.

◆ geometricType() [4/4]

word& geometricType ( )

inline

Return the type of the patch.

Definition at line 118 of file geometricSurfacePatch.H.

References geometricSurfacePatch::geometricType_.

◆ index() [3/4]

label index ( ) const

inline

Return the index of this patch in the boundaryMesh.

Definition at line 124 of file geometricSurfacePatch.H.

References geometricSurfacePatch::index_.

◆ index() [4/4]

label& index ( )

inline

Return the index of this patch in the boundaryMesh.

Definition at line 130 of file geometricSurfacePatch.H.

References geometricSurfacePatch::index_.

◆ write() [2/2]

void write ( Ostream & ) const

Write.

◆ writeDict() [2/2]

void writeDict ( Ostream & ) const

Write dictionary.

◆ operator!=() [2/2]

bool operator!= ( const geometricSurfacePatch & ) const

◆ operator==() [2/2]

bool operator== ( const geometricSurfacePatch & ) const

compare.

Friends And Related Function Documentation

◆ operator<< [1/2]

Ostream& operator<<	(	Ostream &	os,
		const geometricSurfacePatch &	gp
	)

friend

Definition at line 148 of file geometricSurfacePatch.C.

◆ operator>> [1/2]

Istream& operator>>	(	Istream &	is,
		geometricSurfacePatch &	gp
	)

friend

Definition at line 140 of file geometricSurfacePatch.C.

◆ operator<< [2/2]

Ostream& operator<<	(	Ostream &	os,
		const geometricSurfacePatch &	gp
	)

friend

Definition at line 148 of file geometricSurfacePatch.C.

◆ operator>> [2/2]

Istream& operator>>	(	Istream &	is,
		geometricSurfacePatch &	gp
	)

friend

Definition at line 140 of file geometricSurfacePatch.C.

Field Documentation

◆ geometricType_

word geometricType_

private

Type name of patch.

Definition at line 58 of file geometricSurfacePatch.H.

Referenced by geometricSurfacePatch::geometricSurfacePatch(), geometricSurfacePatch::geometricType(), Foam::operator>>(), geometricSurfacePatch::write(), and geometricSurfacePatch::writeDict().

◆ name_

word name_

private

Name of patch.

Definition at line 61 of file geometricSurfacePatch.H.

Referenced by geometricSurfacePatch::name(), Foam::operator>>(), and geometricSurfacePatch::write().

◆ index_

label index_

private

Index of patch in boundary.

Definition at line 64 of file geometricSurfacePatch.H.

Referenced by geometricSurfacePatch::index().

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

src/immersedBoundary/immersedBoundary/triSurface/geometricSurfacePatch/geometricSurfacePatch.H
src/immersedBoundary/immersedBoundary/triSurface/geometricSurfacePatch/geometricSurfacePatch.C

Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ geometricSurfacePatch() [1/8]

◆ geometricSurfacePatch() [2/8]

◆ geometricSurfacePatch() [3/8]

◆ geometricSurfacePatch() [4/8]

◆ geometricSurfacePatch() [5/8]

◆ geometricSurfacePatch() [6/8]

◆ geometricSurfacePatch() [7/8]

◆ geometricSurfacePatch() [8/8]

Member Function Documentation

◆ ClassName() [1/2]

◆ name() [1/4]

◆ name() [2/4]

◆ geometricType() [1/4]

◆ geometricType() [2/4]

◆ index() [1/4]

◆ index() [2/4]

◆ write() [1/2]

◆ writeDict() [1/2]

◆ operator!=() [1/2]

◆ operator==() [1/2]

◆ ClassName() [2/2]

◆ name() [3/4]

◆ name() [4/4]

◆ geometricType() [3/4]

◆ geometricType() [4/4]

◆ index() [3/4]

◆ index() [4/4]

◆ write() [2/2]

◆ writeDict() [2/2]

◆ operator!=() [2/2]

◆ operator==() [2/2]

Friends And Related Function Documentation

◆ operator<< [1/2]

◆ operator>> [1/2]

◆ operator<< [2/2]

◆ operator>> [2/2]

Field Documentation

◆ geometricType_

◆ name_

◆ index_