FreeFOAM The Cross-Platform CFD Toolkit
Classes | Public Member Functions | Friends
DLListBase Class Reference

Base doubly-linked list. More...

#include <OpenFOAM/DLListBase.H>

Detailed Description

Base doubly-linked list.

Source files

Definition at line 51 of file DLListBase.H.

+ Inheritance diagram for DLListBase:

List of all members.

Classes

class  const_iterator
 An STL-conforming const_iterator. More...
class  iterator
 An STL-conforming iterator. More...
struct  link
 Link structure. More...

Public Member Functions

 DLListBase ()
 Null construct.
 DLListBase (link *)
 Construct given initial entry.
 ~DLListBase ()
label size () const
 Return number of elements in list.
bool empty () const
 Return true if the list is empty.
link * first ()
 Return first entry.
const link * first () const
 Return const access to first entry.
link * last ()
 Return last entry.
const link * last () const
 Return const access to last entry.
void insert (link *)
 Add at head of list.
void append (link *)
 Add at tail of list.
bool swapUp (link *)
 Swap this element with the one above unless it is at the top.
bool swapDown (link *)
 Swap this element with the one below unless it is at the bottom.
link * removeHead ()
 Remove and return head.
link * remove (link *)
 Remove and return element.
link * remove (iterator &)
link * replace (link *oldLink, link *newLink)
 Replace oldLink with newLink and return element.
link * replace (iterator &oldIter, link *newLink)
 Replace oldIter with newLink and return element.
void clear ()
 Clear the list.
void transfer (DLListBase &)
 Transfer the contents of the argument into this List.
iterator begin ()
const iterator & end ()
const_iterator cbegin () const
const const_iterator & cend () const
const_iterator begin () const
const const_iterator & end () const

Friends

class iterator
class const_iterator

Constructor & Destructor Documentation

DLListBase ( )
inline

Null construct.

Definition at line 37 of file DLListBaseI.H.

DLListBase ( link *  a)
inline

Construct given initial entry.

Definition at line 45 of file DLListBaseI.H.

References DLListBase::link::next_, and DLListBase::link::prev_.

~DLListBase ( )
inline

Definition at line 58 of file DLListBaseI.H.

Member Function Documentation

Foam::label size ( ) const
inline

Return number of elements in list.

Reimplemented in Cloud< ParticleType >, Cloud< BasicReactingMultiphaseParcel< ThermoType > >, Cloud< basicThermoParcel >, Cloud< indexedParticle >, Cloud< trackedParticle >, Cloud< ParcelType >, Cloud< parcel >, Cloud< basicKinematicParcel >, Cloud< solidParticle >, Cloud< CoalParcel< ThermoType > >, Cloud< molecule >, Cloud< passiveParticle >, Cloud< dsmcParcel >, and Cloud< BasicReactingParcel< ThermoType > >.

Definition at line 77 of file DLListBaseI.H.

Referenced by sixDoFRigidBodyMotion::addConstraints(), sixDoFRigidBodyMotion::addRestraints(), DLListBase::begin(), DLListBase::cbegin(), phaseProperties::phaseProperties(), Foam::preservePatchTypes(), functionObjectList::read(), shellSurfaces::shellSurfaces(), tolerances::solverRelativeTolerances(), and dictionaryEntry::startLineNumber().

bool empty ( ) const
inline

Return true if the list is empty.

Definition at line 83 of file DLListBaseI.H.

Referenced by cellTable::combine(), and boundaryRegion::rename().

Foam::DLListBase::link * first ( )
inline

Return first entry.

