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...
Inherits UPtrList< T >.
Inherited by CloudFunctionObjectList< MomentumCloud< CloudType > >, DictionaryBase< PtrList< T >, T >, FieldField< Foam::Field, scalar >, FieldField< Foam::Field, Type >, FieldField< PatchField, Type >, FieldField< Foam::Field, LUType >, IOListBase< PtrList, IOPtrList, Type >, InjectionModelList< Foam::MomentumCloud< Foam::DSMCCloud > >, MeshZones< faceZone, polyMesh >, MeshZones< pointZone, polyMesh >, MeshZones< cellZone, polyMesh >, ParticleForceList< MomentumCloud< CloudType > >, ReactionList< Foam::sutherlandTransport >, blockMesh, fvBoundaryMesh, pointBoundaryMesh, and polyBoundaryMesh.
Public Member Functions | |
PtrList () | |
Null Constructor. More... | |
PtrList (const label) | |
Construct with size specified. More... | |
PtrList (const PtrList< T > &) | |
Copy constructor. More... | |
template<class CloneArg > | |
PtrList (const PtrList< T > &, const CloneArg &) | |
Copy constructor with additional argument for clone. More... | |
PtrList (PtrList< T > &&) | |
Move constructor. More... | |
PtrList (PtrList< T > &, bool reuse) | |
Construct as copy or re-use as specified. More... | |
PtrList (const SLPtrList< T > &) | |
Construct as copy of SLPtrList<T> More... | |
template<class INew > | |
PtrList (Istream &, const INew &) | |
Construct from Istream using given Istream constructor class. More... | |
PtrList (Istream &) | |
Construct from Istream using default Istream constructor class. More... | |
~PtrList () | |
Destructor. More... | |
void | setSize (const label) |
Reset size of PtrList. If extending the PtrList, new entries are. More... | |
void | resize (const label) |
Alias for setSize(const label) More... | |
void | clear () |
Clear the PtrList, i.e. set size to zero deleting all the. More... | |
void | append (T *) |
Append an element at the end of the list. More... | |
void | append (const autoPtr< T > &) |
void | append (const tmp< T > &) |
void | transfer (PtrList< T > &) |
Transfer the contents of the argument PtrList into this PtrList. More... | |
bool | set (const label) const |
Is element set. More... | |
autoPtr< T > | set (const label, T *) |
Set element to given T* and return old element (can be nullptr) More... | |
autoPtr< T > | set (const label, const autoPtr< T > &) |
Set element to given autoPtr<T> and return old element. More... | |
autoPtr< T > | set (const label, const tmp< T > &) |
Set element to given tmp<T> and return old element. More... | |
void | reorder (const labelUList &oldToNew) |
Reorders elements. Ordering does not have to be done in. More... | |
void | shuffle (const labelUList &newToOld) |
Reorders elements. Ordering does not have to be done in. More... | |
void | operator= (const PtrList< T > &) |
Assignment operator. More... | |
void | operator= (PtrList< T > &&) |
Move assignment operator. More... | |
Public Member Functions inherited from UPtrList< T > | |
UPtrList () | |
Null Constructor. More... | |
UPtrList (const label) | |
Construct with size specified. 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... | |
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 &oldToNew) |
Reorders elements. Ordering does not have to be done in. More... | |
void | shuffle (const labelUList &newToOld) |
Reorders elements. Ordering does not have to be done in. More... | |
template<class T2 > | |
UPtrList< T2 > | convert () |
Convert to list of different pointer type. More... | |
template<class T2 > | |
UPtrList< const T2 > | convert () const |
Convert to list of different pointer type. 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... | |
T * | operator() (const label) |
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... | |
template<class T2 > | |
Foam::UPtrList< T2 > | convert () |
template<class T2 > | |
Foam::UPtrList< const T2 > | convert () const |
Protected Member Functions | |
template<class INew > | |
void | read (Istream &, const INew &inewt) |
Read from Istream using given Istream constructor class. More... | |
Friends | |
Istream & | operator>> (Istream &, PtrList< T > &) |
Read PtrList from Istream, discarding contents of existing PtrList. More... | |
Additional Inherited Members | |
Public Types inherited from UPtrList< T > | |
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... | |
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.
Copy constructor.
Definition at line 46 of file PtrList.C.
References Foam::clone(), and forAll.
Copy constructor with additional argument for clone.
Definition at line 59 of file PtrList.C.
References Foam::clone(), and forAll.
Construct as copy or re-use as specified.
Definition at line 78 of file PtrList.C.
References Foam::clone(), and forAll.
Construct from Istream using given Istream constructor class.
Definition at line 160 of file PtrListIO.C.
References Foam::blockMeshTools::read().
Construct from Istream using default Istream constructor class.
Definition at line 167 of file PtrListIO.C.
References Foam::blockMeshTools::read().
Read from Istream using given Istream constructor class.
Definition at line 36 of file PtrListIO.C.
References IOstream::fatalCheck(), forAll, token::isLabel(), token::labelToken(), Istream::readBeginList(), s(), setSize(), and Foam::T().
Referenced by IOPtrList< Type >::IOPtrList().
void setSize | ( | const label | newSize | ) |
Reset size of PtrList. If extending the PtrList, new entries are.
set to nullptr. If truncating the PtrList, removed entries are deleted
Definition at line 131 of file PtrList.C.
References FatalErrorInFunction, Foam::name(), and Foam::T().
Referenced by fvMeshAdder::add(), cellTable::addCellZones(), surfaceZonesInfo::addCellZonesToMesh(), surfaceZonesInfo::addFaceZonesToMesh(), fvConstraints::fvConstraints(), fvModels::fvModels(), lduPrimitiveMesh::gather(), interRegionExplicitPorositySource::interRegionExplicitPorositySource(), polyMesh::polyMesh(), powerLawLopesdaCostaZone::powerLawLopesdaCostaZone(), PtrListDictionary< T >::PtrListDictionary(), functionObjectList::read(), polyMesh::readUpdate(), polyMesh::removeBoundary(), pointBoundaryMesh::reset(), searchableSurfaces::searchableSurfaces(), addPatchCellLayer::setRefinement(), duplicatePoints::setRefinement(), subCycleFields< GeometricField >::subCycleFields(), OFstreamCollator::write(), cellZoneSet::writeObject(), faceZoneSet::writeObject(), and pointZoneSet::writeObject().
|
inline |
Alias for setSize(const label)
Definition at line 32 of file PtrListI.H.
References setSize().
Referenced by polyTopoChange::addMesh(), sampledSurfaces::sampleType(), and patchInjectionBase::topoChange().
void clear |
Clear the PtrList, i.e. set size to zero deleting all the.
allocated entries
Definition at line 174 of file PtrList.C.
Referenced by Relaxation< CloudType >::cacheFields(), Explicit< CloudType >::cacheFields(), functionObjectList::clear(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::operator=(), GeometricField< Type, PatchField, GeoMesh >::operator==(), functionObjectList::read(), polyMesh::removeBoundary(), sampledSurfaces::sampleType(), and decompositionMethod::setConstraints().
|
inline |
Append an element at the end of the list.
Definition at line 39 of file PtrListI.H.
References setSize().
Referenced by singleProcessorFaceSetsConstraint::add(), phaseSystem::generateInterfacialModels(), rigidBodyMeshMotion::rigidBodyMeshMotion(), rigidBodyMeshMotionSolver::rigidBodyMeshMotionSolver(), and domainDecomposition::writeProcs().
Definition at line 48 of file PtrListI.H.
Definition at line 55 of file PtrListI.H.
Transfer the contents of the argument PtrList into this PtrList.
and annul the argument list
Definition at line 189 of file PtrList.C.
References clear().
Referenced by massFractions::execute(), functionObjectList::read(), fieldAverage::read(), and IATE::read().
|
inline |
Is element set.
Definition at line 65 of file PtrListI.H.
Referenced by fvMeshAdder::add(), cellTable::addCellZones(), surfaceZonesInfo::addCellZonesToMesh(), surfaceZonesInfo::addFaceZonesToMesh(), Foam::addField(), BlendedInterfacialModel< ModelType >::BlendedInterfacialModel(), repatchMesh::changePatchType(), phaseSystem::correctContinuityError(), phaseSystem::correctPhi(), MomentumTransferPhaseSystem< BasePhaseSystem >::ddtCorrs(), repatchMesh::deletePatch(), MomentumTransferPhaseSystem< BasePhaseSystem >::dragCorrs(), massFractions::execute(), GAMGSolver::GAMGSolver(), lduPrimitiveMesh::gather(), phaseSystem::generateInterfacialModels(), surfaceZonesInfo::getAllClosedNamedSurfaces(), surfaceZonesInfo::getClosedNamedSurfaces(), surfaceZonesInfo::getInsidePointNamedSurfaces(), surfaceZonesInfo::getNamedSurfaces(), surfaceZonesInfo::getUnclosedNamedSurfaces(), GAMGProcAgglomeration::globalCellCells(), InjectionModel< CloudType >::inject(), InjectionModel< CloudType >::injectSteadyState(), singleCellFvMesh::interpolate(), fvMeshSubset::interpolate(), interRegionExplicitPorositySource::interRegionExplicitPorositySource(), Foam::MULES::limitSum(), LUscalarMatrix::LUscalarMatrix(), MeshZones< faceZone, polyMesh >::MeshZones(), MomentumTransferPhaseSystem< BasePhaseSystem >::momentumTransferf(), FieldField< Field, Type >::NewCalculatedType(), MeshZones< faceZone, polyMesh >::operator[](), MomentumTransferPhaseSystem< BasePhaseSystem >::partialElimination(), MomentumTransferPhaseSystem< BasePhaseSystem >::partialEliminationf(), pointBoundaryMesh::pointBoundaryMesh(), polyMesh::polyMesh(), powerLawLopesdaCostaZone::powerLawLopesdaCostaZone(), compressibleMultiphaseVoF::pressureCorrector(), functionObjectList::read(), repatchMesh::read(), Maxwell< BasicMomentumTransportModel >::readModeCoefficients(), ensightParts::recalculate(), refinementSurfaces::refinementSurfaces(), refinementFeatures::regionEdgeTrees(), polyBoundaryMesh::renamePatches(), polyBoundaryMesh::reorderPatches(), pointBoundaryMesh::reset(), LduMatrix< Type, DType, LUType >::residual(), lduMatrix::residual(), sampledSets::sampleLocalType(), sampledSurfaces::sampleLocalType(), sampledSets::sampleType(), sampledSurfaces::sampleType(), PtrListDictionary< T >::set(), InjectionModel< CloudType >::setNumberOfParticles(), SidedInterfacialModel< blendedDiffusiveMassTransferModel >::SidedInterfacialModel(), SidedInterfacialModel< ModelType >::SidedInterfacialModel(), TGaussSeidelSmoother< Type, DType, LUType >::smooth(), phaseSystem::solve(), meshToMesh::srcPatchStabilisation(), fvMeshToFvMesh::srcToTgt(), subCycleFields< GeometricField >::subCycleFields(), meshToMesh::tgtPatchStabilisation(), Foam::blendedInterfacialModel::valid(), populationBalanceSizeDistribution::write(), OFstreamCollator::write(), domainDecomposition::writeComplete(), cellZoneSet::writeObject(), faceZoneSet::writeObject(), and pointZoneSet::writeObject().
|
inline |
Set element to given T* and return old element (can be nullptr)
Definition at line 72 of file PtrListI.H.
|
inline |
Set element to given autoPtr<T> and return old element.
Definition at line 81 of file PtrListI.H.
|
inline |
Set element to given tmp<T> and return old element.
Definition at line 92 of file PtrListI.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 197 of file PtrList.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::name(), Foam::nl, UList< T >::size(), and Foam::T().
Referenced by polyBoundaryMesh::reorderPatches().
void shuffle | ( | const labelUList & | newToOld | ) |
Reorders elements. Ordering does not have to be done in.
ascending or descending order. Reordering has to be unique. Note: can create unset elements
Definition at line 248 of file PtrList.C.
References clear(), forAll, UList< T >::size(), and Foam::T().
Referenced by polyBoundaryMesh::reorderPatches(), fvBoundaryMesh::shuffle(), and pointBoundaryMesh::shuffle().
Assignment operator.
Definition at line 274 of file PtrList.C.
References Foam::abort(), Foam::clone(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::name(), setSize(), UPtrList< T >::size(), and Foam::T().
Move assignment operator.
Definition at line 310 of file PtrList.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Foam::name(), and Foam::T().