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

A 1D vector of objects of type <T>, where the size of the vector is known and can be used for subscript bounds checking, etc. More...

#include <OpenFOAM/UList.H>


Detailed Description

template<class T>
class Foam::UList< T >

A 1D vector of objects of type <T>, where the size of the vector is known and can be used for subscript bounds checking, etc.

Storage is not allocated during construction or use but is supplied to the constructor as an argument. This type of list is particularly useful for lists that refer to parts of existing lists such as SubList.

Source files

Definition at line 68 of file UList.H.

Inherited by List< T >, and SubList< T >.

Collaboration diagram for UList< T >:

List of all members.

Classes

class  less
 Less function class that can be used for sorting. More...

Public Types

typedef T  value_type
 Type of values the UList contains.
typedef T &  reference
 Type that can be used for storing into.
typedef const T &  const_reference
 Type that can be used for storing into.
typedef label  difference_type
 The type that can represent the difference between any two.
typedef label  size_type
 The type that can represent the size of a UList.
typedef T *  iterator
 Random access iterator for traversing UList.
typedef const T *  const_iterator
 Random access iterator for traversing UList.
typedef T *  reverse_iterator
 Reverse iterator for reverse traversal of UList.
typedef const T *  const_reverse_iterator
 Reverse iterator for reverse traversal of constant UList.

Public Member Functions

 UList ()
 Null constructor.
 UList (T *__restrict__ v, label size)
 Construct from components.
label  fcIndex (const label i) const
 Return the forward circular index, i.e. the next index.
label  rcIndex (const label i) const
 Return the reverse circular index, i.e. the previous index.
label  byteSize () const
 Return the binary size in number of characters of the UList.
const T *  cdata () const
 Return a const pointer to the first data element,.
T *  data ()
 Return a pointer to the first data element,.
void  checkStart (const label start) const
 Check start is within valid range (0 ... size-1).
void  checkSize (const label size) const
 Check size is within valid range (0 ... size).
void  checkIndex (const label i) const
 Check index i is within valid range (0 ... size-1).
void  writeEntry (Ostream &) const
 Write the UList as a dictionary entry.
void  writeEntry (const word &keyword, Ostream &) const
 Write the UList as a dictionary entry with keyword.
void  assign (const UList< T > &)
 Assign elements to those from UList.
T &  operator[] (const label)
 Return element of UList.
const T &  operator[] (const label) const
 Return element of constant UList.
 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.
iterator  begin ()
 Return an iterator to begin traversing the UList.
iterator  end ()
 Return an iterator to end traversing the UList.
const_iterator  cbegin () const
 Return const_iterator to begin traversing the constant UList.
const_iterator  cend () const
 Return const_iterator to end traversing the constant UList.
const_iterator  begin () const
 Return const_iterator to begin traversing the constant UList.
const_iterator  end () const
 Return const_iterator to end traversing the constant UList.
reverse_iterator  rbegin ()
 Return reverse_iterator to begin reverse traversing the UList.
reverse_iterator  rend ()
 Return reverse_iterator to end reverse traversing the UList.
const_reverse_iterator  crbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator  crend () const
 Return const_reverse_iterator to end reverse traversing the UList.
const_reverse_iterator  rbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator  rend () const
 Return const_reverse_iterator to end reverse traversing the UList.
label  size () const
 Return the number of elements in the UList.
label  max_size () const
 Return size of the largest possible UList.
bool  empty () const
 Return true if the UList is empty (ie, size() is zero).
void  swap (UList< T > &)
 Swap two ULists of the same type in constant time.
bool  operator== (const UList< T > &) const
 Equality operation on ULists of the same type.
bool  operator!= (const UList< T > &) const
 The opposite of the equality operation. Takes linear time.
bool  operator< (const UList< T > &) const
 Compare two ULists lexicographically. Takes linear time.
bool  operator> (const UList< T > &) const
 Compare two ULists lexicographically. Takes linear time.
bool  operator<= (const UList< T > &) const
 Return true if !(a > b). Takes linear time.
bool  operator>= (const UList< T > &) const
 Return true if !(a < b). Takes linear time.
template<>
const bool &  operator[] (const label i) const

Static Public Member Functions

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

Friends

class  List< T >
 Declare friendship with the List class.
class  SubList< T >
 Declare friendship with the SubList class.