Reimplemented in LList< DLListBase, T >, LList< DLListBase, entry * >, LList< DLListBase, T * >, LList< DLListBase, phase * >, LList< DLListBase, autoPtr< regExp > >, LPtrList< DLListBase, T >, LPtrList< DLListBase, phase >, UILList< DLListBase, passiveParticle >, UILList< DLListBase, indexedParticle >, UILList< DLListBase, CallbackType >, UILList< DLListBase, T >, UILList< DLListBase, trackedParticle >, UILList< DLListBase, dsmcParcel >, UILList< DLListBase, BasicReactingParcel< ThermoType > >, UILList< DLListBase, solidParticle >, UILList< DLListBase, BasicReactingMultiphaseParcel< ThermoType > >, UILList< DLListBase, parcel >, UILList< DLListBase, entry >, UILList< DLListBase, ParticleType >, UILList< DLListBase, CoalParcel< ThermoType > >, UILList< DLListBase, molecule >, UILList< DLListBase, basicKinematicParcel >, UILList< DLListBase, basicThermoParcel >, and UILList< DLListBase, ParcelType >.

Definition at line 90 of file DLListBaseI.H.

References Foam::abort(), Foam::FatalError, and FatalErrorIn.

Referenced by DLListBase::begin(), and DLListBase::cbegin().

const Foam::DLListBase::link * first ( ) const
inline

Return const access to first entry.

Reimplemented in LList< DLListBase, T >, LList< DLListBase, entry * >, LList< DLListBase, T * >, LList< DLListBase, phase * >, LList< DLListBase, autoPtr< regExp > >, LPtrList< DLListBase, T >, LPtrList< DLListBase, phase >, UILList< DLListBase, passiveParticle >, UILList< DLListBase, indexedParticle >, UILList< DLListBase, CallbackType >, UILList< DLListBase, T >, UILList< DLListBase, trackedParticle >, UILList< DLListBase, dsmcParcel >, UILList< DLListBase, BasicReactingParcel< ThermoType > >, UILList< DLListBase, solidParticle >, UILList< DLListBase, BasicReactingMultiphaseParcel< ThermoType > >, UILList< DLListBase, parcel >, UILList< DLListBase, entry >, UILList< DLListBase, ParticleType >, UILList< DLListBase, CoalParcel< ThermoType > >, UILList< DLListBase, molecule >, UILList< DLListBase, basicKinematicParcel >, UILList< DLListBase, basicThermoParcel >, and UILList< DLListBase, ParcelType >.

Definition at line 103 of file DLListBaseI.H.

References Foam::abort(), Foam::FatalError, and FatalErrorIn.

Foam::DLListBase::link * last ( )
inline

Return last entry.

Reimplemented in LList< DLListBase, T >, LList< DLListBase, entry * >, LList< DLListBase, T * >, LList< DLListBase, phase * >, LList< DLListBase, autoPtr< regExp > >, LPtrList< DLListBase, T >, LPtrList< DLListBase, phase >, UILList< DLListBase, passiveParticle >, UILList< DLListBase, indexedParticle >, UILList< DLListBase, CallbackType >, UILList< DLListBase, T >, UILList< DLListBase, trackedParticle >, UILList< DLListBase, dsmcParcel >, UILList< DLListBase, BasicReactingParcel< ThermoType > >, UILList< DLListBase, solidParticle >, UILList< DLListBase, BasicReactingMultiphaseParcel< ThermoType > >, UILList< DLListBase, parcel >, UILList< DLListBase, entry >, UILList< DLListBase, ParticleType >, UILList< DLListBase, CoalParcel< ThermoType > >, UILList< DLListBase, molecule >, UILList< DLListBase, basicKinematicParcel >, UILList< DLListBase, basicThermoParcel >, and UILList< DLListBase, ParcelType >.

Definition at line 116 of file DLListBaseI.H.

References Foam::abort(), Foam::FatalError, and FatalErrorIn.

const Foam::DLListBase::link * last ( ) const
inline

Return const access to last entry.

