DLListBase Class Reference

Base doubly-linked list. More...

Inheritance diagram for DLListBase:

[legend]

Collaboration diagram for DLListBase:

[legend]

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

---

Detailed Description

Base doubly-linked list.

Source files

• DLListBase.H
• DLListBase.C

Definition at line 46 of file DLListBase.H.

---

Constructor & Destructor Documentation

DLListBase

(

)

[inline]

Null construct.

Definition at line 29 of file DLListBaseI.H.

DLListBase

(

link *

a

)

[inline]

Construct given initial entry.

Definition at line 37 of file DLListBaseI.H.

~DLListBase

(

)

[inline]

Definition at line 50 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< molecule >, Cloud< CoalParcel< ThermoType > >, Cloud< trackedParticle >, Cloud< basicKinematicParcel >, Cloud< ParcelType >, Cloud< parcel >, Cloud< solidParticle >, Cloud< dsmcParcel >, Cloud< indexedParticle >, Cloud< passiveParticle >, and Cloud< BasicReactingParcel< ThermoType > >.

Definition at line 69 of file DLListBaseI.H.

Referenced by phaseProperties::phaseProperties(), and Foam::preservePatchTypes().

Here is the caller graph for this function:

bool empty

(

)

const [inline]

Return true if the list is empty.

Definition at line 75 of file DLListBaseI.H.

Foam::DLListBase::link * first

(

)

[inline]

Return first entry.

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

Definition at line 82 of file DLListBaseI.H.

const Foam::DLListBase::link * first

(

)

const [inline]

Return const access to first entry.

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

Definition at line 95 of file DLListBaseI.H.

Foam::DLListBase::link * last

(

)

[inline]

Return last entry.

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

Definition at line 108 of file DLListBaseI.H.

const Foam::DLListBase::link * last

(

)

const [inline]

Return const access to last entry.

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

Definition at line 121 of file DLListBaseI.H.

void insert

(

DLListBase::link *

a

)

Add at head of list.

Definition at line 40 of file DLListBase.C.

void append

(

DLListBase::link *

a

)

Add at tail of list.

Definition at line 60 of file DLListBase.C.

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

Referenced by Cloud< ParticleType >::deleteParticle().

Here is the caller graph for this function:

bool swapUp

(

DLListBase::link *

a

)

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

Definition at line 80 of file DLListBase.C.

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

bool swapDown

(

DLListBase::link *

a

)

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

Definition at line 121 of file DLListBase.C.

Foam::DLListBase::link * removeHead

(

)

Remove and return head.

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

Definition at line 162 of file DLListBase.C.

Foam::DLListBase::link * remove

(

DLListBase::link *

l

)

Remove and return element.

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

Definition at line 186 of file DLListBase.C.

Foam::DLListBase::link * remove

(

DLListBase::iterator &

it

)

[inline]

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

Definition at line 153 of file DLListBaseI.H.

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

Replace oldLink with newLink and return element.

Definition at line 219 of file DLListBase.C.

Referenced by iterator::iterator().

Here is the caller graph for this function:

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

Replace oldIter with newLink and return element.

Definition at line 163 of file DLListBaseI.H.

void clear

(

)

[inline]

Clear the list.

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

Definition at line 133 of file DLListBaseI.H.

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

Here is the call graph for this function:

void transfer

(

DLListBase &

lst

)

[inline]

Transfer the contents of the argument into this List.

and annull the argument list.

Definition at line 141 of file DLListBaseI.H.

Foam::DLListBase::iterator begin

(

)

[inline]

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

Definition at line 245 of file DLListBaseI.H.

const Foam::DLListBase::iterator & end

(

)

[inline]

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

Definition at line 258 of file DLListBaseI.H.

Foam::DLListBase::const_iterator cbegin

(

)

const [inline]

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

Definition at line 344 of file DLListBaseI.H.

Referenced by DLListBase::end().

Here is the caller graph for this function:

const Foam::DLListBase::const_iterator & cend

(

)

const [inline]

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

Definition at line 358 of file DLListBaseI.H.

Foam::DLListBase::const_iterator begin

(

)

const [inline]

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

Definition at line 365 of file DLListBaseI.H.

const Foam::DLListBase::const_iterator & end

(

)

const [inline]

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

Definition at line 372 of file DLListBaseI.H.

References DLListBase::cbegin().

Here is the call graph for this function:

---

Friends And Related Function Documentation

friend class iterator [friend]

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

Definition at line 92 of file DLListBase.H.

friend class const_iterator [friend]

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

Definition at line 95 of file DLListBase.H.

---

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

• src/OpenFOAM/containers/LinkedLists/linkTypes/DLListBase/DLListBase.H
• src/OpenFOAM/containers/LinkedLists/linkTypes/DLListBase/DLListBase.C
• src/OpenFOAM/containers/LinkedLists/linkTypes/DLListBase/DLListBaseI.H