Ostream &  operator (Ostream &, const UList< T > &)

Member Typedef Documentation

typedef T value_type

Type of values the UList contains.

Definition at line 196 of file UList.H.

typedef T& reference

Type that can be used for storing into.

UList::value_type objects.

Definition at line 200 of file UList.H.

typedef const T& const_reference

Type that can be used for storing into.

constant UList::value_type objects

Definition at line 204 of file UList.H.

typedef label difference_type

The type that can represent the difference between any two.

UList iterator objects.

Definition at line 208 of file UList.H.

typedef label size_type

The type that can represent the size of a UList.

Definition at line 211 of file UList.H.

typedef T* iterator

Random access iterator for traversing UList.

Definition at line 217 of file UList.H.

typedef const T* const_iterator

Random access iterator for traversing UList.

Definition at line 229 of file UList.H.

typedef T* reverse_iterator

Reverse iterator for reverse traversal of UList.

Definition at line 247 of file UList.H.

typedef const T* const_reverse_iterator

Reverse iterator for reverse traversal of constant UList.

Definition at line 259 of file UList.H.


Constructor & Destructor Documentation

UList (  ) [inline]

Null constructor.

Definition at line 33 of file UListI.H.

UList ( T *__restrict__   v,
label   size  
) [inline]

Construct from components.

Definition at line 41 of file UListI.H.


Member Function Documentation

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

Return a null UList.