Reimplemented in LList< DLListBase, T >, LList< DLListBase, entry * >, LList< DLListBase, T * >, LList< DLListBase, phase * >, LList< DLListBase, autoPtr< regExp > >, LPtrList< DLListBase, T >, LPtrList< DLListBase, phase >, UILList< DLListBase, passiveParticle >, UILList< DLListBase, indexedParticle >, UILList< DLListBase, CallbackType >, UILList< DLListBase, T >, UILList< DLListBase, trackedParticle >, UILList< DLListBase, dsmcParcel >, UILList< DLListBase, BasicReactingParcel< ThermoType > >, UILList< DLListBase, solidParticle >, UILList< DLListBase, BasicReactingMultiphaseParcel< ThermoType > >, UILList< DLListBase, parcel >, UILList< DLListBase, entry >, UILList< DLListBase, ParticleType >, UILList< DLListBase, CoalParcel< ThermoType > >, UILList< DLListBase, molecule >, UILList< DLListBase, basicKinematicParcel >, UILList< DLListBase, basicThermoParcel >, and UILList< DLListBase, ParcelType >.

Definition at line 129 of file DLListBaseI.H.

References Foam::abort(), Foam::FatalError, and FatalErrorIn.

void insert ( DLListBase::link *  a)

Add at head of list.

Definition at line 48 of file DLListBase.C.

References DLListBase::link::next_, and DLListBase::link::prev_.

void append ( DLListBase::link *  a)

Add at tail of list.

Definition at line 68 of file DLListBase.C.

References DLListBase::link::next_, and DLListBase::link::prev_.

Referenced by dictionary::add(), and IOPosition< ParticleType >::readData().

bool swapUp ( DLListBase::link *  a)

Swap this element with the one above unless it is at the top.

Definition at line 88 of file DLListBase.C.

References DLListBase::link::next_, and DLListBase::link::prev_.

bool swapDown ( DLListBase::link *  a)

Swap this element with the one below unless it is at the bottom.

Definition at line 129 of file DLListBase.C.

References DLListBase::link::next_, and DLListBase::link::prev_.

Foam::DLListBase::link * removeHead ( )

Remove and return head.

Reimplemented in LList< DLListBase, T >, LList< DLListBase, entry * >, LList< DLListBase, T * >, LList< DLListBase, phase * >, LList< DLListBase, autoPtr< regExp > >, UILList< DLListBase, passiveParticle >, UILList< DLListBase, indexedParticle >, UILList< DLListBase, CallbackType >, UILList< DLListBase, T >, UILList< DLListBase, trackedParticle >, UILList< DLListBase, dsmcParcel >, UILList< DLListBase, BasicReactingParcel< ThermoType > >, UILList< DLListBase, solidParticle >, UILList< DLListBase, BasicReactingMultiphaseParcel< ThermoType > >, UILList< DLListBase, parcel >, UILList< DLListBase, entry >, UILList< DLListBase, ParticleType >, UILList< DLListBase, CoalParcel< ThermoType > >, UILList< DLListBase, molecule >, UILList< DLListBase, basicKinematicParcel >, UILList< DLListBase, basicThermoParcel >, and UILList< DLListBase, ParcelType >.

Definition at line 170 of file DLListBase.C.

References Foam::abort(), DLListBase::link::deregister(), f(), Foam::FatalError, FatalErrorIn, and DLListBase::link::next_.

Foam::DLListBase::link * remove ( DLListBase::link *  l)

Remove and return element.

Reimplemented in LList< DLListBase, T >, LList< DLListBase, entry * >, LList< DLListBase, T * >, LList< DLListBase, phase * >, and LList< DLListBase, autoPtr< regExp > >.

Definition at line 194 of file DLListBase.C.

References DLListBase::link::deregister(), DLListBase::link::next_, and DLListBase::link::prev_.

Foam::DLListBase::link * remove ( DLListBase::iterator &  it)
inline

