boundaryPatch Class Reference

Like polyPatch but without reference to mesh. Used in boundaryMesh to hold data on patches. The patchIdentifier::index is set, but not used. More...

#include <boundaryPatch.H>

Inheritance diagram for boundaryPatch:

Collaboration diagram for boundaryPatch:

Public Member Functions
	boundaryPatch (const word &name, const label index, const label size, const label start, const word &physicalType=word::null)
	Construct from components.
	boundaryPatch (const word &name, const dictionary &dict, const label index)
	Construct from dictionary.
	boundaryPatch (const boundaryPatch &p, const label index)
	Copy construct, resetting the index.
autoPtr< boundaryPatch >	clone () const
	Clone.
label	start () const noexcept
	The start of the patch.
label &	start () noexcept
	The start of the patch (modifiable).
label	size () const noexcept
	The size of the patch.
label &	size () noexcept
	The size of the patch (modifiable).
labelRange	range () const noexcept
	Return start/size range of this patch.
virtual void	write (Ostream &os) const
	Write dictionary entries (without surrounding braces).
Public Member Functions inherited from patchIdentifier
	patchIdentifier (const patchIdentifier &)=default
	Copy construct.
	patchIdentifier (patchIdentifier &&)=default
	Move construct.
patchIdentifier &	operator= (const patchIdentifier &)=default
	Copy assignment.
patchIdentifier &	operator= (patchIdentifier &&)=default
	Move assignment.
virtual	~patchIdentifier ()=default
	Destructor.
	patchIdentifier ()
	Default construct: name="", index=0.
	patchIdentifier (const word &name, const label index)
	Construct from mandatory components.
	patchIdentifier (const word &name, const label index, const word &physicalType, const wordList &inGroups=wordList())
	Construct from components.
	patchIdentifier (const word &name, const dictionary &dict, const label index)
	Construct from dictionary.
	patchIdentifier (const patchIdentifier &ident, const label newIndex)
	Copy construct, resetting the index (if non-negative).
	patchIdentifier (patchIdentifier &&ident, const label newIndex)
	Move construct, resetting the index (if non-negative).
const word &	name () const noexcept
	The patch name.
word &	name () noexcept
	Modifiable patch name.
label	index () const noexcept
	The index of this patch in the boundaryMesh.
label &	index () noexcept
	Modifiable index of this patch in the boundaryMesh.
const word &	physicalType () const noexcept
	The (optional) physical type of the patch.
word &	physicalType () noexcept
	Modifiable (optional) physical type of the patch.
const wordList &	inGroups () const noexcept
	The (optional) groups that the patch belongs to.
wordList &	inGroups () noexcept
	Modifiable (optional) groups that the patch belongs to.
bool	inGroup (const word &name) const
	True if given name is in a group.
void	addGroup (const word &name)
	Add (unique) group for the patch.
void	removeGroup (const word &name)
	Remove group for the patch.
void	write (Ostream &os) const
	Write (physicalType, inGroups) dictionary entries (without surrounding braces).

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

Detailed Description

Like polyPatch but without reference to mesh. Used in boundaryMesh to hold data on patches. The patchIdentifier::index is set, but not used.

Source files

• boundaryPatch.H
• boundaryPatch.C

Definition at line 51 of file boundaryPatch.H.

Constructor & Destructor Documentation

boundaryPatch() [1/3]

boundaryPatch	(	const word &	name,
		const label	index,
		const label	size,
		const label	start,
		const word &	physicalType = word::null )

Construct from components.

Definition at line 28 of file boundaryPatch.C.

References patchIdentifier::index(), patchIdentifier::name(), patchIdentifier::patchIdentifier(), patchIdentifier::physicalType(), size(), and start().

Referenced by boundaryPatch().

Here is the call graph for this function:

Here is the caller graph for this function:

boundaryPatch() [2/3]

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

Construct from dictionary.

Definition at line 43 of file boundaryPatch.C.

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

Here is the call graph for this function:

boundaryPatch() [3/3]

boundaryPatch	(	const boundaryPatch &	p,
		const label	index )

Copy construct, resetting the index.

Definition at line 56 of file boundaryPatch.C.

References boundaryPatch(), patchIdentifier::index(), and p.

Here is the call graph for this function:

Member Function Documentation

clone()

autoPtr< boundaryPatch > clone ( ) const

inline

Clone.

Definition at line 105 of file boundaryPatch.H.

References autoPtr< T >::New().

Here is the call graph for this function:

start() [1/2]

label start ( ) const

inlinenoexcept

The start of the patch.

Definition at line 116 of file boundaryPatch.H.

References Foam::noexcept.

Referenced by boundaryMesh::addPatch(), boundaryPatch(), boundaryMesh::changeFaces(), boundaryMesh::changePatchType(), boundaryMesh::deletePatch(), boundaryMesh::read(), boundaryMesh::readTriSurface(), boundaryMesh::whichPatch(), and boundaryMesh::writeTriSurface().

Here is the caller graph for this function:

start() [2/2]

label & start ( )

inlinenoexcept

The start of the patch (modifiable).

Definition at line 121 of file boundaryPatch.H.

References Foam::noexcept.

size() [1/2]

label size ( ) const

inlinenoexcept

The size of the patch.

Definition at line 126 of file boundaryPatch.H.

References Foam::noexcept.

Referenced by boundaryMesh::addPatch(), boundaryPatch(), boundaryMesh::changeFaces(), boundaryMesh::changePatchType(), boundaryMesh::deletePatch(), boundaryMesh::read(), boundaryMesh::readTriSurface(), and boundaryMesh::whichPatch().

Here is the caller graph for this function:

size() [2/2]

label & size ( )

inlinenoexcept

The size of the patch (modifiable).

Definition at line 131 of file boundaryPatch.H.

References Foam::noexcept.

range()

labelRange range ( ) const

inlinenoexcept

Return start/size range of this patch.

Definition at line 136 of file boundaryPatch.H.

References Foam::noexcept.

write()

void write ( Ostream & os ) const

virtual

Write dictionary entries (without surrounding braces).

Definition at line 66 of file boundaryPatch.C.

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

Here is the call graph for this function:

---

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

• src/dynamicMesh/boundaryPatch/boundaryPatch.H
• src/dynamicMesh/boundaryPatch/boundaryPatch.C