Reimplemented in List< T >, SubList< T >, DimensionedField< Type, GeoMesh >, SubDimensionedField< Type, GeoMesh >, DynamicField< T, SizeInc, SizeMult, SizeDiv >, Field< Type >, SubField< Type >, GeometricField< Type, PatchField, GeoMesh >, List< processorSurfacePatchFieldDecomposer * >, List< fieldAverageItem >, List< volTensorField * >, List< labelPairList >, List< curvedEdge * >, List< primitivePatch * >, List< pair >, List< const treeLeaf< Type > * >, List< treeBoundBox >, List< injector * >, List< procLduInterface * >, List< List< T > >, List< volVectorField * >, List< cellZone * >, List< tensor >, List< lduInterfacePtrsList * >, List< objectHit >, List< surfaceVectorField * >, List< cellModel * >, List< procPointList >, List< const unallocLabelList * >, List< sixDoFRigidBodyMotionConstraint * >, List< phaseProperties >, List< molecule * >, List< symmTensor >, List< node >, List< MRFZone * >, List< pointMesh * >, List< Pair< word > >, List< faceList >, List< basicSource * >, List< scalar >, List< lduInterfaceFieldPtrsList * >, List< cell >, List< labelList * >, List< sixDoFRigidBodyMotionRestraint * >, List< Time * >, List< surfaceTensorField * >, List< const lduInterfaceField * >, List< DynamicList< string > >, List< commsStruct >, List< polyMeshModifier * >, List< searchableSurface * >, List< T * >, List< const lduInterface * >, List< DynamicList< molecule * > >, List< coordSet * >, List< int >, List< liquid * >, List< wordList >, List< pointPatchMapper * >, List< label >, List< vector >, List< splitCell8 >, List< instant >, List< complexVector >, List< DynamicList< label > >, List< List< cellFaceIdentifier > >, List< Key >, List< List< point > >, List< DynamicList< ParcelType * > >, List< typename CloudType::thermoType * >, List< unsigned int >, List< pointIndexHit >, List< pairPotential * >, List< TimeActivatedExplicitSource< Type > * >, List< gasThermoPhysics * >, List< lduMatrix * >, List< FixedList< label, 3 > >, List< volSymmTensorField * >, List< cellShape >, List< translationRotationVectors >, List< Tuple2< scalar, scalar > >, List< porousZone * >, List< sampledSet * >, List< FieldField< Field, scalar > * >, List< treeLeaf< Type > * >, List< primitivePatchInterpolation * >, List< reactingParcelInjectionData >, List< solid * >, List< sendingReferralList >, List< surfaceSymmTensorField * >, List< Tuple2< word, word > >, List< molecule::constantProperties >, List< string >, List< reactingMultiphaseParcelInjectionData >, List< refineCell >, List< ZoneType * >, List< functionObject * >, List< geometricSurfacePatch >, List< refineMode >, List< dictionary >, List< radiativeIntensityRay * >, List< fvMesh * >, List< surfAndLabel >, List< Type >, List< Field< Type > >, List< processorVolPatchFieldDecomposer * >, List< volSphericalTensorField * >, List< faceZone * >, List< const cellModel * >, List< labelIOList * >, List< SHA1Digest >, List< sampledSurface * >, List< entry * >, List< faceSets >, List< surfZoneIdentifier >, List< pointZone * >, List< ignitionSite * >, List< DimensionedField< scalar, volMesh > * >, List< char >, List< coordinateSystem * >, List< labelledTri >, List< List< pointIndexHit > >, List< referredMolecule >, List< pointHitSort >, List< ThermoType * >, List< labelPair >, List< lduScheduleEntry >, List< ParcelType * >, List< bool >, List< Field< scalar > * >, List< Face >, List< scalarField >, List< List< Key > >, List< labelListList >, List< lduPrimitiveMesh * >, List< labelField * >, List< const label * >, List< receivingReferralList >, List< scalarList >, List< List< Field< scalar > > >, List< ensightPart * >, List< List< treeBoundBox > >, List< surfaceSphericalTensorField * >, List< surfaceScalarField * >, List< patchInteractionData >, List< fvPatchMapper * >, List< referredCell >, List< Tuple2< scalar, Type > >, List< point >, List< mergeInfo >, List< Tuple2< mapType, labelList > >, List< fieldNameValuePair >, List< thermoType * >, List< volScalarField * >, List< typename ParcelType::constantProperties >, List< coupledFacePair * >, List< edge >, List< PatchField< Type > * >, List< engineValve * >, List< surfZone >, List< face >, List< word >, List< tetherPotential * >, List< patchFieldDecomposer * >, List< kinematicParcelInjectionData >, List< cellFaceIdentifier >, List< PointType >, List< objectMap >, List< cellCutType >, List< boundaryPatch * >, List< specieCoeffs >, List< Reaction< ThermoType > * >, List< scalarRange >, List< scalarField * >, List< FixedList< scalar, 3 > >, List< typename ReactingCloud< ParcelType >::thermoType * >, List< labelList >, List< substance >, List< Field< Type > * >, List< vectorField >, List< Field< scalar > >, SubList< Type >, SubList< point >, DimensionedField< tensor, volMesh >, DimensionedField< scalar, volMesh >, DimensionedField< vector, pointMesh >, DimensionedField< scalar, pointMesh >, DimensionedField< Type, volMesh >, DimensionedField< symmTensor, volMesh >, DimensionedField< scalar, surfaceMesh >, DimensionedField< vector, volMesh >, DimensionedField< Type, surfaceMesh >, DimensionedField< Type, pointMesh >, Field< tensor >, Field< symmTensor >, Field< scalar >, Field< label >, Field< vector >, Field< complexVector >, Field< T >, Field< translationRotationVectors >, Field< Field< Type > >, Field< point >, Field< PointType >, SubField< point >, GeometricField< symmTensor, fvPatchField, volMesh >, GeometricField< tensor, fvPatchField, volMesh >, GeometricField< scalar, fvPatchField, volMesh >, GeometricField< scalar, fvsPatchField, surfaceMesh >, GeometricField< Type, fvsPatchField, surfaceMesh >, GeometricField< Type, pointPatchField, pointMesh >, GeometricField< scalar, pointPatchField, pointMesh >, GeometricField< vector, fvPatchField, volMesh >, GeometricField< vector, pointPatchField, pointMesh >, and GeometricField< Type, fvPatchField, volMesh >.

Definition at line 51 of file UListI.H.

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 begining of the list

Definition at line 65 of file UListI.H.

Referenced by edgeFaceCirculator::getMinIndex(), minEqOpFace::operator()(), and faceCollapser::setRefinement().

Foam::label byteSize (  ) const

Return the binary size in number of characters of the UList.

if the element is a primitive type i.e. contiguous<T>() == true

Definition at line 106 of file UList.C.

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

Referenced by Pstream::gatherList(), List< T >::List(), Pstream::listCombineGather(), Pstream::listCombineScatter(), Foam::operator<<(), processorLduInterface::receive(), and processorLduInterface::send().

const T * cdata (  ) const [inline]

Return a const pointer to the first data element,.

similar to the STL front() method and the string::data() method This can be used (with caution) when interfacing with C code.

Definition at line 117 of file UListI.H.

