surfacePatch Class Reference | OpenFOAM Source Code Guide

The OpenFOAM Foundation

'Patch' on surface as subset of triSurface. More...

Inheritance diagram for surfacePatch:

Inheritance graph

[legend]

Collaboration diagram for surfacePatch:

Collaboration graph

[legend]

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

	surfacePatch ()
	Construct null. More...

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

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

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

	surfacePatch (const surfacePatch &)
	Construct as copy. More...

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

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

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

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

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

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

bool	operator!= (const surfacePatch &) const

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

Public Member Functions inherited from geometricSurfacePatch
	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...

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

Detailed Description

'Patch' on surface as subset of triSurface.

Source files

Definition at line 58 of file surfacePatch.H.

Constructor & Destructor Documentation

◆ surfacePatch() [1/5]

surfacePatch ( )

Construct null.

Definition at line 39 of file surfacePatch.C.

Referenced by surfacePatch::surfacePatch().

Here is the caller graph for this function:

◆ surfacePatch() [2/5]

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

Construct from components.

Definition at line 48 of file surfacePatch.C.

◆ surfacePatch() [3/5]

surfacePatch	(	Istream &	is,
		const label	index
	)

Construct from Istream.

Definition at line 62 of file surfacePatch.C.

References Foam::readLabel(), and surfacePatch::surfacePatch().

Here is the call graph for this function:

◆ surfacePatch() [4/5]

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

Construct from dictionary.

Definition at line 74 of file surfacePatch.C.

◆ surfacePatch() [5/5]

surfacePatch ( const surfacePatch & sp )

Construct as copy.

Definition at line 86 of file surfacePatch.C.

Member Function Documentation

◆ ClassName()

ClassName ( "surfacePatch" )

Runtime type information.

◆ start() [1/2]

label start ( ) const

inline

Return start label of this patch in the polyMesh face list.

Definition at line 109 of file surfacePatch.H.

Referenced by triSurface::checkEdges(), surfacePatch::operator==(), surfacePatch::write(), and surfacePatch::writeDict().

Here is the caller graph for this function:

◆ start() [2/2]

label& start ( )

inline

Return start label of this patch in the polyMesh face list.

Definition at line 115 of file surfacePatch.H.

◆ size() [1/2]

label size ( ) const

inline

Return size of this patch in the polyMesh face list.

Definition at line 121 of file surfacePatch.H.

Referenced by triSurface::checkEdges(), surfacePatch::operator==(), surfacePatch::write(), and surfacePatch::writeDict().

Here is the caller graph for this function:

◆ size() [2/2]

label& size ( )

inline

Return size of this patch in the polyMesh face list.

Definition at line 127 of file surfacePatch.H.

References surfacePatch::operator!=(), surfacePatch::operator<<, surfacePatch::operator==(), surfacePatch::write(), and surfacePatch::writeDict().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

Write.

Definition at line 96 of file surfacePatch.C.

References Foam::endl(), Foam::nl, surfacePatch::size(), surfacePatch::start(), and Foam::tab.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeDict()

void writeDict ( Ostream & os ) const

Write dictionary.

Definition at line 103 of file surfacePatch.C.

References token::BEGIN_BLOCK, token::END_BLOCK, Foam::endl(), geometricSurfacePatch::name(), Foam::nl, surfacePatch::size(), surfacePatch::start(), and geometricSurfacePatch::writeDict().

Referenced by surfacePatch::size().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator!=()

bool operator!= ( const surfacePatch & p ) const

Definition at line 117 of file surfacePatch.C.

References p.

Referenced by surfacePatch::size().

Here is the caller graph for this function:

◆ operator==()

bool operator== ( const surfacePatch & p ) const

compare.

Definition at line 123 of file surfacePatch.C.

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

Referenced by surfacePatch::size().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator<<

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

friend

Referenced by surfacePatch::size().

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

src/triSurface/triSurface/surfacePatch/surfacePatch.H
src/triSurface/triSurface/surfacePatch/surfacePatch.C