Public Member Functions | Friends | List of all members
zone Class Referenceabstract

Base class for mesh zones. More...

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

Public Member Functions

 TypeName ("zone")
 
 zone ()
 
 zone (const word &name, const label index)
 
 zone (const word &name, const labelUList &addr, const label index)
 
 zone (const word &name, labelList &&addr, const label index)
 
 zone (const word &name, const dictionary &dict, const word &labelsName, const label index)
 
 zone (const zone &origZone, const labelUList &addr, const label index)
 
 zone (const zone &origZone, labelList &&addr, const label index)
 
virtual ~zone ()
 
const Map< label > & lookupMap () const
 
label localID (const label globalID) const
 
const labelListaddressing () const noexcept
 
virtual void clearAddressing ()
 
virtual bool checkDefinition (const bool report=false) const =0
 
virtual bool checkDefinition (const label maxSize, const bool report=false) const
 
virtual void movePoints (const pointField &pts)
 
virtual void write (Ostream &os) const
 
virtual void writeDict (Ostream &os) const =0
 
- Public Member Functions inherited from zoneIdentifier
 zoneIdentifier (const zoneIdentifier &)=default
 
zoneIdentifieroperator= (const zoneIdentifier &)=default
 
virtual ~zoneIdentifier ()=default
 
 zoneIdentifier ()
 
 zoneIdentifier (const word &name, const label index)
 
 zoneIdentifier (const word &name, const label index, const word &physicalType, const wordList &inGroups=wordList())
 
 zoneIdentifier (const word &name, const dictionary &dict, const label index)
 
 zoneIdentifier (const zoneIdentifier &ident, const label index)
 
const wordname () const noexcept
 
wordname () noexcept
 
label index () const noexcept
 
label & index () noexcept
 
const wordphysicalType () const noexcept
 
wordphysicalType () noexcept
 
const wordListinGroups () const noexcept
 
wordListinGroups () noexcept
 
bool inGroup (const word &name) const
 
void write (Ostream &os) const
 
- Public Member Functions inherited from List
constexpr List () noexcept
 
 List (const label len)
 
 List (const label len, const T &val)
 
 List (const label len, const Foam::zero)
 
 List (const Foam::one, const T &val)
 
 List (const Foam::one, T &&val)
 
 List (const Foam::one, const Foam::zero)
 
 List (const List< T > &a)
 
 List (const UList< T > &a)
 
 List (List< T > &a, bool reuse)
 
 List (const UList< T > &list, const labelUList &indices)
 
template<unsigned N>
 List (const UList< T > &list, const FixedList< label, N > &indices)
 
template<unsigned N>
 List (const FixedList< T, N > &list)
 
 List (const PtrList< T > &list)
 
 List (const SLList< T > &list)
 
template<class Addr >
 List (const IndirectListBase< T, Addr > &list)
 
 List (std::initializer_list< T > list)
 
 List (List< T > &&list)
 
template<int SizeMin>
 List (DynamicList< T, SizeMin > &&list)
 
 List (SortableList< T > &&list)
 
 List (SLList< T > &&list)
 
 List (Istream &is)
 
autoPtr< List< T > > clone () const
 
 ~List ()
 
void clear ()
 
void resize (const label len)
 
void resize (const label len, const T &val)
 
void resize_nocopy (const label len)
 
void setSize (const label n)
 
void setSize (const label n, const T &val)
 
void append (const T &val)
 
void append (T &&val)
 
void append (const UList< T > &list)
 
template<class Addr >
void append (const IndirectListBase< T, Addr > &list)
 
label appendUniq (const T &val)
 
void transfer (List< T > &list)
 
template<int SizeMin>
void transfer (DynamicList< T, SizeMin > &list)
 
void transfer (SortableList< T > &list)
 
TnewElmt (const label i)
 
void operator= (const UList< T > &a)
 
void operator= (const List< T > &list)
 
void operator= (const SLList< T > &list)
 
template<class Addr >
void operator= (const IndirectListBase< T, Addr > &list)
 
template<unsigned N>
void operator= (const FixedList< T, N > &list)
 
void operator= (std::initializer_list< T > list)
 
void operator= (const T &val)
 
void operator= (const Foam::zero)
 
void operator= (List< T > &&list)
 
template<int SizeMin>
void operator= (DynamicList< T, SizeMin > &&list)
 
void operator= (SortableList< T > &&list)
 
void operator= (SLList< T > &&list)
 
IstreamreadList (Istream &is)
 
void shallowCopy (const UList< T > &)=delete
 
template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type set (const label i, bool val=true)
 
template<class T >
 List (const label len)
 
template<class T >
 List (const label len, const T &val)
 
template<class T >
 List (const label len, const Foam::zero)
 
template<class T >
 List (const Foam::one, const T &val)
 
template<class T >
 List (const Foam::one, T &&val)
 
template<class T >
 List (const Foam::one, const Foam::zero)
 
template<class T >
 List (const UList< T > &a)
 
template<class T >
 List (const List< T > &a)
 
template<class T >
 List (List< T > &a, bool reuse)
 