Referenced by Foam::operator<<().

T * data (  ) [inline]

Return a pointer to the first data element,.

similar to the STL front() method and the string::data() method This can be used (with caution) when interfacing with C code.

Definition at line 124 of file UListI.H.

Referenced by patchDataWave< TransferType >::correct(), and Foam::operator>>().

void checkStart ( const label   start  ) const [inline]

Check start is within valid range (0 ... size-1).

Definition at line 73 of file UListI.H.

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

Referenced by SubList< T >::SubList().

void checkSize ( const label   size  ) const [inline]

Check size is within valid range (0 ... size).

Definition at line 86 of file UListI.H.

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

Referenced by SubList< T >::SubList().

void checkIndex ( const label   i  ) const [inline]

Check index i is within valid range (0 ... size-1).

Definition at line 99 of file UListI.H.

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

void writeEntry ( Ostream &   os  ) const

Write the UList as a dictionary entry.

Definition at line 34 of file UListIO.C.

Referenced by faceZone::writeDict(), and Field< Type >::writeEntry().

void writeEntry ( const word &   keyword,
Ostream &   os  
) const
void assign ( const UList< T > &   a  )

Assign elements to those from UList.

Definition at line 37 of file UList.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, List_ACCESS, List_CONST_ACCESS, List_ELEM, List_END_FOR_ALL, List_FOR_ALL, and T.

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

Return element of constant UList.

Note that the bool specialization adds lazy evaluation so reading an out-of-range element returns false without any ill-effects

Reimplemented in PackedList< nBits >, interpolationTable< Type >, interpolationLookUpTable< Type >, speciesTable, PackedList< 2 >, interpolationTable< scalar >, and interpolationLookUpTable< scalar >.

Definition at line 167 of file UListI.H.

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

Allow cast to a const List<T>&.

Reimplemented in SubList< Type >, SubList< T >, and SubList< point >.

Definition at line 178 of file UListI.H.

void operator= ( const T &   t  )

Assignment of all entries to the given value.