Reimplemented in LList< DLListBase, T >, LList< DLListBase, entry * >, LList< DLListBase, T * >, LList< DLListBase, phase * >, LList< DLListBase, autoPtr< regExp > >, UILList< DLListBase, passiveParticle >, UILList< DLListBase, indexedParticle >, UILList< DLListBase, CallbackType >, UILList< DLListBase, T >, UILList< DLListBase, trackedParticle >, UILList< DLListBase, dsmcParcel >, UILList< DLListBase, BasicReactingParcel< ThermoType > >, UILList< DLListBase, solidParticle >, UILList< DLListBase, BasicReactingMultiphaseParcel< ThermoType > >, UILList< DLListBase, parcel >, UILList< DLListBase, entry >, UILList< DLListBase, ParticleType >, UILList< DLListBase, CoalParcel< ThermoType > >, UILList< DLListBase, molecule >, UILList< DLListBase, basicKinematicParcel >, UILList< DLListBase, basicThermoParcel >, and UILList< DLListBase, ParcelType >.

Definition at line 161 of file DLListBaseI.H.

Foam::DLListBase::link * replace ( DLListBase::link *  oldLink,
DLListBase::link *  newLink 
)

Replace oldLink with newLink and return element.

Definition at line 227 of file DLListBase.C.

References DLListBase::link::deregister(), DLListBase::link::next_, and DLListBase::link::prev_.

Referenced by dictionary::add(), and dictionary::changeKeyword().

Foam::DLListBase::link * replace ( DLListBase::iterator &  oldIter,
DLListBase::link *  newLink 
)
inline

Replace oldIter with newLink and return element.

Definition at line 171 of file DLListBaseI.H.

void clear ( )
inline

Clear the list.

Reimplemented in DsmcCloud< ParcelType >, dictionary, Cloud< ParticleType >, Cloud< BasicReactingMultiphaseParcel< ThermoType > >, Cloud< basicThermoParcel >, Cloud< indexedParticle >, Cloud< trackedParticle >, Cloud< ParcelType >, Cloud< parcel >, Cloud< basicKinematicParcel >, Cloud< solidParticle >, Cloud< CoalParcel< ThermoType > >, Cloud< molecule >, Cloud< passiveParticle >, Cloud< dsmcParcel >, Cloud< BasicReactingParcel< ThermoType > >, LList< DLListBase, T >, LList< DLListBase, entry * >, LList< DLListBase, T * >, LList< DLListBase, phase * >, LList< DLListBase, autoPtr< regExp > >, LPtrList< DLListBase, T >, LPtrList< DLListBase, phase >, DictionaryBase< DLPtrList< phase >, phase >, DictionaryBase< UIDLList< T >, T >, DictionaryBase< IDLList< T >, T >, DictionaryBase< DLList< T * >, T >, DictionaryBase< DLPtrList< T >, T >, ILList< DLListBase, passiveParticle >, ILList< DLListBase, indexedParticle >, ILList< DLListBase, T >, ILList< DLListBase, trackedParticle >, ILList< DLListBase, dsmcParcel >, ILList< DLListBase, BasicReactingParcel< ThermoType > >, ILList< DLListBase, solidParticle >, ILList< DLListBase, BasicReactingMultiphaseParcel< ThermoType > >, ILList< DLListBase, parcel >, ILList< DLListBase, entry >, ILList< DLListBase, ParticleType >, ILList< DLListBase, CoalParcel< ThermoType > >, ILList< DLListBase, molecule >, ILList< DLListBase, basicKinematicParcel >, ILList< DLListBase, basicThermoParcel >, and ILList< DLListBase, ParcelType >.

Definition at line 141 of file DLListBaseI.H.

Referenced by DLListBase::transfer().

void transfer ( DLListBase &  lst)
inline

Transfer the contents of the argument into this List.

and annull the argument list.

Definition at line 149 of file DLListBaseI.H.

References DLListBase::clear().

Foam::DLListBase::iterator begin ( )
inline

