FreeFOAM The Cross-Platform CFD Toolkit
geometricSurfacePatch Class Reference

The geometricSurfacePatch is like patchIdentifier but for surfaces. Holds type, name and index. More...

#include <triSurface/geometricSurfacePatch.H>


Detailed Description

+ Inheritance diagram for geometricSurfacePatch:

List of all members.

Public Member Functions

 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 word & name () const
 Return name.
word & name ()
 Return name.
const word & geometricType () const
 Return the type of the patch.
word & geometricType ()
 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.
void write (Ostream &) const
 Write.
void writeDict (Ostream &) const
 Write dictionary.
bool operator!= (const geometricSurfacePatch &) const
bool operator== (const geometricSurfacePatch &) const
 compare.

Friends

Ostream & operator<< (Ostream &, const geometricSurfacePatch &)
Istream & operator>> (Istream &, geometricSurfacePatch &)

Constructor & Destructor Documentation

Construct null.

Definition at line 41 of file geometricSurfacePatch.C.

geometricSurfacePatch ( const word &  geometricType,
const word &  name,
const label  index 
)

Construct from components.

Definition at line 51 of file geometricSurfacePatch.C.

geometricSurfacePatch ( Istream &  is,
const label  index 
)

Construct from Istream.

Definition at line 70 of file geometricSurfacePatch.C.

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

Construct from dictionary.

Definition at line 85 of file geometricSurfacePatch.C.


Member Function Documentation

ClassName ( "geometricSurfacePatch"  )

Runtime type information.

const word& name ( ) const
inline

Return name.

Definition at line 101 of file geometricSurfacePatch.H.

Referenced by geometricSurfacePatch::operator==(), and boundaryMesh::readTriSurface().

word& name ( )
inline

Return name.

Definition at line 107 of file geometricSurfacePatch.H.

const word& geometricType ( ) const
inline

Return the type of the patch.

Definition at line 113 of file geometricSurfacePatch.H.

Referenced by surfacePatch::operator==(), geometricSurfacePatch::operator==(), and boundaryMesh::readTriSurface().

word& geometricType ( )
inline

Return the type of the patch.

Definition at line 119 of file geometricSurfacePatch.H.

label index ( ) const
inline

Return the index of this patch in the boundaryMesh.

Definition at line 125 of file geometricSurfacePatch.H.

label& index ( )
inline

Return the index of this patch in the boundaryMesh.

Definition at line 131 of file geometricSurfacePatch.H.

void write ( Ostream &  os) const

Write.

Reimplemented in surfacePatch.

Definition at line 105 of file geometricSurfacePatch.C.

References Foam::nl.

Referenced by Foam::operator<<().

void writeDict ( Ostream &  os) const

Write dictionary.

Reimplemented in surfacePatch.

Definition at line 112 of file geometricSurfacePatch.C.

References Foam::nl.

Referenced by surfacePatch::writeDict().

bool operator!= ( const geometricSurfacePatch &  p) const

Definition at line 120 of file geometricSurfacePatch.C.

References p.

bool operator== ( const geometricSurfacePatch &  p) const

Friends And Related Function Documentation

Ostream& operator<< ( Ostream &  os,
const geometricSurfacePatch &  gp 
)
friend

Definition at line 148 of file geometricSurfacePatch.C.

Istream& operator>> ( Istream &  is,
geometricSurfacePatch &  gp 
)
friend

Definition at line 140 of file geometricSurfacePatch.C.


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