Public Member Functions | Friends | List of all members
surfacePatch Class Reference

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

Inheritance diagram for surfacePatch:
[legend]
Collaboration diagram for surfacePatch:
[legend]

Public Member Functions

 ClassName ("surfacePatch")
 Runtime type information. More...
 
 surfacePatch ()
 Construct null. More...
 
 surfacePatch (const label index)
 Construct null with specified index. 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 face list. More...
 
label & start ()
 Return start label of this patch in the face list. More...
 
label size () const
 Return size of this patch in the face list. More...
 
label & size ()
 Return size of this patch in the face list. More...
 
void write (Ostream &) const
 Write. More...
 
void writeDict (Ostream &) const
 Write dictionary. More...
 
 operator surfZone () const
 Conversion to surfZone representation. More...
 
bool operator!= (const surfacePatch &) const
 Compare. More...
 
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 label index)
 Construct null with specified index. More...
 
 geometricSurfacePatch (const word &name, const label index, const word &geometricType=word::null)
 Construct from components. More...
 
 geometricSurfacePatch (const word &geometricType, const word &name, const label index)
 Construct from components. More...
 
 geometricSurfacePatch (const surfZoneIdentifier &ident)
 
 geometricSurfacePatch (const word &name, const dictionary &dict, const label index)
 Construct from dictionary. More...
 
 geometricSurfacePatch (Istream &is, const label index)
 Construct from Istream. More...
 
const word & name () const
 Return name. More...
 
word & name ()
 Return name. More...
 
const word & geometricType () const
 Return the geometric type of the patch. More...
 
word & geometricType ()
 Return the geometric type of the patch for modification. More...
 
label index () const
 Return the index of this patch in the surface mesh. More...
 
label & index ()
 Return the index of this patch in the surface mesh for modification. More...
 
void write (Ostream &os) const
 Write. More...
 
void writeDict (Ostream &os) const
 Write dictionary. More...
 

Friends

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

Additional Inherited Members

- Static Public Attributes inherited from geometricSurfacePatch
static const word emptyType = "empty"
 The name for an 'empty' type. More...
 

Detailed Description

'Patch' on surface as subset of triSurface.

Source files

Definition at line 60 of file surfacePatch.H.

Constructor & Destructor Documentation

◆ surfacePatch() [1/6]

surfacePatch ( )

Construct null.

Definition at line 43 of file surfacePatch.C.

◆ surfacePatch() [2/6]

surfacePatch ( const label  index)
explicit

Construct null with specified index.

Definition at line 51 of file surfacePatch.C.

◆ surfacePatch() [3/6]

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

Construct from components.

Definition at line 60 of file surfacePatch.C.

◆ surfacePatch() [4/6]

surfacePatch ( Istream &  is,
const label  index 
)

Construct from Istream.

Definition at line 74 of file surfacePatch.C.

◆ surfacePatch() [5/6]

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

Construct from dictionary.

Definition at line 85 of file surfacePatch.C.

◆ surfacePatch() [6/6]

surfacePatch ( const surfacePatch &  sp)

Construct as copy.

Definition at line 97 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 face list.

Definition at line 114 of file surfacePatch.H.

◆ start() [2/2]

label& start ( )
inline

Return start label of this patch in the face list.

Definition at line 120 of file surfacePatch.H.

◆ size() [1/2]

label size ( ) const
inline

Return size of this patch in the face list.

Definition at line 126 of file surfacePatch.H.

◆ size() [2/2]

label& size ( )
inline

Return size of this patch in the face list.

Definition at line 132 of file surfacePatch.H.

◆ write()

void write ( Ostream &  os) const

Write.

Definition at line 107 of file surfacePatch.C.

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

Here is the call graph for this function:

◆ writeDict()

void writeDict ( Ostream &  os) const

Write dictionary.

Definition at line 114 of file surfacePatch.C.

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

Here is the call graph for this function:

◆ operator surfZone()

operator surfZone ( ) const
explicit

Conversion to surfZone representation.

◆ operator!=()

bool operator!= ( const surfacePatch &  p) const

Compare.

Definition at line 141 of file surfacePatch.C.

References p.

◆ operator==()

bool operator== ( const surfacePatch &  p) const

Compare.

Definition at line 147 of file surfacePatch.C.

References p, and Foam::start.

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<< ( Ostream &  ,
const surfacePatch &   
)
friend
The documentation for this class was generated from the following files: