Public Member Functions | Static Public Attributes | List of all members
surfZoneIdentifier Class Reference

Identifies a surface patch/zone by name, patch index and geometricType. More...

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

Public Member Functions

 surfZoneIdentifier ()
 Construct null, with index zero. More...
 
 surfZoneIdentifier (const label index)
 Construct null with specified index. More...
 
 surfZoneIdentifier (const word &name, const label index, const word &geometricType=word::null)
 Construct from components. More...
 
 surfZoneIdentifier (const word &name, const dictionary &dict, const label index)
 Construct from dictionary. More...
 
 surfZoneIdentifier (const surfZoneIdentifier &p, const label index)
 Copy construct from another zone identifier, resetting the index. More...
 
virtual ~surfZoneIdentifier ()=default
 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 patch/zone. More...
 
word & geometricType ()
 Return the geometric type of the patch/zone for modification. More...
 
label index () const
 Return the index of this patch/zone in the surface mesh. More...
 
label & index ()
 Return the index of this patch/zone for modification. More...
 
void write (Ostream &os) const
 Write identifier as a dictionary. More...
 

Static Public Attributes

static const word emptyType = "empty"
 The name for an 'empty' type. More...
 

Detailed Description

Identifies a surface patch/zone by name, patch index and geometricType.

See also
patchIdentifier
Source files

Definition at line 58 of file surfZoneIdentifier.H.

Constructor & Destructor Documentation

◆ surfZoneIdentifier() [1/5]

surfZoneIdentifier ( )

Construct null, with index zero.

Definition at line 39 of file surfZoneIdentifier.C.

◆ surfZoneIdentifier() [2/5]

surfZoneIdentifier ( const label  index)
explicit

Construct null with specified index.

Definition at line 47 of file surfZoneIdentifier.C.

◆ surfZoneIdentifier() [3/5]

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

Construct from components.

Definition at line 56 of file surfZoneIdentifier.C.

◆ surfZoneIdentifier() [4/5]

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

Construct from dictionary.

Definition at line 69 of file surfZoneIdentifier.C.

References dict, and dictionary::readIfPresent().

Here is the call graph for this function:

◆ surfZoneIdentifier() [5/5]

surfZoneIdentifier ( const surfZoneIdentifier &  p,
const label  index 
)

Copy construct from another zone identifier, resetting the index.

Definition at line 84 of file surfZoneIdentifier.C.

◆ ~surfZoneIdentifier()

virtual ~surfZoneIdentifier ( )
virtualdefault

Destructor.

Member Function Documentation

◆ name() [1/2]

const word& name ( ) const
inline

Return name.

Definition at line 119 of file surfZoneIdentifier.H.

Referenced by surfZone::New(), Foam::operator<<(), Foam::operator==(), Foam::operator>>(), and surfZone::surfZone().

Here is the caller graph for this function:

◆ name() [2/2]

word& name ( )
inline

Return name for modification.

Definition at line 125 of file surfZoneIdentifier.H.

◆ geometricType() [1/2]

const word& geometricType ( ) const
inline

Return the geometric type of the patch/zone.

Definition at line 131 of file surfZoneIdentifier.H.

Referenced by Foam::operator<<(), Foam::operator==(), surfZone::operator==(), and Foam::operator>>().

Here is the caller graph for this function:

◆ geometricType() [2/2]

word& geometricType ( )
inline

Return the geometric type of the patch/zone for modification.

Definition at line 137 of file surfZoneIdentifier.H.

◆ index() [1/2]

label index ( ) const
inline

Return the index of this patch/zone in the surface mesh.

Definition at line 143 of file surfZoneIdentifier.H.

Referenced by Foam::operator==(), and surfZone::surfZone().

Here is the caller graph for this function:

◆ index() [2/2]

label& index ( )
inline

Return the index of this patch/zone for modification.

Definition at line 149 of file surfZoneIdentifier.H.

◆ write()

void write ( Ostream &  os) const

Write identifier as a dictionary.

Definition at line 97 of file surfZoneIdentifier.C.

References Ostream::writeEntry().

Referenced by surfZone::writeDict().

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

Member Data Documentation

◆ emptyType

const Foam::word emptyType = "empty"
static

The name for an 'empty' type.

Definition at line 77 of file surfZoneIdentifier.H.

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