Public Member Functions | Static Public Member Functions | Friends | List of all members
surfZone Class Reference

A surface zone on a MeshedSurface. More...

Inheritance diagram for surfZone:
Inheritance graph
[legend]
Collaboration diagram for surfZone:
Collaboration graph
[legend]

Public Member Functions

 ClassName ("surfZone")
 Runtime type information. More...
 
 surfZone ()
 Construct null. More...
 
 surfZone (const word &name, const label size, const label start, const label index, const word &geometricType=word::null)
 Construct from components. More...
 
 surfZone (Istream &is, const label index)
 Construct from Istream. More...
 
 surfZone (const word &name, const dictionary &dict, const label index)
 Construct from dictionary. More...
 
 surfZone (const surfZone &, const label index)
 Construct from another zone, resetting the index. More...
 
autoPtr< surfZone > clone () const
 Return clone. More...
 
label start () const
 Return start label of this zone in the face list. More...
 
label & start ()
 Return start label of this zone in the face list. More...
 
label size () const
 Return size of this zone in the face list. More...
 
label & size ()
 Return size of this zone in the face list. More...
 
void write (Ostream &) const
 Write. More...
 
void writeDict (Ostream &) const
 Write dictionary. More...
 
bool operator!= (const surfZone &) const
 
bool operator== (const surfZone &) const
 compare. More...
 
- Public Member Functions inherited from surfZoneIdentifier
 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...
 

Static Public Member Functions

static autoPtr< surfZone > New (Istream &is)
 

Friends

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

Detailed Description

A surface zone on a MeshedSurface.

Similar in concept to a faceZone, but the face list is contiguous.

Source files

Definition at line 62 of file surfZone.H.

Constructor & Destructor Documentation

◆ surfZone() [1/5]

surfZone ( )

Construct null.

Definition at line 40 of file surfZone.C.

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

Here is the caller graph for this function:

◆ surfZone() [2/5]

surfZone ( const word &  name,
const label  size,
const label  start,
const label  index,
const word &  geometricType = word::null 
)

Construct from components.

Definition at line 49 of file surfZone.C.

◆ surfZone() [3/5]

surfZone ( Istream &  is,
const label  index 
)

Construct from Istream.

Definition at line 63 of file surfZone.C.

References dict, surfZoneIdentifier::name(), and surfZone::surfZone().

Here is the call graph for this function:

◆ surfZone() [4/5]

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

Construct from dictionary.

Definition at line 77 of file surfZone.C.

◆ surfZone() [5/5]

surfZone ( const surfZone &  zone,
const label  index 
)

Construct from another zone, resetting the index.

Definition at line 89 of file surfZone.C.

Member Function Documentation

◆ ClassName()

ClassName ( "surfZone"  )

Runtime type information.

◆ clone()

autoPtr<surfZone> clone ( ) const
inline

Return clone.

Definition at line 111 of file surfZone.H.

References NotImplemented.

◆ New()

static autoPtr<surfZone> New ( Istream &  is)
inlinestatic

Definition at line 117 of file surfZone.H.

References dict, surfZoneIdentifier::name(), and surfZone::surfZone().

Here is the call graph for this function:

◆ start() [1/2]

label start ( ) const
inline

Return start label of this zone in the face list.

Definition at line 129 of file surfZone.H.

Referenced by surfZone::operator==(), MeshedSurface< Foam::face >::remapFaces(), UnsortedMeshedSurface< Face >::setZones(), MeshedSurface< Foam::face >::subsetMesh(), AC3DsurfaceFormat< Face >::write(), and surfZone::writeDict().

Here is the caller graph for this function:

◆ start() [2/2]

label& start ( )
inline

Return start label of this zone in the face list.

Definition at line 135 of file surfZone.H.

◆ size() [1/2]

label size ( ) const
inline

Return size of this zone in the face list.

Definition at line 141 of file surfZone.H.

Referenced by surfZone::operator==(), MeshedSurface< Foam::face >::remapFaces(), UnsortedMeshedSurface< Face >::setZones(), MeshedSurface< Foam::face >::subsetMesh(), AC3DsurfaceFormat< Face >::write(), and surfZone::writeDict().

Here is the caller graph for this function:

◆ size() [2/2]

label& size ( )
inline

Return size of this zone in the face list.

Definition at line 147 of file surfZone.H.

References surfZone::operator!=(), surfZone::operator<<, surfZone::operator==(), surfZone::operator>>, surfZone::write(), and surfZone::writeDict().

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const

Write.

Definition at line 99 of file surfZone.C.

References surfZone::writeDict().

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

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

◆ writeDict()

void writeDict ( Ostream &  os) const

Write dictionary.

Definition at line 105 of file surfZone.C.

References token::BEGIN_BLOCK, Foam::decrIndent(), token::END_BLOCK, Foam::endl(), Foam::incrIndent(), Foam::indent(), surfZoneIdentifier::name(), Foam::nl, surfZone::size(), surfZone::start(), surfZoneIdentifier::write(), and Foam::writeEntry().

Referenced by surfZone::size(), and surfZone::write().

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

◆ operator!=()

bool operator!= ( const surfZone &  rhs) const

Definition at line 120 of file surfZone.C.

Referenced by surfZone::size().

Here is the caller graph for this function:

◆ operator==()

bool operator== ( const surfZone &  rhs) const

compare.

Definition at line 126 of file surfZone.C.

References surfZoneIdentifier::geometricType(), surfZone::size(), and surfZone::start().

Referenced by surfZone::size().

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

Friends And Related Function Documentation

◆ operator>>

Istream& operator>> ( Istream &  ,
surfZone &   
)
friend

Referenced by surfZone::size().

◆ operator<<

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

Referenced by surfZone::size().

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