OpenFOAM logo
Open Source CFD Toolkit

UList.H File Reference


Detailed Description

View UList.H
License
This file is part of OpenFOAM.

OpenFOAM is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version.

OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.

You should have received a copy of the GNU General Public License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Description
UList<T> is a 1D vector of objects of type T, where the size of
the vector is known and 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 in file UList.H.

Go to the source code of this file.

Namespaces

namespace  Foam

Classes

class  UList

Defines

#define restrict
#define forAll(list, i)   for (Foam::label i=0; i<(list).size(); i++)
#define forAllReverse(list, i)   for (Foam::label i=(list).size()-1; i>=0; i--)
#define forAllIter(Container, container, iter)
#define forAllConstIter(Container, container, iter)

Functions

template<class T>
Ostream & operator<< (Ostream &, const UList< T > &)
bool writeBinary (const bool *)
bool writeBinary (const char *)
bool writeBinary (const short *)
bool writeBinary (const int *)
bool writeBinary (const long *)
bool writeBinary (const float *)
bool writeBinary (const double *)
bool writeBinary (const long double *)
template<class T>
bool writeBinary (const T *)
template<class T>
void reverse (UList< T > &ul, const label n)
template<class T>
void reverse (UList< T > &ul)


Define Documentation

#define forAll list,
 )     for (Foam::label i=0; i<(list).size(); i++)
 

Definition at line 352 of file UList.H.

Referenced by cellShape::clone(), cellShape::collapsedFaces(), StaticHashTable::end(), face::face(), forAll(), fvBoundaryMeshMapper::fvBoundaryMeshMapper(), fvMeshLduAddressing::fvMeshLduAddressing(), HashSet< label, Hash< label > >::HashSet(), if(), StaticHashTable::Iterator::key(), lduAddressingFaMesh::lduAddressingFaMesh(), cellShape::meshEdges(), cellShape::meshFaces(), cellModel::modelFaces(), cellModel::nFaces(), IndirectList::operator[](), fvMeshSubset::patchFieldSubset::patchFieldSubset(), IndirectList::resetAddressing(), and tetPolyBoundaryMapperFaceDecomp::tetPolyBoundaryMapperFaceDecomp().

#define forAllConstIter Container,
container,
iter   ) 
 

Value:

for                                                                        \
    (                                                                          \
        Container::const_iterator iter = (container).begin();                  \
        iter != (container).end();                                             \
        ++iter                                                                 \
    )

Definition at line 372 of file UList.H.

#define forAllIter Container,
container,
iter   ) 
 

Value:

for                                                                        \
    (                                                                          \
        Container::iterator iter = (container).begin();                        \
        iter != (container).end();                                             \
        ++iter                                                                 \
    )

Definition at line 364 of file UList.H.

#define forAllReverse list,
 )     for (Foam::label i=(list).size()-1; i>=0; i--)
 

Definition at line 353 of file UList.H.

#define restrict
 

Definition at line 56 of file UList.H.


Function Documentation

Ostream& operator<< Ostream &  ,
const UList< T > & 
 

void reverse UList< T > &  ul  )  [inline]
 

Definition at line 249 of file UListI.H.

void reverse UList< T > &  ul,
const label  n
[inline]
 

Definition at line 240 of file UListI.H.

bool writeBinary const T *   )  [inline]
 

Definition at line 322 of file UList.H.

bool writeBinary const long double *   )  [inline]
 

Definition at line 318 of file UList.H.

bool writeBinary const double *   )  [inline]
 

Definition at line 317 of file UList.H.

bool writeBinary const float *   )  [inline]
 

Definition at line 316 of file UList.H.

bool writeBinary const long *   )  [inline]
 

Definition at line 315 of file UList.H.

bool writeBinary const int *   )  [inline]
 

Definition at line 314 of file UList.H.

bool writeBinary const short *   )  [inline]
 

Definition at line 313 of file UList.H.

bool writeBinary const char *   )  [inline]
 

Definition at line 312 of file UList.H.

bool writeBinary const bool *   )  [inline]
 

Definition at line 311 of file UList.H.

For further information go to www.openfoam.org