Reimplemented in directionMixedFvPatchField< Type >, fixedValueFvPatchField< Type >, mixedFvPatchField< Type >, slicedFvPatchField< Type >, fixedNormalSlipFvPatchField< Type >, partialSlipFvPatchField< Type >, fvPatchField< Type >, fixedValueFvsPatchField< Type >, slicedFvsPatchField< Type >, fvsPatchField< Type >, DynamicList< T, SizeInc, SizeMult, SizeDiv >, List< T >, SortableList< T >, SubList< T >, DynamicField< T, SizeInc, SizeMult, SizeDiv >, Field< Type >, fixedValuePointPatchField< Type >, valuePointPatchField< Type >, mixedFixedValueSlipFvPatchField< Type >, fvPatchField< scalar >, DynamicList< procPointList >, DynamicList< molecule * >, DynamicList< label >, DynamicList< splitCell8 >, DynamicList< string >, DynamicList< referredMolecule >, DynamicList< ParcelType * >, DynamicList< point >, DynamicList< face >, DynamicList< word >, List< processorSurfacePatchFieldDecomposer * >, List< fieldAverageItem >, List< volTensorField * >, List< labelPairList >, List< curvedEdge * >, List< primitivePatch * >, List< pair >, List< const treeLeaf< Type > * >, List< treeBoundBox >, List< injector * >, List< procLduInterface * >, List< List< T > >, List< volVectorField * >, List< cellZone * >, List< tensor >, List< lduInterfacePtrsList * >, List< objectHit >, List< surfaceVectorField * >, List< cellModel * >, List< procPointList >, List< const unallocLabelList * >, List< sixDoFRigidBodyMotionConstraint * >, List< phaseProperties >, List< molecule * >, List< symmTensor >, List< node >, List< MRFZone * >, List< pointMesh * >, List< Pair< word > >, List< faceList >, List< basicSource * >, List< scalar >, List< lduInterfaceFieldPtrsList * >, List< cell >, List< labelList * >, List< sixDoFRigidBodyMotionRestraint * >, List< Time * >, List< surfaceTensorField * >, List< const lduInterfaceField * >, List< DynamicList< string > >, List< commsStruct >, List< polyMeshModifier * >, List< searchableSurface * >, List< T * >, List< const lduInterface * >, List< DynamicList< molecule * > >, List< coordSet * >, List< int >, List< liquid * >, List< wordList >, List< pointPatchMapper * >, List< label >, List< vector >, List< splitCell8 >, List< instant >, List< complexVector >, List< DynamicList< label > >, List< List< cellFaceIdentifier > >, List< Key >, List< List< point > >, List< DynamicList< ParcelType * > >, List< typename CloudType::thermoType * >, List< unsigned int >, List< pointIndexHit >, List< pairPotential * >, List< TimeActivatedExplicitSource< Type > * >, List< gasThermoPhysics * >, List< lduMatrix * >, List< FixedList< label, 3 > >, List< volSymmTensorField * >, List< cellShape >, List< translationRotationVectors >, List< Tuple2< scalar, scalar > >, List< porousZone * >, List< sampledSet * >, List< FieldField< Field, scalar > * >, List< treeLeaf< Type > * >, List< primitivePatchInterpolation * >, List< reactingParcelInjectionData >, List< solid * >, List< sendingReferralList >, List< surfaceSymmTensorField * >, List< Tuple2< word, word > >, List< molecule::constantProperties >, List< string >, List< reactingMultiphaseParcelInjectionData >, List< refineCell >, List< ZoneType * >, List< functionObject * >, List< geometricSurfacePatch >, List< refineMode >, List< dictionary >, List< radiativeIntensityRay * >, List< fvMesh * >, List< surfAndLabel >, List< Type >, List< Field< Type > >, List< processorVolPatchFieldDecomposer * >, List< volSphericalTensorField * >, List< faceZone * >, List< const cellModel * >, List< labelIOList * >, List< SHA1Digest >, List< sampledSurface * >, List< entry * >, List< faceSets >, List< surfZoneIdentifier >, List< pointZone * >, List< ignitionSite * >, List< DimensionedField< scalar, volMesh > * >, List< char >, List< coordinateSystem * >, List< labelledTri >, List< List< pointIndexHit > >, List< referredMolecule >, List< pointHitSort >, List< ThermoType * >, List< labelPair >, List< lduScheduleEntry >, List< ParcelType * >, List< bool >, List< Field< scalar > * >, List< Face >, List< scalarField >, List< List< Key > >, List< labelListList >, List< lduPrimitiveMesh * >, List< labelField * >, List< const label * >, List< receivingReferralList >, List< scalarList >, List< List< Field< scalar > > >, List< ensightPart * >, List< List< treeBoundBox > >, List< surfaceSphericalTensorField * >, List< surfaceScalarField * >, List< patchInteractionData >, List< fvPatchMapper * >, List< referredCell >, List< Tuple2< scalar, Type > >, List< point >, List< mergeInfo >, List< Tuple2< mapType, labelList > >, List< fieldNameValuePair >, List< thermoType * >, List< volScalarField * >, List< typename ParcelType::constantProperties >, List< coupledFacePair * >, List< edge >, List< PatchField< Type > * >, List< engineValve * >, List< surfZone >, List< face >, List< word >, List< tetherPotential * >, List< patchFieldDecomposer * >, List< kinematicParcelInjectionData >, List< cellFaceIdentifier >, List< PointType >, List< objectMap >, List< cellCutType >, List< boundaryPatch * >, List< specieCoeffs >, List< Reaction< ThermoType > * >, List< scalarRange >, List< scalarField * >, List< FixedList< scalar, 3 > >, List< typename ReactingCloud< ParcelType >::thermoType * >, List< labelList >, List< substance >, List< Field< Type > * >, List< vectorField >, List< Field< scalar > >, SubList< Type >, SubList< point >, Field< tensor >, Field< symmTensor >, Field< scalar >, Field< label >, Field< vector >, Field< complexVector >, Field< T >, Field< translationRotationVectors >, Field< Field< Type > >, Field< point >, Field< PointType >, fixedValuePointPatchField< vector >, and valuePointPatchField< vector >.

Definition at line 70 of file UList.C.

References List_ACCESS, List_ELEM, List_END_FOR_ALL, List_FOR_ALL, and T.

Referenced by DynamicField< T, SizeInc, SizeMult, SizeDiv >::operator=(), SortableList< T >::operator=(), DynamicList< T, SizeInc, SizeMult, SizeDiv >::operator=(), slicedFvPatchField< Type >::slicedFvPatchField(), slicedFvsPatchField< Type >::slicedFvsPatchField(), slicedFvPatchField< Type >::~slicedFvPatchField(), and slicedFvsPatchField< Type >::~slicedFvsPatchField().

