FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

SubList< T > Class Template Reference

A List obtained as a section of another List. More...

#include <OpenFOAM/SubList.H>


Detailed Description

template<class T>
class Foam::SubList< T >

A List obtained as a section of another List.

Since the SubList is itself unallocated, no storage is allocated or de-allocated during its use. To achieve this behaviour, SubList is derived from UList rather than List.

Source files

Definition at line 54 of file SubList.H.

Inheritance diagram for SubList< T >:
Collaboration diagram for SubList< T >:

List of all members.

Public Member Functions

 SubList (const UList< T > &list, const label subSize)
 Construct from UList and sub-list size.
 SubList (const UList< T > &list, const label subSize, const label startIndex)
 Construct from UList, sub-list size and start index.
 operator const Foam::List< T > & () const
 Allow cast to a const List<T>&.
void  operator= (const T &)
 Assignment of all entries to the given value.

Static Public Member Functions

static const SubList< T > &  null ()
 Return a null SubList.

Constructor & Destructor Documentation

SubList ( const UList< T > &   list,
const label   subSize  
) [inline]

Construct from UList and sub-list size.

Definition at line 30 of file SubListI.H.

References UList< T >::checkSize().

SubList ( const UList< T > &   list,
const label   subSize,
const label   startIndex  
) [inline]

Construct from UList, sub-list size and start index.

Definition at line 45 of file SubListI.H.

References UList< T >::checkSize(), and UList< T >::checkStart().


Member Function Documentation

const Foam::SubList< T > & null (  ) [inline, static]

Return a null SubList.

Reimplemented from UList< T >.

Reimplemented in SubDimensionedField< Type, GeoMesh >, SubField< Type >, and SubField< point >.

Definition at line 75 of file SubListI.H.

operator const Foam::List< T > & (  ) const [inline]

Allow cast to a const List<T>&.

Reimplemented from UList< T >.

Definition at line 84 of file SubListI.H.

void operator= ( const T &   t  ) [inline]

Assignment of all entries to the given value.

Reimplemented from UList< T >.

Definition at line 91 of file SubListI.H.


The documentation for this class was generated from the following files:
  • src/OpenFOAM/containers/Lists/SubList/SubList.H
  • src/OpenFOAM/containers/Lists/SubList/SubListI.H