Loading...
Searching...
No Matches
surfZoneIdentifier Class Reference

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

#include <surfZoneIdentifier.H>

Inheritance diagram for surfZoneIdentifier:
Inheritance graph
[legend]

Public Member Functions

 surfZoneIdentifier (const surfZoneIdentifier &)=default
 Copy construct.
 surfZoneIdentifier (surfZoneIdentifier &&)=default
 Move construct.
surfZoneIdentifier & operator= (const surfZoneIdentifier &)=default
 Copy assignment.
surfZoneIdentifier & operator= (surfZoneIdentifier &&)=default
 Move assignment.
 surfZoneIdentifier ()
 Default construct. Uses name="", index=0.
 surfZoneIdentifier (const label index)
 Construct with name="" and specified index.
 surfZoneIdentifier (const word &name, const label index)
 Construct from mandatory components.
 surfZoneIdentifier (const word &name, const label index, const word &geometricType)
 Construct from components.
 surfZoneIdentifier (const word &name, const dictionary &dict, const label index)
 Construct from dictionary.
 surfZoneIdentifier (const surfZoneIdentifier &ident, const label newIndex)
 Copy construct, resetting the index (if non-negative).
 surfZoneIdentifier (surfZoneIdentifier &&ident, const label newIndex)
 Move construct, resetting the index (if non-negative).
const word & name () const noexcept
 The patch/zone name.
word & name () noexcept
 Modifiable patch/zone name.
const word & geometricType () const noexcept
 The (optional) geometric type of the patch/zone.
word & geometricType () noexcept
 Modifiable (optional) geometric type of the patch/zone.
label index () const noexcept
 The index of this patch/zone in the surface mesh.
label & index () noexcept
 Modifiable index of this patch/zone in the surface mesh.
void write (Ostream &os) const
 Write (geometricType) dictionary entry (without surrounding braces).

Static Public Member Functions

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

Static Public Attributes

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

Detailed Description

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

See also
patchIdentifier
Source files

Definition at line 55 of file surfZoneIdentifier.H.

Constructor & Destructor Documentation

◆ surfZoneIdentifier() [1/9]

surfZoneIdentifier ( const surfZoneIdentifier & )
default

Copy construct.

References surfZoneIdentifier().

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

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

◆ surfZoneIdentifier() [2/9]

surfZoneIdentifier ( surfZoneIdentifier && )
default

Move construct.

References surfZoneIdentifier().

Here is the call graph for this function:

◆ surfZoneIdentifier() [3/9]

surfZoneIdentifier ( )

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

Definition at line 27 of file surfZoneIdentifier.C.

◆ surfZoneIdentifier() [4/9]

surfZoneIdentifier ( const label index)
explicit

Construct with name="" and specified index.

Definition at line 33 of file surfZoneIdentifier.C.

References index().

Here is the call graph for this function:

◆ surfZoneIdentifier() [5/9]

surfZoneIdentifier ( const word & name,
const label index )

Construct from mandatory components.

Definition at line 39 of file surfZoneIdentifier.C.

References index(), and name().

Here is the call graph for this function:

◆ surfZoneIdentifier() [6/9]

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

Construct from components.

Definition at line 50 of file surfZoneIdentifier.C.

References geometricType(), index(), and name().

Here is the call graph for this function:

◆ surfZoneIdentifier() [7/9]

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

Construct from dictionary.

Definition at line 63 of file surfZoneIdentifier.C.

References dict, index(), name(), and surfZoneIdentifier().

Here is the call graph for this function:

◆ surfZoneIdentifier() [8/9]

surfZoneIdentifier ( const surfZoneIdentifier & ident,
const label newIndex )

Copy construct, resetting the index (if non-negative).

Definition at line 76 of file surfZoneIdentifier.C.

References surfZoneIdentifier().

Here is the call graph for this function:

◆ surfZoneIdentifier() [9/9]

surfZoneIdentifier ( surfZoneIdentifier && ident,
const label newIndex )

Move construct, resetting the index (if non-negative).

Definition at line 91 of file surfZoneIdentifier.C.

References surfZoneIdentifier().

Here is the call graph for this function:

Member Function Documentation

◆ defaultName()

word defaultName ( const label n = -1)
inlinestatic

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

Definition at line 89 of file surfZoneIdentifier.H.

References n.

Referenced by ABAQUSsurfaceFormat< Face >::read(), AC3DsurfaceFormat< Face >::read(), GTSsurfaceFormat< Face >::read(), NASsurfaceFormat< Face >::read(), VTKsurfaceFormat< Face >::read(), UnsortedMeshedSurface< Face >::setZones(), UnsortedMeshedSurface< Face >::sortedZones(), and MeshedSurface< Foam::face >::sortFacesAndStore().

Here is the caller graph for this function:

◆ operator=() [1/2]

surfZoneIdentifier & operator= ( const surfZoneIdentifier & )
default

Copy assignment.

References surfZoneIdentifier().

Here is the call graph for this function:

◆ operator=() [2/2]

surfZoneIdentifier & operator= ( surfZoneIdentifier && )
default

Move assignment.

References dict, geometricType(), index(), name(), and surfZoneIdentifier().

Here is the call graph for this function:

◆ name() [1/2]

const word & name ( ) const
inlinenoexcept

The patch/zone name.

Definition at line 184 of file surfZoneIdentifier.H.

References Foam::noexcept.

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

Here is the caller graph for this function:

◆ name() [2/2]

word & name ( )
inlinenoexcept

Modifiable patch/zone name.

Definition at line 189 of file surfZoneIdentifier.H.

References Foam::noexcept.

◆ geometricType() [1/2]

const word & geometricType ( ) const
inlinenoexcept

The (optional) geometric type of the patch/zone.

Definition at line 194 of file surfZoneIdentifier.H.

References Foam::noexcept.

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

Here is the caller graph for this function:

◆ geometricType() [2/2]

word & geometricType ( )
inlinenoexcept

Modifiable (optional) geometric type of the patch/zone.

Definition at line 199 of file surfZoneIdentifier.H.

References Foam::noexcept.

◆ index() [1/2]

label index ( ) const
inlinenoexcept

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

Definition at line 204 of file surfZoneIdentifier.H.

References Foam::noexcept.

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

Here is the caller graph for this function:

◆ index() [2/2]

label & index ( )
inlinenoexcept

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

Definition at line 209 of file surfZoneIdentifier.H.

References Foam::noexcept.

◆ write()

void write ( Ostream & os) const

Write (geometricType) dictionary entry (without surrounding braces).

Definition at line 108 of file surfZoneIdentifier.C.

References os().

Referenced by surfZone::write().

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

Member Data Documentation

◆ emptyType

const char* const emptyType = "empty"
staticconstexpr

The name for an 'empty' type.

Definition at line 81 of file surfZoneIdentifier.H.

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