Reimplemented in Cloud< ParticleType >, Cloud< BasicReactingMultiphaseParcel< ThermoType > >, Cloud< basicThermoParcel >, Cloud< indexedParticle >, Cloud< trackedParticle >, Cloud< ParcelType >, Cloud< parcel >, Cloud< basicKinematicParcel >, Cloud< solidParticle >, Cloud< CoalParcel< ThermoType > >, Cloud< molecule >, Cloud< passiveParticle >, Cloud< dsmcParcel >, and Cloud< BasicReactingParcel< ThermoType > >.

Definition at line 253 of file DLListBaseI.H.

References DLListBase::first(), DLListBase::iterator, and DLListBase::size().

Referenced by dictionary::changeKeyword(), dictionary::found(), dictionary::lookupEntryPtr(), and dictionary::remove().

const Foam::DLListBase::iterator & end ( )
inline

Reimplemented in Cloud< ParticleType >, Cloud< BasicReactingMultiphaseParcel< ThermoType > >, Cloud< basicThermoParcel >, Cloud< indexedParticle >, Cloud< trackedParticle >, Cloud< ParcelType >, Cloud< parcel >, Cloud< basicKinematicParcel >, Cloud< solidParticle >, Cloud< CoalParcel< ThermoType > >, Cloud< molecule >, Cloud< passiveParticle >, Cloud< dsmcParcel >, Cloud< BasicReactingParcel< ThermoType > >, and JobInfo.

Definition at line 266 of file DLListBaseI.H.

Foam::DLListBase::const_iterator cbegin ( ) const
inline

Reimplemented in Cloud< ParticleType >, Cloud< BasicReactingMultiphaseParcel< ThermoType > >, Cloud< basicThermoParcel >, Cloud< indexedParticle >, Cloud< trackedParticle >, Cloud< ParcelType >, Cloud< parcel >, Cloud< basicKinematicParcel >, Cloud< solidParticle >, Cloud< CoalParcel< ThermoType > >, Cloud< molecule >, Cloud< passiveParticle >, Cloud< dsmcParcel >, and Cloud< BasicReactingParcel< ThermoType > >.

Definition at line 352 of file DLListBaseI.H.

References DLListBase::const_iterator, DLListBase::first(), and DLListBase::size().

Referenced by DLListBase::begin().

const Foam::DLListBase::const_iterator & cend ( ) const
inline

Reimplemented in Cloud< ParticleType >, Cloud< BasicReactingMultiphaseParcel< ThermoType > >, Cloud< basicThermoParcel >, Cloud< indexedParticle >, Cloud< trackedParticle >, Cloud< ParcelType >, Cloud< parcel >, Cloud< basicKinematicParcel >, Cloud< solidParticle >, Cloud< CoalParcel< ThermoType > >, Cloud< molecule >, Cloud< passiveParticle >, Cloud< dsmcParcel >, and Cloud< BasicReactingParcel< ThermoType > >.

Definition at line 366 of file DLListBaseI.H.

Foam::DLListBase::const_iterator begin ( ) const
inline

Reimplemented in Cloud< ParticleType >, Cloud< BasicReactingMultiphaseParcel< ThermoType > >, Cloud< basicThermoParcel >, Cloud< indexedParticle >, Cloud< trackedParticle >, Cloud< ParcelType >, Cloud< parcel >, Cloud< basicKinematicParcel >, Cloud< solidParticle >, Cloud< CoalParcel< ThermoType > >, Cloud< molecule >, Cloud< passiveParticle >, Cloud< dsmcParcel >, and Cloud< BasicReactingParcel< ThermoType > >.

Definition at line 373 of file DLListBaseI.H.

References DLListBase::cbegin().

const Foam::DLListBase::const_iterator & end ( ) const
inline

