A List with indirect addressing. More...

Inheritance diagram for UIndirectList< T >:

[legend]

Public Types
typedef T	value_type
	Type of values the UList contains. More...

typedef T &	reference
	Type that can be used for storing into. More...

typedef const T &	const_reference
	Type that can be used for storing into. More...

typedef label	difference_type
	The type that can represent the difference between any two. More...

typedef label	size_type
	The type that can represent the size of a UList. More...

Public Member Functions
	UIndirectList (const UList< T > &, const labelUList &)
	Construct given the complete list and the addressing array. More...

	UIndirectList (const UIndirectList< T > &)=default
	Copy constructor. More...

label	size () const
	Return the number of elements in the list. More...

bool	empty () const
	Return true if the list is empty (ie, size() is zero). More...

T &	first ()
	Return the first element of the list. More...

const T &	first () const
	Return first element of the list. More...

T &	last ()
	Return the last element of the list. More...

const T &	last () const
	Return the last element of the list. More...

label	fcIndex (const label i) const
	Return the forward circular index, i.e. the next index. More...

label	rcIndex (const label i) const
	Return the reverse circular index, i.e. the previous index. More...

const UList< T > &	completeList () const
	Return the complete list. More...

const List< label > &	addressing () const
	Return the list addressing. More...

List< T >	operator() () const
	Return the addressed elements as a List. More...

T &	operator[] (const label)
	Return non-const access to an element. More...

const T &	operator[] (const label) const
	Return const access to an element. More...

void	operator= (const UList< T > &)
	Assignment to UList of addressed elements. More...

void	operator= (const UIndirectList< T > &)
	Assignment to UIndirectList of addressed elements. More...

void	operator= (const T &)
	Assignment of all entries to the given value. More...

Friends
Ostream &	operator (Ostream &, const UIndirectList< T > &)
	Write UIndirectList to Ostream. More...

Detailed Description

template<class T>
class Foam::UIndirectList< T >

A List with indirect addressing.

Like IndirectList but does not store addressing.

Note the const_cast of the completeList. This is so we can use it both on const and non-const lists. Alternative would be to have a const_ variant etc.

Source files

Definition at line 106 of file fvMatrix.H.

Member Typedef Documentation

◆ value_type

typedef T value_type

Type of values the UList contains.

Definition at line 139 of file UIndirectList.H.

◆ reference

typedef T& reference

Type that can be used for storing into.

UList::value_type objects.

Definition at line 143 of file UIndirectList.H.

◆ const_reference

typedef const T& const_reference

Type that can be used for storing into.

constant UList::value_type objects

Definition at line 147 of file UIndirectList.H.

◆ difference_type

typedef label difference_type

The type that can represent the difference between any two.

UList iterator objects.

Definition at line 151 of file UIndirectList.H.

◆ size_type

typedef label size_type

The type that can represent the size of a UList.

Definition at line 154 of file UIndirectList.H.

Constructor & Destructor Documentation

◆ UIndirectList() [1/2]

UIndirectList	(	const UList< T > &	completeList,
		const labelUList &	addr
	)

inline

Construct given the complete list and the addressing array.

Definition at line 30 of file UIndirectListI.H.

◆ UIndirectList() [2/2]

UIndirectList ( const UIndirectList< T > & )

default

Copy constructor.

Member Function Documentation

◆ size()

Foam::label size ( ) const

inline

Return the number of elements in the list.

Definition at line 43 of file UIndirectListI.H.

Referenced by DynamicList< Foam::triFace >::append(), List< Field< scalar > >::append(), mappedPatchBase::calcMapping(), UIndirectList< Foam::Vector >::operator=(), List< Field< scalar > >::operator=(), PackedList< 2 >::operator=(), combineFaces::setRefinement(), and faceZoneSet::updateSet().

Here is the caller graph for this function:

◆ empty()

bool empty ( ) const

inline

Return true if the list is empty (ie, size() is zero).

Definition at line 50 of file UIndirectListI.H.

◆ first() [1/2]

T & first ( )

inline

Return the first element of the list.

Definition at line 57 of file UIndirectListI.H.

◆ first() [2/2]

const T & first ( ) const

inline

Return first element of the list.

Definition at line 64 of file UIndirectListI.H.

◆ last() [1/2]

T & last ( )

inline

Return the last element of the list.

Definition at line 71 of file UIndirectListI.H.

◆ last() [2/2]

const T & last ( ) const

inline

Return the last element of the list.

Definition at line 78 of file UIndirectListI.H.

◆ fcIndex()

Foam::label fcIndex ( const label i ) const

inline

Return the forward circular index, i.e. the next index.

which returns to the first at the end of the list

Definition at line 85 of file UIndirectListI.H.

◆ rcIndex()

Foam::label rcIndex ( const label i ) const

inline

Return the reverse circular index, i.e. the previous index.

which returns to the last at the beginning of the list

Definition at line 92 of file UIndirectListI.H.

◆ completeList()

const Foam::UList< T > & completeList ( ) const

inline

Return the complete list.

Definition at line 99 of file UIndirectListI.H.

◆ addressing()

const Foam::List< Foam::label > & addressing ( ) const

inline

Return the list addressing.

Definition at line 106 of file UIndirectListI.H.

◆ operator()()

Foam::List< T > operator() ( ) const

inline

Return the addressed elements as a List.

Definition at line 115 of file UIndirectListI.H.

◆ operator[]() [1/2]

T & operator[] ( const label i )

inline

Return non-const access to an element.

Definition at line 129 of file UIndirectListI.H.

◆ operator[]() [2/2]

const T & operator[] ( const label i ) const

inline

Return const access to an element.

Definition at line 136 of file UIndirectListI.H.

◆ operator=() [1/3]

void operator= ( const UList< T > & ae )

inline

Assignment to UList of addressed elements.

Definition at line 143 of file UIndirectListI.H.

◆ operator=() [2/3]

void operator= ( const UIndirectList< T > & ae )

inline

Assignment to UIndirectList of addressed elements.

Definition at line 162 of file UIndirectListI.H.

◆ operator=() [3/3]

void operator= ( const T & t )

inline

Assignment of all entries to the given value.

Definition at line 181 of file UIndirectListI.H.

Friends And Related Function Documentation

◆ operator

Ostream& operator	(	Ostream &	,
		const UIndirectList< T > &
	)

friend

Write UIndirectList to Ostream.

Binary output is currently still a bit of a problem

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

src/finiteVolume/fvMatrices/fvMatrix/fvMatrix.H
src/OpenFOAM/containers/Lists/UIndirectList/UIndirectList.H
src/OpenFOAM/containers/Lists/UIndirectList/UIndirectListI.H

Public Types

Public Member Functions

Friends

Detailed Description

template<class T> class Foam::UIndirectList< T >

Member Typedef Documentation

◆ value_type

◆ reference

◆ const_reference

◆ difference_type

◆ size_type

Constructor & Destructor Documentation

◆ UIndirectList() [1/2]

◆ UIndirectList() [2/2]

Member Function Documentation

◆ size()

◆ empty()

◆ first() [1/2]

◆ first() [2/2]

◆ last() [1/2]

◆ last() [2/2]

◆ fcIndex()

◆ rcIndex()

◆ completeList()

◆ addressing()

◆ operator()()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

Friends And Related Function Documentation

◆ operator

template<class T>
class Foam::UIndirectList< T >