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

Identifies a surface patch/zone by name and index, with optional geometric type. More...

Inheritance diagram for surfZoneIdentifier:
[legend]

Public Member Functions

 surfZoneIdentifier (const surfZoneIdentifier &)=default
 Copy construct. More...
 
surfZoneIdentifier & operator= (const surfZoneIdentifier &)=default
 Copy assignment. More...
 
 surfZoneIdentifier ()
 Default construct. Uses name="", index=0. More...
 
 surfZoneIdentifier (const label index)
 Construct null with specified index. More...
 
 surfZoneIdentifier (const word &name, const label index)
 Construct from mandatory components. More...
 
 surfZoneIdentifier (const word &name, const label index, const word &geometricType)
 Construct from components. More...
 
 surfZoneIdentifier (const word &name, const dictionary &dict, const label index)
 Construct from dictionary. More...
 
 surfZoneIdentifier (const surfZoneIdentifier &ident, const label index)
 Copy construct, resetting the index. More...
 
const word & name () const
 The patch/zone name. More...
 
word & name ()
 Modifiable patch/zone name. More...
 
const word & geometricType () const
 The geometric type of the patch/zone. More...
 
word & geometricType ()
 Modifiable geometric type of the patch/zone. More...
 
label index () const
 The index of this patch/zone in the surface mesh. More...
 
label & index ()
 Modifiable index of this patch/zone in the surface mesh. More...
 
void write (Ostream &os) const
 

Static Public Member Functions

static word defaultName (const label n=-1)
 Default zone name: "zone" or "zoneN". More...
 

Static Public Attributes

static constexpr const char *const emptyType = "empty"
 The name for an 'empty' type. More...
 

Detailed Description

Identifies a surface patch/zone by name and index, with optional geometric type.

See also
patchIdentifier
Source files

Definition at line 59 of file surfZoneIdentifier.H.

Constructor & Destructor Documentation

◆ surfZoneIdentifier() [1/7]

surfZoneIdentifier ( const surfZoneIdentifier &  )
default

Copy construct.

◆ surfZoneIdentifier() [2/7]

surfZoneIdentifier ( )

Default construct. Uses name="", index=0.

Definition at line 34 of file surfZoneIdentifier.C.

◆ surfZoneIdentifier() [3/7]

surfZoneIdentifier ( const label  index)
explicit

Construct null with specified index.

Definition at line 40 of file surfZoneIdentifier.C.

◆ surfZoneIdentifier() [4/7]

surfZoneIdentifier ( const word &  name,
const label  index 
)

Construct from mandatory components.

Definition at line 49 of file surfZoneIdentifier.C.

◆ surfZoneIdentifier() [5/7]

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

Construct from components.

Definition at line 61 of file surfZoneIdentifier.C.

◆ surfZoneIdentifier() [6/7]

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

Construct from dictionary.

Definition at line 74 of file surfZoneIdentifier.C.

References dict, and dictionary::readIfPresent().

Here is the call graph for this function:

◆ surfZoneIdentifier() [7/7]

surfZoneIdentifier ( const surfZoneIdentifier &  ident,
const label  index 
)

Copy construct, resetting the index.

Definition at line 89 of file surfZoneIdentifier.C.

Member Function Documentation

◆ defaultName()

static word defaultName ( const label  n = -1)
inlinestatic

Default zone name: "zone" or "zoneN".

Definition at line 83 of file surfZoneIdentifier.H.

References n.

Referenced by UnsortedMeshedSurface< Face >::setZones(), and UnsortedMeshedSurface< Face >::sortedZones().

Here is the caller graph for this function:

◆ operator=()

surfZoneIdentifier& operator= ( const surfZoneIdentifier &  )
default

Copy assignment.

◆ name() [1/2]

const word& name ( ) const
inline

The patch/zone name.

Definition at line 141 of file surfZoneIdentifier.H.

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

Here is the caller graph for this function:

◆ name() [2/2]

word& name ( )
inline

Modifiable patch/zone name.

Definition at line 147 of file surfZoneIdentifier.H.

◆ geometricType() [1/2]

const word& geometricType ( ) const
inline

The geometric type of the patch/zone.

Definition at line 153 of file surfZoneIdentifier.H.

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

Here is the caller graph for this function:

◆ geometricType() [2/2]

word& geometricType ( )
inline

Modifiable geometric type of the patch/zone.

Definition at line 159 of file surfZoneIdentifier.H.

◆ index() [1/2]

label index ( ) const
inline

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

Definition at line 165 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

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

Definition at line 171 of file surfZoneIdentifier.H.

◆ write()

void write ( Ostream &  os) const

Write (geometricType) dictionary entry (without surrounding braces)

Definition at line 102 of file surfZoneIdentifier.C.

References os(), and Ostream::writeEntry().

Referenced by surfZone::write().

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

Member Data Documentation

◆ emptyType

constexpr const char* const emptyType = "empty"
staticconstexpr

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: