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

An identifier for a surface zone on a meshed surface. More...

Inheritance diagram for surfZoneIdentifier:
Inheritance graph
[legend]

Public Member Functions

 surfZoneIdentifier ()
 Construct null. More...
 
 surfZoneIdentifier (const word &name, const label index, const word &geometricType=word::null)
 Construct from components. More...
 
 surfZoneIdentifier (const word &name, const dictionary &, const label index)
 Construct from dictionary. More...
 
 surfZoneIdentifier (const surfZoneIdentifier &, const label index)
 Construct from another zone identifier, resetting the index. More...
 
virtual ~surfZoneIdentifier ()
 Destructor. More...
 
const word & name () const
 Return name. More...
 
word & name ()
 Return name for modification. More...
 
const word & geometricType () const
 Return the geometric type of the zone. More...
 
word & geometricType ()
 Return the geometric type of the zone for modification. More...
 
label index () const
 Return the index of this zone in the surface mesh. More...
 
void write (Ostream &) const
 Write surfZoneIdentifier as a dictionary. More...
 

Friends

Ostream & operator<< (Ostream &, const surfZoneIdentifier &)
 Write surfZoneIdentifier as a dictionary. More...
 

Detailed Description

An identifier for a surface zone on a meshed surface.

Similar in concept to a faceZone on the surface, but can also have a "geometricType" as well.

Source files

Definition at line 60 of file surfZoneIdentifier.H.

Constructor & Destructor Documentation

◆ surfZoneIdentifier() [1/4]

surfZoneIdentifier ( )

Construct null.

Definition at line 31 of file surfZoneIdentifier.C.

◆ surfZoneIdentifier() [2/4]

surfZoneIdentifier ( const word &  name,
const label  index,
const word &  geometricType = word::null 
)

Construct from components.

Definition at line 39 of file surfZoneIdentifier.C.

◆ surfZoneIdentifier() [3/4]

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

Construct from dictionary.

Definition at line 52 of file surfZoneIdentifier.C.

References dict.

◆ surfZoneIdentifier() [4/4]

surfZoneIdentifier ( const surfZoneIdentifier &  p,
const label  index 
)

Construct from another zone identifier, resetting the index.

Definition at line 66 of file surfZoneIdentifier.C.

◆ ~surfZoneIdentifier()

~surfZoneIdentifier ( )
virtual

Destructor.

Definition at line 80 of file surfZoneIdentifier.C.

Member Function Documentation

◆ name() [1/2]

const word& name ( ) const
inline

Return name.

Definition at line 113 of file surfZoneIdentifier.H.

Referenced by surfZone::New(), surfZone::surfZone(), AC3DsurfaceFormat< Face >::write(), OBJsurfaceFormat< Face >::write(), and STLsurfaceFormat< Face >::writeAscii().

Here is the caller graph for this function:

◆ name() [2/2]

word& name ( )
inline

Return name for modification.

Definition at line 119 of file surfZoneIdentifier.H.

◆ geometricType() [1/2]

const word& geometricType ( ) const
inline

Return the geometric type of the zone.

Definition at line 125 of file surfZoneIdentifier.H.

Referenced by surfZone::operator==().

Here is the caller graph for this function:

◆ geometricType() [2/2]

word& geometricType ( )
inline

Return the geometric type of the zone for modification.

Definition at line 131 of file surfZoneIdentifier.H.

◆ index()

label index ( ) const
inline

Return the index of this zone in the surface mesh.

Definition at line 137 of file surfZoneIdentifier.H.

Referenced by surfZone::surfZone().

Here is the caller graph for this function:

◆ write()

void write ( Ostream &  os) const

Write surfZoneIdentifier as a dictionary.

Definition at line 87 of file surfZoneIdentifier.C.

References Foam::writeEntry().

Referenced by surfZone::writeDict().

Here is the call graph for this function:
Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator<<

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

Write surfZoneIdentifier as a dictionary.

void writeDict(Ostream&) const;

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