Foam::UList< T >::const_iterator cbegin (  ) const [inline]

Return const_iterator to begin traversing the constant UList.

Reimplemented in PackedList< nBits >, and PackedList< 2 >.

Definition at line 202 of file UListI.H.

Foam::UList< T >::const_iterator cend (  ) const [inline]

Return const_iterator to end traversing the constant UList.

Reimplemented in PackedList< nBits >, and PackedList< 2 >.

Definition at line 223 of file UListI.H.

Foam::UList< T >::const_iterator begin (  ) const [inline]

Return const_iterator to begin traversing the constant UList.

Reimplemented in PackedList< nBits >, and PackedList< 2 >.

Definition at line 195 of file UListI.H.

Foam::UList< T >::const_iterator end (  ) const [inline]

Return const_iterator to end traversing the constant UList.

Reimplemented in PackedList< nBits >, faceOnlySet, and PackedList< 2 >.

Definition at line 216 of file UListI.H.

Foam::UList< T >::iterator rbegin (  ) [inline]

Return reverse_iterator to begin reverse traversing the UList.

Definition at line 230 of file UListI.H.

Referenced by ITstream::print().

Foam::UList< T >::iterator rend (  ) [inline]

Return reverse_iterator to end reverse traversing the UList.

Definition at line 251 of file UListI.H.

Foam::UList< T >::const_iterator crbegin (  ) const [inline]

Return const_reverse_iterator to begin reverse traversing the UList.

Definition at line 244 of file UListI.H.

Foam::UList< T >::const_iterator crend (  ) const [inline]

Return const_reverse_iterator to end reverse traversing the UList.

Definition at line 265 of file UListI.H.

Foam::UList< T >::const_iterator rbegin (  ) const [inline]

Return const_reverse_iterator to begin reverse traversing the UList.

Definition at line 237 of file UListI.H.

Foam::UList< T >::const_iterator rend (  ) const [inline]

Return const_reverse_iterator to end reverse traversing the UList.

Definition at line 258 of file UListI.H.

Foam::label size (  ) const [inline]

Return the number of elements in the UList.