template<class T >
 List (const UList< T > &list, const labelUList &indices)
 
template<class T >
 List (const PtrList< T > &list)
 
template<class T >
 List (const SLList< T > &list)
 
template<class T >
 List (std::initializer_list< T > list)
 
template<class T >
 List (List< T > &&list)
 
template<class T >
 List (SortableList< T > &&list)
 
template<class T >
 List (SLList< T > &&list)
 
template<class T >
void transfer (List< T > &list)
 
template<class T >
void transfer (SortableList< T > &list)
 
template<class T >
void operator= (const UList< T > &a)
 
template<class T >
void operator= (const List< T > &list)
 
template<class T >
void operator= (const SLList< T > &list)
 
template<class T >
void operator= (std::initializer_list< T > list)
 
template<class T >
void operator= (List< T > &&list)
 
template<class T >
void operator= (SortableList< T > &&list)
 
template<class T >
void operator= (SLList< T > &&list)
 
IstreamreadList (Istream &is)
 
template<class T >
constexpr List () noexcept
 
void resize (const label newLen)
 
template<class T >
void append (const T &val)
 
template<class T >
void append (T &&val)
 
template<class T >
void append (const UList< T > &list)
 
template<class T >
void operator= (const T &val)
 
template<class T >
void operator= (const Foam::zero)
 
template<class T >
 List (Istream &is)
 
IstreamreadList (Istream &is)
 

Friends

Ostreamoperator<< (Ostream &os, const zone &zn)
 

Additional Inherited Members

- Public Types inherited from List
typedef SubList< TsubList
 
- Static Public Member Functions inherited from List
static const List< T > & null ()
 

Detailed Description

Base class for mesh zones.

A zone is a list of labels (eg, cells, faces, points) with a name and associated with an index within another list.

Source files

Definition at line 59 of file zone.H.

Constructor & Destructor Documentation

◆ zone() [1/7]

zone ( )

Definition at line 38 of file zone.C.

◆ zone() [2/7]

zone ( const word name,
const label  index 
)

Definition at line 46 of file zone.C.

◆ zone() [3/7]

zone ( const word name,
const labelUList addr,
const label  index 
)

Definition at line 55 of file zone.C.

◆ zone() [4/7]

zone ( const word name,
labelList &&  addr,
const label  index 
)

Definition at line 68 of file zone.C.

◆ zone() [5/7]

zone ( const word name,
const dictionary dict,
const word labelsName,
const label  index 
)

Definition at line 81 of file zone.C.

◆ zone() [6/7]

zone ( const zone origZone,
const labelUList addr,
const label  index 
)

Definition at line 93 of file zone.C.

◆ zone() [7/7]

zone ( const zone origZone,
labelList &&  addr,
const label  index 
)

Definition at line 104 of file zone.C.

◆ ~zone()

~zone ( )
virtual

Definition at line 116 of file zone.C.

Member Function Documentation

◆ TypeName()

TypeName ( "zone"  )

◆ lookupMap()

const Foam::Map< Foam::label > & lookupMap ( ) const

Definition at line 124 of file zone.C.

References DebugInFunction, Foam::endl(), and forAll.

Here is the call graph for this function:

◆ localID()

Foam::label localID ( const label  globalID) const

Definition at line 145 of file zone.C.

Referenced by cellZone::whichCell(), faceZone::whichFace(), and pointZone::whichPoint().

Here is the caller graph for this function:

◆ addressing()

const labelList& addressing ( ) const
inlinenoexcept

Definition at line 143 of file zone.H.

Referenced by faceZoneSet::faceZoneSet().

Here is the caller graph for this function:

◆ clearAddressing()

void clearAddressing ( )
virtual

Reimplemented in faceZone.

Definition at line 151 of file zone.C.

References Foam::deleteDemandDrivenData().

Referenced by faceZone::clearAddressing().

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

◆ checkDefinition() [1/2]

virtual bool checkDefinition ( const bool  report = false) const
pure virtual

Implemented in faceZone, pointZone, and cellZone.

Referenced by cellZone::checkDefinition(), pointZone::checkDefinition(), and faceZone::checkDefinition().

Here is the caller graph for this function:

◆ checkDefinition() [2/2]

bool checkDefinition ( const label  maxSize,
const bool  report = false 
) const
virtual

Definition at line 157 of file zone.C.

References Foam::endl(), HashSet::insert(), Foam::name(), Foam::nl, SeriousErrorInFunction, and WarningInFunction.

Here is the call graph for this function:

◆ movePoints()

virtual void movePoints ( const pointField pts)
inlinevirtual

Reimplemented in faceZone, and pointZone.

Definition at line 163 of file zone.H.

◆ write()

void write ( Ostream os) const
virtual

Reimplemented in faceZone.

Definition at line 201 of file zone.C.

References Foam::name(), Foam::nl, and os().

Referenced by Foam::operator<<().

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

◆ writeDict()

virtual void writeDict ( Ostream os) const
pure virtual

Implemented in faceZone, pointZone, and cellZone.

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<< ( Ostream os,
const zone zn 
)
friend

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