boundaryPatch Class Reference

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

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. More...
	boundaryPatch (const word &name, const dictionary &dict, const label index)
	Construct from dictionary. More...
	boundaryPatch (const boundaryPatch &)
	Construct as copy. More...
	boundaryPatch (const boundaryPatch &, const label index)
	Construct as copy, resetting the index. More...
autoPtr< boundaryPatch >	clone () const
	Clone. More...
	~boundaryPatch ()
	Destructor. More...
label	size () const
label &	size ()
label	start () const
label &	start ()
virtual void	write (Ostream &) const
	Write dictionary. More...
	TypeName ("patch")
	Runtime type information. More...
	boundaryPatch (const word &, const word &, const label, const label)
	boundaryPatch (const word &name, const dictionary &)
virtual autoPtr< boundaryPatchBase >	clone () const
virtual autoPtr< boundaryPatchBase >	clone (const boundaryPatch &wp) const
dictionary	dict () const
	Return as dictionary of entries. More...
void	write (Ostream &) const
	write to Ostream More...
void	writeDict (Ostream &) const
	Write dictionary. More...
Ostream &	operator<< (Ostream &) const
Istream &	operator>> (Istream &)
void	operator= (const boundaryPatch &)
bool	operator!= (const boundaryPatch &) const
Public Member Functions inherited from patchIdentifier
	patchIdentifier (const word &name, const label index, const word &physicalType=word::null, const wordList &inGroups=wordList())
	Construct from components. More...
	patchIdentifier (const word &name, const dictionary &, const label index)
	Construct from dictionary. More...
	patchIdentifier (const patchIdentifier &, const label index)
	Construct from geometric patch, resetting the index. More...
virtual	~patchIdentifier ()
	Destructor. More...
const word &	name () const
	Return name. More...
word &	name ()
	Return name for modification. More...
const word &	physicalType () const
	Return the optional physical type of the patch. More...
word &	physicalType ()
	Return the optional physical type of the patch for modification. 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 for modification. More...
const wordList &	inGroups () const
	Return the optional groups patch belongs to. More...
wordList &	inGroups ()
	Return the optional groups patch belongs to for modification. More...
bool	inGroup (const word &) const
	Test if in group. More...
void	write (Ostream &) const
	Write patchIdentifier as a dictionary. More...

Private Attributes
label	size_
label	start_

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

Detailed Description

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

Source files

• boundaryPatch.H
• boundaryPatch.C

Definition at line 50 of file boundaryPatch.H.

Constructor & Destructor Documentation

boundaryPatch() [1/6]

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

Construct from components.

Definition at line 33 of file boundaryPatch.C.

boundaryPatch() [2/6]

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

Construct from dictionary.

Definition at line 48 of file boundaryPatch.C.

boundaryPatch() [3/6]

boundaryPatch

(

const boundaryPatch &

p

)

Construct as copy.

Definition at line 60 of file boundaryPatch.C.

boundaryPatch() [4/6]

boundaryPatch	(	const boundaryPatch &	p,
		const label	index
	)

Construct as copy, resetting the index.

Definition at line 68 of file boundaryPatch.C.

~boundaryPatch()

~boundaryPatch

(

)

Destructor.

Definition at line 84 of file boundaryPatch.C.

boundaryPatch() [5/6]

boundaryPatch	(	const word &	n,
		const word &	t,
		const label	nF,
		const label	sF
	)

Definition at line 46 of file boundaryPatch.C.

boundaryPatch() [6/6]

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

Definition at line 56 of file boundaryPatch.C.

Member Function Documentation

clone() [1/3]

Foam::autoPtr< Foam::boundaryPatch > clone

(

)

const

Clone.

Definition at line 76 of file boundaryPatch.C.

size() [1/2]

label size ( ) const

inline

Definition at line 97 of file boundaryPatch.H.

References boundaryPatch::size_.

Referenced by boundaryMesh::addPatch(), 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 ( )

inline

Definition at line 102 of file boundaryPatch.H.

References boundaryPatch::size_.

start() [1/2]

label start ( ) const

inline

Definition at line 107 of file boundaryPatch.H.

References boundaryPatch::start_.

Referenced by boundaryMesh::addPatch(), 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 ( )

inline

Definition at line 112 of file boundaryPatch.H.

References boundaryPatch::start_.

write() [1/2]

void write ( Ostream &  os ) const

virtual

Write dictionary.

Definition at line 90 of file boundaryPatch.C.

References token::END_STATEMENT, Foam::nl, patchIdentifier::write(), and Ostream::writeKeyword().

Here is the call graph for this function:

TypeName()

TypeName

(

"patch"

)

Runtime type information.

clone() [2/3]

virtual autoPtr<boundaryPatchBase> clone ( ) const

inlinevirtual

Definition at line 69 of file boundaryPatch.H.

clone() [3/3]

virtual autoPtr<boundaryPatchBase> clone ( const boundaryPatch &  wp ) const

inlinevirtual

Definition at line 83 of file boundaryPatch.H.

dict()

dictionary dict

(

)

const

Return as dictionary of entries.

Definition at line 63 of file boundaryPatch.C.

References dictionary::add().

Here is the call graph for this function:

write() [2/2]

void write

(

Ostream &

)

const

write to Ostream

writeDict()

void writeDict

(

Ostream &

os

)

const

Write dictionary.

Definition at line 80 of file boundaryPatch.C.

References boundaryPatch::operator<<.

operator<<()

Ostream & operator<<

(

Ostream &

os

)

const

Definition at line 85 of file boundaryPatch.C.

References token::BEGIN_BLOCK, token::END_BLOCK, token::END_STATEMENT, Foam::endl(), patchIdentifier::name_, and Foam::nl.

Here is the call graph for this function:

operator>>()

Istream & operator>>

(

Istream &

is

)

Definition at line 96 of file boundaryPatch.C.

References patchIdentifier::name_.

operator=()

void operator=

(

const boundaryPatch &

wp

)

Definition at line 108 of file boundaryPatch.C.

References patchIdentifier::name_.

operator!=()

bool operator!=

(

const boundaryPatch &

wp

)

const

Definition at line 116 of file boundaryPatch.C.

References patchIdentifier::name_.

Friends And Related Function Documentation

operator<<

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

friend

Referenced by boundaryPatch::writeDict().

Field Documentation

size_

label size_

private

Definition at line 56 of file boundaryPatch.H.

Referenced by boundaryPatch::size().

start_

label start_

private

Definition at line 57 of file boundaryPatch.H.

Referenced by boundaryPatch::start().

---

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

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