Reimplemented in Cloud< ParticleType >, Cloud< BasicReactingMultiphaseParcel< ThermoType > >, Cloud< basicThermoParcel >, Cloud< indexedParticle >, Cloud< trackedParticle >, Cloud< ParcelType >, Cloud< parcel >, Cloud< basicKinematicParcel >, Cloud< solidParticle >, Cloud< CoalParcel< ThermoType > >, Cloud< molecule >, Cloud< passiveParticle >, Cloud< dsmcParcel >, and Cloud< BasicReactingParcel< ThermoType > >.

Definition at line 380 of file DLListBaseI.H.

Friends And Related Function Documentation

friend class iterator
friend

Reimplemented in Cloud< ParticleType >, Cloud< BasicReactingMultiphaseParcel< ThermoType > >, Cloud< basicThermoParcel >, Cloud< indexedParticle >, Cloud< trackedParticle >, Cloud< ParcelType >, Cloud< parcel >, Cloud< basicKinematicParcel >, Cloud< solidParticle >, Cloud< CoalParcel< ThermoType > >, Cloud< molecule >, Cloud< passiveParticle >, Cloud< dsmcParcel >, Cloud< BasicReactingParcel< ThermoType > >, LPtrList< DLListBase, T >, LPtrList< DLListBase, phase >, LList< DLListBase, T >, LList< DLListBase, entry * >, LList< DLListBase, T * >, LList< DLListBase, phase * >, LList< DLListBase, autoPtr< regExp > >, UILList< DLListBase, passiveParticle >, UILList< DLListBase, indexedParticle >, UILList< DLListBase, CallbackType >, UILList< DLListBase, T >, UILList< DLListBase, trackedParticle >, UILList< DLListBase, dsmcParcel >, UILList< DLListBase, BasicReactingParcel< ThermoType > >, UILList< DLListBase, solidParticle >, UILList< DLListBase, BasicReactingMultiphaseParcel< ThermoType > >, UILList< DLListBase, parcel >, UILList< DLListBase, entry >, UILList< DLListBase, ParticleType >, UILList< DLListBase, CoalParcel< ThermoType > >, UILList< DLListBase, molecule >, UILList< DLListBase, basicKinematicParcel >, UILList< DLListBase, basicThermoParcel >, and UILList< DLListBase, ParcelType >.

Definition at line 97 of file DLListBase.H.

Referenced by DLListBase::begin().

friend class const_iterator
friend

Reimplemented in Cloud< ParticleType >, Cloud< BasicReactingMultiphaseParcel< ThermoType > >, Cloud< basicThermoParcel >, Cloud< indexedParticle >, Cloud< trackedParticle >, Cloud< ParcelType >, Cloud< parcel >, Cloud< basicKinematicParcel >, Cloud< solidParticle >, Cloud< CoalParcel< ThermoType > >, Cloud< molecule >, Cloud< passiveParticle >, Cloud< dsmcParcel >, Cloud< BasicReactingParcel< ThermoType > >, LPtrList< DLListBase, T >, LPtrList< DLListBase, phase >, LList< DLListBase, T >, LList< DLListBase, entry * >, LList< DLListBase, T * >, LList< DLListBase, phase * >, LList< DLListBase, autoPtr< regExp > >, UILList< DLListBase, passiveParticle >, UILList< DLListBase, indexedParticle >, UILList< DLListBase, CallbackType >, UILList< DLListBase, T >, UILList< DLListBase, trackedParticle >, UILList< DLListBase, dsmcParcel >, UILList< DLListBase, BasicReactingParcel< ThermoType > >, UILList< DLListBase, solidParticle >, UILList< DLListBase, BasicReactingMultiphaseParcel< ThermoType > >, UILList< DLListBase, parcel >, UILList< DLListBase, entry >, UILList< DLListBase, ParticleType >, UILList< DLListBase, CoalParcel< ThermoType > >, UILList< DLListBase, molecule >, UILList< DLListBase, basicKinematicParcel >, UILList< DLListBase, basicThermoParcel >, and UILList< DLListBase, ParcelType >.

Definition at line 100 of file DLListBase.H.

Referenced by DLListBase::cbegin().

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