A templated 1D list of pointers to objects of type <T>, where the size of the array is known and used for subscript bounds checking, etc. More...
Inherited by PtrList< T >, PtrList< blockEdge >, PtrList< blockFace >, PtrList< blockVertex >, PtrList< bodyMesh >, PtrList< cellZone >, PtrList< CloudFunctionObject< CloudType > >, PtrList< CloudFunctionObject< KinematicCloud< Cloud< basicKinematicCollidingParcel > > > >, PtrList< CloudFunctionObject< KinematicCloud< CloudType > > >, PtrList< CloudFunctionObject< KinematicCloud< Foam::DSMCCloud > > >, PtrList< coalCloud >, PtrList< const Foam::lduInterface >, PtrList< coordinateSystem >, PtrList< engineValve >, PtrList< entry >, PtrList< extendedFeatureEdgeMesh >, PtrList< faceZone >, PtrList< Field< Type > >, PtrList< Foam::AMIInterpolation >, PtrList< Foam::boundaryPatch >, PtrList< Foam::cellModel >, PtrList< Foam::cellSizeAndAlignmentControl >, PtrList< Foam::cellSizeFunction >, PtrList< Foam::coordinateSystem >, PtrList< Foam::coordSet >, PtrList< Foam::coupledFacePair >, PtrList< Foam::decompositionConstraint >, PtrList< Foam::decompositionMethod >, PtrList< Foam::diameterModels::IATEsource >, PtrList< Foam::dictionary >, PtrList< Foam::dimensioned >, PtrList< Foam::DimensionedField >, PtrList< Foam::ensightPart >, PtrList< Foam::extendedFeatureEdgeMesh >, PtrList< Foam::Field >, PtrList< Foam::Field< LUType > >, PtrList< Foam::Field< scalar > >, PtrList< Foam::FieldField< Foam::Field, scalar > >, PtrList< Foam::fvMesh >, PtrList< Foam::ignitionSite >, PtrList< Foam::indexedOctree >, PtrList< Foam::indexedOctree< Foam::treeDataEdge > >, PtrList< Foam::indexedOctree< Foam::treeDataPoint > >, PtrList< Foam::interpolation< Foam::Vector > >, PtrList< Foam::interpolation< scalar > >, PtrList< Foam::IOList >, PtrList< Foam::lduMatrix >, PtrList< Foam::lduPrimitiveMesh >, PtrList< Foam::liquidProperties >, PtrList< Foam::List >, PtrList< Foam::mappedPatchBase >, PtrList< Foam::motionSolver >, PtrList< Foam::OFstream >, PtrList< Foam::PatchInteractionModel< Foam::DSMCCloud > >, PtrList< Foam::pointMesh >, PtrList< Foam::PrimitivePatch >, PtrList< Foam::procLduInterface >, PtrList< Foam::PtrList< Foam::AMIInterpolation > >, PtrList< Foam::PtrList< Foam::lduInterfaceField > >, PtrList< Foam::radiation::radiativeIntensityRay >, PtrList< Foam::RBD::joint >, PtrList< Foam::RBD::restraint >, PtrList< Foam::RBD::rigidBody >, PtrList< Foam::RBD::subBody >, PtrList< Foam::Reaction< SolidThermo > >, PtrList< Foam::Reaction< ThermoType > >, PtrList< Foam::sixDoFRigidBodyMotionConstraint >, PtrList< Foam::sixDoFRigidBodyMotionRestraint >, PtrList< Foam::solidBodyMotionFunction >, PtrList< Foam::solidProperties >, PtrList< Foam::surfaceZonesInfo >, PtrList< Foam::Time >, PtrList< Foam::UPtrList >, PtrList< Foam::waveModel >, PtrList< force >, PtrList< functionObject >, PtrList< fvPatchMapper >, PtrList< GasThermo >, PtrList< injectionModel >, PtrList< InjectionModel< CloudType > >, PtrList< InjectionModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > > >, PtrList< InjectionModel< Foam::KinematicCloud< CloudType > > >, PtrList< InjectionModel< Foam::KinematicCloud< Foam::DSMCCloud > > >, PtrList< joint >, PtrList< MRFZone >, PtrList< option >, PtrList< pairPotential >, PtrList< ParticleForce< CloudType > >, PtrList< ParticleForce< KinematicCloud< Cloud< basicKinematicCollidingParcel > > > >, PtrList< ParticleForce< KinematicCloud< CloudType > > >, PtrList< ParticleForce< KinematicCloud< Foam::DSMCCloud > > >, PtrList< PatchField< Type > >, PtrList< phaseModel >, PtrList< pointPatchMapper >, PtrList< pointZone >, PtrList< polyMeshModifier >, PtrList< porosityModel >, PtrList< profileModel >, PtrList< pyrolysisModel >, PtrList< Reaction< ThermoType > >, PtrList< regionModelFunctionObject >, PtrList< sampledSet >, PtrList< sampledSurface >, PtrList< searchableSurface >, PtrList< SolidThermo >, PtrList< tetherPotential >, PtrList< ThermoType >, PtrList< transferModel >, and PtrList< ZoneType >.
Classes | |
class | const_iterator |
An STL-conforming const_iterator. More... | |
class | iterator |
An STL iterator. More... | |
Public Types | |
typedef T | value_type |
Type of values the UPtrList contains. More... | |
typedef T & | reference |
Type that can be used for storing into UPtrList::value_type objects. More... | |
typedef const T & | const_reference |
Type that can be used for storing into constant UPtrList::value_type. More... | |
Public Member Functions | |
UPtrList () | |
Null Constructor. More... | |
UPtrList (const label) | |
Construct with size specified. More... | |
UPtrList (const Xfer< UPtrList< T >> &) | |
Construct by transferring the parameter contents. More... | |
UPtrList (UPtrList< T > &, bool reuse) | |
Construct as copy or re-use as specified. More... | |
label | size () const |
Return the number of elements in the UPtrList. More... | |
bool | empty () const |
Return true if the UPtrList is empty (ie, size() is zero) More... | |
T & | first () |
Return reference to the first element of the list. More... | |
const T & | first () const |
Return reference to first element of the list. More... | |
T & | last () |
Return reference to the last element of the list. More... | |
const T & | last () const |
Return reference to the last element of the list. More... | |
void | setSize (const label) |
Reset size of UPtrList. This can only be used to set the size. More... | |
void | resize (const label) |
Reset size of UPtrList. This can only be used to set the size. More... | |
void | clear () |
Clear the UPtrList, i.e. set size to zero. More... | |
void | transfer (UPtrList< T > &) |
Transfer the contents of the argument UPtrList into this. More... | |
Xfer< UPtrList< T > > | xfer () |
Transfer contents to the Xfer container. More... | |
bool | set (const label) const |
Is element set. More... | |
T * | set (const label, T *) |
Set element. Return old element (can be nullptr). More... | |
void | reorder (const labelUList &) |
Reorders elements. Ordering does not have to be done in. More... | |
const T & | operator[] (const label) const |
Return element const reference. More... | |
T & | operator[] (const label) |
Return element reference. More... | |
const T * | operator() (const label) const |
Return element const pointer. More... | |
iterator | begin () |
Return an iterator to begin traversing the UPtrList. More... | |
iterator | end () |
Return an iterator to end traversing the UPtrList. More... | |
const_iterator | cbegin () const |
Return an const_iterator to begin traversing the UPtrList. More... | |
const_iterator | cend () const |
Return an const_iterator to end traversing the UPtrList. More... | |
const_iterator | begin () const |
Return an const_iterator to begin traversing the UPtrList. More... | |
const_iterator | end () const |
Return an const_iterator to end traversing the UPtrList. More... | |
Friends | |
class | PtrList< T > |
Declare friendship with the UPtrList class. More... | |
class | iterator |
Ostream & | operator (Ostream &, const UPtrList< T > &) |
Write UPtrList to Ostream. More... | |
A templated 1D list of pointers to objects of type <T>, where the size of the array is known and used for subscript bounds checking, etc.
The element operator [] returns a reference to the object rather than a pointer. Storage is not allocated during construction or use but is supplied to the constructor as an argument.
Definition at line 54 of file UPtrList.H.
typedef T value_type |
Type of values the UPtrList contains.
Definition at line 227 of file UPtrList.H.
Type that can be used for storing into UPtrList::value_type objects.
Definition at line 230 of file UPtrList.H.
typedef const T& const_reference |
Type that can be used for storing into constant UPtrList::value_type.
objects
Definition at line 234 of file UPtrList.H.
UPtrList | ( | ) |
Null Constructor.
Definition at line 31 of file UPtrList.C.
Construct with size specified.
Definition at line 38 of file UPtrList.C.
Construct by transferring the parameter contents.
Definition at line 45 of file UPtrList.C.
Construct as copy or re-use as specified.
Definition at line 52 of file UPtrList.C.
|
inline |
Return the number of elements in the UPtrList.
Definition at line 29 of file UPtrListI.H.
Referenced by MRFZoneList::absolute(), MRFZoneList::active(), porosityModelList::active(), singleProcessorFaceSetsConstraint::add(), fvMeshAdder::add(), polyMeshAdder::add(), surfaceZonesInfo::addCellZonesToMesh(), surfaceZonesInfo::addFaceZonesToMesh(), snappyLayerDriver::addLayers(), fvMeshTools::addPatch(), meshRefinement::addPatch(), GAMGAgglomeration::agglomerateLduAddressing(), extendedEdgeMesh::allNearestFeatureEdges(), meshRefinement::appendPatch(), attachPolyTopoChanger::attach(), Foam::average(), addPatchCellLayer::calcSidePatch(), polyTopoChange::changeMesh(), repatchPolyTopoChanger::changePatchID(), searchableSurfaces::checkClosed(), polyBoundaryMesh::checkDefinition(), polyBoundaryMesh::checkParallelSync(), searchableSurfaces::checkSizes(), profileModelList::connectBlades(), inverseFaceDistanceDiffusivity::correct(), nearWallDistNoSearch::correct(), nearWallDist::correct(), pointPatchDist::correct(), wallDistData< TransferType >::correct(), motionSmootherAlgo::curPoints(), structuredDecomp::decompose(), decompositionMethod::decompose(), displacementInterpolationMotionSolver::displacementInterpolationMotionSolver(), fvMeshDistribute::distribute(), snappyLayerDriver::doLayers(), Foam::facePointN(), coordinateSystems::findIndices(), polyBoundaryMesh::findPatchIDs(), fvFieldReconstructor::fvFieldReconstructor(), GAMGSolver::GAMGSolver(), lduPrimitiveMesh::gather(), Foam::gAverage(), surfaceZonesInfo::getAllClosedNamedSurfaces(), surfaceZonesInfo::getClosedNamedSurfaces(), surfaceZonesInfo::getInsidePointNamedSurfaces(), surfaceZonesInfo::getNamedSurfaces(), cellDistFuncs::getPatchIDs(), surfaceZonesInfo::getUnclosedNamedSurfaces(), surfaceZonesInfo::getUnnamedSurfaces(), GAMGProcAgglomeration::globalCellCells(), hexRef8Data::hexRef8Data(), injectionModelList::info(), transferModelList::info(), interRegionExplicitPorositySource::initialise(), lduMatrix::initMatrixInterfaces(), fvBoundaryMesh::interfaces(), GeometricField< Type, PatchField, GeoMesh >::Boundary::interfaces(), meshToMesh::interpolationMethodAMI(), regionModel::interRegionAMI(), rigidBodyModel::join(), layerParameters::layerParameters(), lduPrimitiveMesh::lduPrimitiveMesh(), Foam::MULES::limitSum(), LUscalarMatrix::LUscalarMatrix(), meshRefinement::makeDisplacementField(), polyTopoChange::makeMesh(), meshToMesh::mapSrcToTgt(), meshToMesh::mapTgtToSrc(), fvMeshAdder::MapVolFields(), Foam::max(), MeshedSurface< Foam::face >::MeshedSurface(), meshTriangulation::meshTriangulation(), Foam::min(), polyTopoChanger::names(), ZoneMesh< cellZone, polyMesh >::names(), polyBoundaryMesh::names(), regionModel::nbrCoupledPatchID(), extendedEdgeMesh::nearestFeatureEdgeByType(), FieldField< Foam::Field, LUType >::NewCalculatedType(), nonBlockingGaussSeidelSmoother::nonBlockingGaussSeidelSmoother(), lduPrimitiveMesh::nonBlockingSchedule(), potential::nPairPotentials(), blockMesh::numZonedBlocks(), procLess::operator()(), listPlusEqOp< T >::operator()(), Foam::operator<<(), PtrList< transferModel >::operator=(), blockMesh::patchDicts(), patchInjection::patchInjection(), patchDistMethod::patchTypes(), polyBoundaryMesh::physicalTypes(), pointFieldReconstructor::pointFieldReconstructor(), polyBoundaryMesh::polyBoundaryMesh(), polyMesh::polyMesh(), Foam::polyMeshZipUpCells(), polyTopoChange::polyTopoChange(), fvMeshDistribute::printCoupleInfo(), fvMeshDistribute::printMeshInfo(), thermalBaffleModel::read(), boundaryMesh::read(), polyMesh::readUpdate(), ensightParts::recalculate(), pointFieldReconstructor::reconstructField(), refinementHistory::refinementHistory(), refinementFeatures::regionEdgeTrees(), MRFZoneList::relative(), SloanRenumber::renumber(), structuredRenumber::renumber(), lduMatrix::residual(), GeometricField< Type, PatchField, GeoMesh >::Boundary::scalarInterfaces(), fvMeshSubset::setCellSubset(), polyBoundaryMesh::setGroup(), fvMeshSubset::setLargeCellSubset(), removeCells::setRefinement(), meshCutAndRemove::setRefinement(), singleCellFvMesh::singleCellFvMesh(), ensightParts::size(), pairPatchAgglomeration::size(), GAMGAgglomeration::size(), Foam::sum(), Foam::sumMag(), surfacePatchIOList::surfacePatchIOList(), surfZoneIOList::surfZoneIOList(), ParticleStressModel::tau(), coordinateSystems::toc(), polyTopoChanger::types(), ZoneMesh< cellZone, polyMesh >::types(), polyBoundaryMesh::types(), GeometricField< Type, PatchField, GeoMesh >::Boundary::types(), lduMatrix::updateMatrixInterfaces(), valveBank::valveBank(), Foam::vertices(), wallLayerCells::wallLayerCells(), WallLocalSpringSliderDashpot< CloudType >::WallLocalSpringSliderDashpot(), xmgraceSetWriter< Type >::write(), vtkSetWriter< Type >::write(), gnuplotSetWriter< Type >::write(), coordinateSystems::writeData(), polyBoundaryMesh::writeData(), cellZoneSet::writeObject(), pointZoneSet::writeObject(), faceZoneSet::writeObject(), searchableSurfaces::writeStats(), fvMeshTools::zeroPatchFields(), ZoneMesh< cellZone, polyMesh >::ZoneMesh(), and meshRefinement::zonify().
|
inline |
Return true if the UPtrList is empty (ie, size() is zero)
Definition at line 36 of file UPtrListI.H.
Referenced by NamedEnum< directionType, 3 >::names(), and fvMeshTools::zeroPatchFields().
|
inline |
Return reference to the first element of the list.
Definition at line 43 of file UPtrListI.H.
Referenced by functionObjectList::readFunctionObject().
|
inline |
Return reference to first element of the list.
Definition at line 50 of file UPtrListI.H.
|
inline |
Return reference to the last element of the list.
Definition at line 57 of file UPtrListI.H.
Referenced by composite::jcalc().
|
inline |
Return reference to the last element of the list.
Definition at line 64 of file UPtrListI.H.
void setSize | ( | const label | newSize | ) |
|
inline |
void clear | ( | ) |
Clear the UPtrList, i.e. set size to zero.
Definition at line 87 of file UPtrList.C.
Transfer the contents of the argument UPtrList into this.
UPtrList and annul the argument list
Definition at line 94 of file UPtrList.C.
Referenced by wallDistData< TransferType >::correct(), and meshWave::correct().
|
inline |
Transfer contents to the Xfer container.
Definition at line 94 of file UPtrListI.H.
|
inline |
Is element set.
Definition at line 78 of file UPtrListI.H.
Referenced by GAMGAgglomeration::agglomerateLduAddressing(), GAMGAgglomeration::combineLevels(), GAMGSolver::GAMGSolver(), lduPrimitiveMesh::gather(), GAMGProcAgglomeration::globalCellCells(), lduMatrix::initMatrixInterfaces(), fvBoundaryMesh::interfaces(), lduPrimitiveMesh::lduPrimitiveMesh(), LUscalarMatrix::LUscalarMatrix(), nonBlockingGaussSeidelSmoother::nonBlockingGaussSeidelSmoother(), lduPrimitiveMesh::nonBlockingSchedule(), Foam::operator<<(), procLduMatrix::procLduMatrix(), lduMatrix::residual(), GeometricField< Type, PatchField, GeoMesh >::Boundary::scalarInterfaces(), symGaussSeidelSmoother::smooth(), GaussSeidelSmoother::smooth(), nonBlockingGaussSeidelSmoother::smooth(), lduMatrix::sumA(), and lduMatrix::updateMatrixInterfaces().
Set element. Return old element (can be nullptr).
No checks on new element
Definition at line 85 of file UPtrListI.H.
void reorder | ( | const labelUList & | oldToNew | ) |
Reorders elements. Ordering does not have to be done in.
ascending or descending order. Reordering has to be unique. (is shuffle)
Definition at line 101 of file UPtrList.C.
Return element const reference.
Definition at line 103 of file UPtrListI.H.
Referenced by MRFZoneList::active(), porosityModelList::active(), MRFZoneList::addAcceleration(), porosityModelList::addResistance(), functionObjectList::adjustTimeStep(), GeometricField< Type, PatchField, GeoMesh >::Boundary::boundaryInternalField(), profileModelList::connectBlades(), optionList::constrain(), forceList::correct(), transferModelList::correct(), injectionModelList::correct(), optionList::correct(), MRFZoneList::correctBoundaryVelocity(), MRFZoneList::DDt(), functionObjectList::end(), GeometricField< Type, PatchField, GeoMesh >::Boundary::evaluate(), coalCloudList::evolve(), pyrolysisModelCollection::evolve(), pyrolysisModelCollection::evolveRegion(), functionObjectList::execute(), pointBoundaryMesh::findIndices(), coalCloudList::hsTrans(), pyrolysisModelCollection::info(), injectionModelList::info(), transferModelList::info(), MRFZoneList::makeAbsolute(), MRFZoneList::makeRelative(), pyrolysisModelCollection::maxDiff(), pointBoundaryMesh::movePoints(), functionObjectList::movePoints(), GeometricField< Type, PatchField, GeoMesh >::Boundary::operator=(), GeometricField< Type, PatchField, GeoMesh >::Boundary::operator==(), regionModelFunctionObjectList::postEvolveRegion(), pyrolysisModelCollection::preEvolveRegion(), regionModelFunctionObjectList::preEvolveRegion(), porosityModelList::read(), MRFZoneList::read(), refinementFeatures::regionEdgeTrees(), MRFZoneList::relative(), coalCloudList::rhoTrans(), coalCloudList::Sh(), pyrolysisModelCollection::solidRegionDiffNo(), coalCloudList::Srho(), coalCloudList::SU(), coalCloudList::SYi(), coordinateSystems::toc(), GeometricField< Type, PatchField, GeoMesh >::Boundary::updateCoeffs(), pointBoundaryMesh::updateMesh(), functionObjectList::updateMesh(), coalCloudList::UTrans(), porosityModelList::writeData(), coordinateSystems::writeData(), MRFZoneList::writeData(), optionList::writeData(), and GeometricField< Type, PatchField, GeoMesh >::Boundary::writeEntry().
Return element reference.
Definition at line 119 of file UPtrListI.H.
Return element const pointer.
Definition at line 135 of file UPtrListI.H.
|
inline |
Return an iterator to begin traversing the UPtrList.
Definition at line 289 of file UPtrListI.H.
Referenced by LUscalarMatrix::LUscalarMatrix().
|
inline |
Return an iterator to end traversing the UPtrList.
Definition at line 296 of file UPtrListI.H.
Referenced by searchableSurfaces::checkIntersection(), and searchableSurfaces::regionNames().
|
inline |
Return an const_iterator to begin traversing the UPtrList.
Definition at line 511 of file UPtrListI.H.
|
inline |
Return an const_iterator to end traversing the UPtrList.
Definition at line 519 of file UPtrListI.H.
|
inline |
Return an const_iterator to begin traversing the UPtrList.
Definition at line 495 of file UPtrListI.H.
|
inline |
Return an const_iterator to end traversing the UPtrList.
Definition at line 503 of file UPtrListI.H.
Declare friendship with the UPtrList class.
Definition at line 136 of file UPtrList.H.
|
friend |
Definition at line 240 of file UPtrList.H.
Referenced by fvBoundaryMesh::mesh(), polyBoundaryMesh::mesh(), optionList::operator()(), reactingMixture< ThermoType >::operator[](), fvBoundaryMesh::operator[](), polyBoundaryMesh::operator[](), searchableSurfaces::operator[](), fvBoundaryMesh::readUpdate(), polyBoundaryMesh::writeObject(), and searchableSurfaces::writeStats().