FreeFOAM The Cross-Platform CFD Toolkit
surfacePatch Class Reference

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

#include <triSurface/surfacePatch.H>


Detailed Description

+ Inheritance diagram for surfacePatch:
+ Collaboration diagram for surfacePatch:

List of all members.

Public Member Functions

 ClassName ("surfacePatch")
 Runtime type information.
 surfacePatch ()
 Construct null.
 surfacePatch (const word &geometricType, const word &name, const label size, const label start, const label index)
 Construct from components.
 surfacePatch (Istream &is, const label index)
 Construct from Istream.
 surfacePatch (const word &name, const dictionary &dict, const label index)
 Construct from dictionary.
 surfacePatch (const surfacePatch &)
 Construct as copy.
label start () const
 Return start label of this patch in the polyMesh face list.
label & start ()
 Return start label of this patch in the polyMesh face list.
label size () const
 Return size of this patch in the polyMesh face list.
label & size ()
 Return size of this patch in the polyMesh face list.
void write (Ostream &) const
 Write.
void writeDict (Ostream &) const
 Write dictionary.
bool operator!= (const surfacePatch &) const
bool operator== (const surfacePatch &) const
 compare.
- Public Member Functions inherited from geometricSurfacePatch
 ClassName ("geometricSurfacePatch")
 Runtime type information.
 geometricSurfacePatch ()
 Construct null.
 geometricSurfacePatch (const word &geometricType, const word &name, const label index)
 Construct from components.
 geometricSurfacePatch (Istream &, const label index)
 Construct from Istream.
 geometricSurfacePatch (const word &name, const dictionary &dict, const label index)
 Construct from dictionary.
const wordname () const
 Return name.
wordname ()
 Return name.
const wordgeometricType () const
 Return the type of the patch.
wordgeometricType ()
 Return the type of the patch.
label index () const
 Return the index of this patch in the boundaryMesh.
label & index ()
 Return the index of this patch in the boundaryMesh.
bool operator!= (const geometricSurfacePatch &) const
bool operator== (const geometricSurfacePatch &) const
 compare.

Friends

Ostreamoperator<< (Ostream &, const surfacePatch &)

Constructor & Destructor Documentation

Construct null.

Definition at line 41 of file surfacePatch.C.

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

Construct from components.

Definition at line 52 of file surfacePatch.C.

surfacePatch ( Istream is,
const label  index 
)

Construct from Istream.

Definition at line 67 of file surfacePatch.C.

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

Construct from dictionary.

Definition at line 79 of file surfacePatch.C.

surfacePatch ( const surfacePatch sp)

Construct as copy.

Definition at line 92 of file surfacePatch.C.


Member Function Documentation

ClassName ( "surfacePatch"  )

Runtime type information.

label start ( ) const
inline

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

Definition at line 103 of file surfacePatch.H.

Referenced by surfacePatch::operator==().

label& start ( )
inline

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

Definition at line 109 of file surfacePatch.H.

label size ( ) const
inline

Return size of this patch in the polyMesh face list.

Definition at line 115 of file surfacePatch.H.

Referenced by surfacePatch::operator==().

label& size ( )
inline

Return size of this patch in the polyMesh face list.

Definition at line 121 of file surfacePatch.H.

void write ( Ostream os) const

Write.

Reimplemented from geometricSurfacePatch.

Definition at line 102 of file surfacePatch.C.

References Foam::endl(), Foam::nl, and Foam::tab.

void writeDict ( Ostream os) const

Write dictionary.

Reimplemented from geometricSurfacePatch.

Definition at line 109 of file surfacePatch.C.

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

bool operator!= ( const surfacePatch p) const

Definition at line 123 of file surfacePatch.C.

References p.

bool operator== ( const surfacePatch p) const

Friends And Related Function Documentation

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

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