Reimplemented in triSurfaceMesh, List< T >, PackedList< nBits >, valuePointPatchField< Type >, MeshedSurface< Face >, surfMesh, UnsortedMeshedSurface< Face >, List< processorSurfacePatchFieldDecomposer * >, List< fieldAverageItem >, List< volTensorField * >, List< labelPairList >, List< curvedEdge * >, List< primitivePatch * >, List< pair >, List< const treeLeaf< Type > * >, List< treeBoundBox >, List< injector * >, List< procLduInterface * >, List< List< T > >, List< volVectorField * >, List< cellZone * >, List< tensor >, List< lduInterfacePtrsList * >, List< objectHit >, List< surfaceVectorField * >, List< cellModel * >, List< procPointList >, List< const unallocLabelList * >, List< sixDoFRigidBodyMotionConstraint * >, List< phaseProperties >, List< molecule * >, List< symmTensor >, List< node >, List< MRFZone * >, List< pointMesh * >, List< Pair< word > >, List< faceList >, List< basicSource * >, List< scalar >, List< lduInterfaceFieldPtrsList * >, List< cell >, List< labelList * >, List< sixDoFRigidBodyMotionRestraint * >, List< Time * >, List< surfaceTensorField * >, List< const lduInterfaceField * >, List< DynamicList< string > >, List< commsStruct >, List< polyMeshModifier * >, List< searchableSurface * >, List< T * >, List< const lduInterface * >, List< DynamicList< molecule * > >, List< coordSet * >, List< int >, List< liquid * >, List< wordList >, List< pointPatchMapper * >, List< label >, List< vector >, List< splitCell8 >, List< instant >, List< complexVector >, List< DynamicList< label > >, List< List< cellFaceIdentifier > >, List< Key >, List< List< point > >, List< DynamicList< ParcelType * > >, List< typename CloudType::thermoType * >, List< unsigned int >, List< pointIndexHit >, List< pairPotential * >, List< TimeActivatedExplicitSource< Type > * >, List< gasThermoPhysics * >, List< lduMatrix * >, List< FixedList< label, 3 > >, List< volSymmTensorField * >, List< cellShape >, List< translationRotationVectors >, List< Tuple2< scalar, scalar > >, List< porousZone * >, List< sampledSet * >, List< FieldField< Field, scalar > * >, List< treeLeaf< Type > * >, List< primitivePatchInterpolation * >, List< reactingParcelInjectionData >, List< solid * >, List< sendingReferralList >, List< surfaceSymmTensorField * >, List< Tuple2< word, word > >, List< molecule::constantProperties >, List< string >, List< reactingMultiphaseParcelInjectionData >, List< refineCell >, List< ZoneType * >, List< functionObject * >, List< geometricSurfacePatch >, List< refineMode >, List< dictionary >, List< radiativeIntensityRay * >, List< fvMesh * >, List< surfAndLabel >, List< Type >, List< Field< Type > >, List< processorVolPatchFieldDecomposer * >, List< volSphericalTensorField * >, List< faceZone * >, List< const cellModel * >, List< labelIOList * >, List< SHA1Digest >, List< sampledSurface * >, List< entry * >, List< faceSets >, List< surfZoneIdentifier >, List< pointZone * >, List< ignitionSite * >, List< DimensionedField< scalar, volMesh > * >, List< char >, List< coordinateSystem * >, List< labelledTri >, List< List< pointIndexHit > >, List< referredMolecule >, List< pointHitSort >, List< ThermoType * >, List< labelPair >, List< lduScheduleEntry >, List< ParcelType * >, List< bool >, List< Field< scalar > * >, List< Face >, List< scalarField >, List< List< Key > >, List< labelListList >, List< lduPrimitiveMesh * >, List< labelField * >, List< const label * >, List< receivingReferralList >, List< scalarList >, List< List< Field< scalar > > >, List< ensightPart * >, List< List< treeBoundBox > >, List< surfaceSphericalTensorField * >, List< surfaceScalarField * >, List< patchInteractionData >, List< fvPatchMapper * >, List< referredCell >, List< Tuple2< scalar, Type > >, List< point >, List< mergeInfo >, List< Tuple2< mapType, labelList > >, List< fieldNameValuePair >, List< thermoType * >, List< volScalarField * >, List< typename ParcelType::constantProperties >, List< coupledFacePair * >, List< edge >, List< PatchField< Type > * >, List< engineValve * >, List< surfZone >, List< face >, List< word >, List< tetherPotential * >, List< patchFieldDecomposer * >, List< kinematicParcelInjectionData >, List< cellFaceIdentifier >, List< PointType >, List< objectMap >, List< cellCutType >, List< boundaryPatch * >, List< specieCoeffs >, List< Reaction< ThermoType > * >, List< scalarRange >, List< scalarField * >, List< FixedList< scalar, 3 > >, List< typename ReactingCloud< ParcelType >::thermoType * >, List< labelList >, List< substance >, List< Field< Type > * >, List< vectorField >, List< Field< scalar > >, PackedList< 2 >, valuePointPatchField< vector >, and MeshedSurface< face >.

Definition at line 271 of file UListI.H.

Referenced by MeshedSurface< Face >::addZones(), pairGAMGAgglomeration::agglomerate(), GAMGAgglomeration::agglomerateLduAddressing(), DynamicField< T, SizeInc, SizeMult, SizeDiv >::append(), List< T >::append(), DynamicList< T, SizeInc, SizeMult, SizeDiv >::append(), Field< Type >::autoMap(), scotchDecomp::calcCSR(), coupledPolyPatch::calcFaceCentres(), coupledPolyPatch::calcFaceTol(), Foam::cmptAv(), Foam::cmptMag(), Foam::cmptMax(), Foam::cmptMin(), Foam::ComplexField(), processorLduInterface::compressedReceive(), processorLduInterface::compressedSend(), Foam::duplicateOrder(), lduMatrix::faceH(), Foam::findMatchingStrings(), FixedList< T, Size >::FixedList(), Foam::gAverage(), coupledPolyPatch::getAnchorPoints(), Foam::Im(), Foam::ImComplexField(), Foam::inplaceSubset(), surfaceInterpolationScheme< Type >::interpolate(), Foam::inv(), cell::labels(), Foam::mag(), Foam::magSqr(), Field< Type >::map(), Foam::matchPoints(), Foam::max(), Foam::mergePoints(), MeshedSurface< Face >::MeshedSurface(), lduMatrix::negSumDiag(), octreeDataFace::octreeDataFace(), DynamicField< T, SizeInc, SizeMult, SizeDiv >::operator=(), UIndirectList< T >::operator=(), PackedList< nBits >::operator=(), IndirectList< T >::operator=(), FixedList< T, Size >::operator=(), BiIndirectList< T >::operator=(), PatchInjection< CloudType >::PatchInjection(), Foam::pow(), Foam::Re(), OFFsurfaceFormat< Face >::read(), OBJsurfaceFormat< Face >::read(), AC3DsurfaceFormat< Face >::read(), Foam::ReComplexField(), Foam::ReImSum(), UnsortedMeshedSurface< Face >::remapFaces(), MeshedSurface< Face >::remapFaces(), cuttingPlane::remapFaces(), UPtrList< T >::reorder(), PtrList< T >::reorder(), Foam::reverse(), processorLduInterface::send(), syncTools::separateList(), CompactListList< T >::setSize(), CompactListList_dev< T, Container >::setSize(), UnsortedMeshedSurface< Face >::setZones(), wordReListMatcher::size(), Foam::sortedOrder(), Foam::sqr(), Foam::stabilise(), Foam::subset(), Foam::sumCmptProd(), lduMatrix::sumDiag(), lduMatrix::sumMagOffDiag(), Foam::sumSqr(), syncTools::syncBoundaryFaceList(), syncTools::syncEdgeList(), syncTools::syncFaceList(), syncTools::syncPointList(), meshRefinement::testSyncBoundaryFaceList(), Foam::transform(), Foam::transformList(), treeBoundBox::treeBoundBox(), UnsortedMeshedSurface< Face >::UnsortedMeshedSurface(), WRLsurfaceFormatCore::writeHeader(), OFSsurfaceFormatCore::writeHeader(), AC3DsurfaceFormatCore::writeHeader(), coupledPolyPatch::writeOBJ(), and VTKsurfaceFormatCore::writeTail().

Foam::label max_size (  ) const [inline]

Return size of the largest possible UList.

Definition at line 278 of file UListI.H.

void swap ( UList< T > &   a  )

Swap two ULists of the same type in constant time.

Definition at line 82 of file UList.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, List_ACCESS, List_ELEM, List_END_FOR_ALL, List_FOR_ALL, and T.

bool operator== ( const UList< T > &   a  ) const

Equality operation on ULists of the same type.

Returns true when the ULists are elementwise equal (using UList::value_type::operator==). Takes linear time.

Definition at line 151 of file UList.C.

References equal(), List_CONST_ACCESS, List_ELEM, List_END_FOR_ALL, List_FOR_ALL, and T.

bool operator!= ( const UList< T > &   a  ) const

The opposite of the equality operation. Takes linear time.

Definition at line 172 of file UList.C.

References Foam::operator==().

bool operator< ( const UList< T > &   a  ) const

Compare two ULists lexicographically. Takes linear time.

Definition at line 179 of file UList.C.

References UList< T >::begin(), and UList< T >::end().

bool operator> ( const UList< T > &   a  ) const

Compare two ULists lexicographically. Takes linear time.

Definition at line 210 of file UList.C.

References UList< T >::operator.

bool operator<= ( const UList< T > &   a  ) const

Return true if !(a > b). Takes linear time.

Definition at line 217 of file UList.C.

References Foam::operator>().

bool operator>= ( const UList< T > &   a  ) const

Return true if !(a < b). Takes linear time.

Definition at line 224 of file UList.C.

References Foam::operator<().

const bool & operator[] ( const label   i  ) const [inline]

Reimplemented in speciesTable.

Definition at line 149 of file UListI.H.


Friends And Related Function Documentation

friend class SubList< T > [friend]

Declare friendship with the SubList class.

Definition at line 87 of file UList.H.

Ostream& operator ( Ostream &   ,
const UList< T > &    
) [friend]

Referenced by UList< T >::operator>().


The documentation for this class was generated from the following files:
  • src/OpenFOAM/containers/Lists/UList/UList.H
  • src/OpenFOAM/containers/Lists/UList/UList.C
  • src/OpenFOAM/containers/Lists/UList/UListI.H
  • src/OpenFOAM/containers/Lists/UList/UListIO.C