A 1D vector of objects of type <T> that resizes itself as necessary to accept the new objects. More...

Inheritance diagram for DynamicList:

[legend]

Public Member Functions
	DynamicList ()
	Construct null. More...

	DynamicList (const label)
	Construct given size. More...

	DynamicList (const DynamicList< T, SizeInc, SizeMult, SizeDiv > &)
	Construct copy. More...

	DynamicList (const UList< T > &)
	Construct from UList. Size set to UList size. More...

	DynamicList (const UIndirectList< T > &)
	Construct from UIndirectList. Size set to UIndirectList size. More...

	DynamicList (const Xfer< List< T > > &)
	Construct by transferring the parameter contents. More...

	DynamicList (Istream &)
	Construct from Istream. Size set to size of list read. More...

label	capacity () const
	Size of the underlying storage. More...

void	setCapacity (const label)
	Alter the size of the underlying storage. More...

void	setSize (const label)
	Alter the addressed list size. More...

void	setSize (const label, const T &)
	Alter the addressed list size and fill new space with a. More...

void	resize (const label)
	Alter the addressed list size. More...

void	resize (const label, const T &)
	Alter the addressed list size and fill new space with a. More...

void	reserve (const label)
	Reserve allocation space for at least this size. More...

void	clear ()
	Clear the addressed list, i.e. set the size to zero. More...

void	clearStorage ()
	Clear the list and delete storage. More...

DynamicList< T, SizeInc, SizeMult, SizeDiv > &	shrink ()
	Shrink the allocated space to the number of elements used. More...

void	transfer (List< T > &)
	Transfer contents of the argument List into this. More...

void	transfer (DynamicList< T, SizeInc, SizeMult, SizeDiv > &)
	Transfer contents of the argument DynamicList into this. More...

Xfer< List< T > >	xfer ()
	Transfer contents to the Xfer container as a plain List. More...

DynamicList< T, SizeInc, SizeMult, SizeDiv > &	append (const T &)
	Append an element at the end of the list. More...

DynamicList< T, SizeInc, SizeMult, SizeDiv > &	append (const UList< T > &)
	Append a List at the end of this list. More...

DynamicList< T, SizeInc, SizeMult, SizeDiv > &	append (const UIndirectList< T > &)
	Append a UIndirectList at the end of this list. More...

T	remove ()
	Remove and return the top element. More...

T &	operator() (const label)
	Return non-const access to an element, resizing list if. More...

void	operator= (const T &)
	Assignment of all addressed entries to the given value. More...

void	operator= (const DynamicList< T, SizeInc, SizeMult, SizeDiv > &)
	Assignment from DynamicList. More...

void	operator= (const UList< T > &)
	Assignment from UList. More...

void	operator= (const UIndirectList< T > &)
	Assignment from UIndirectList. More...

Private Member Functions
	StaticAssert ((SizeInc\|\|SizeMult) &&SizeDiv)
	Avoid invalid sizing parameters. More...

Private Attributes
label	capacity_
	The capacity (allocated size) of the underlying list. More...

Friends
class	List< T >
	Declare friendship with the List class. More...

Ostream &	operator (Ostream &, const DynamicList< T, SizeInc, SizeMult, SizeDiv > &)

Istream &	operator>> (Istream &, DynamicList< T, SizeInc, SizeMult, SizeDiv > &)
	Read from Istream, discarding contents of existing DynamicList. More...

Detailed Description

A 1D vector of objects of type <T> that resizes itself as necessary to accept the new objects.

Internal storage is a compact array and the list can be shrunk to compact storage. The increase of list size is controlled by three template parameters, which allows the list storage to either increase by the given increment or by the given multiplier and divider (allowing non-integer multiples).

Source files

Definition at line 56 of file DynamicList.H.

Constructor & Destructor Documentation

◆ DynamicList() [1/7]

DynamicList ( )

inline

Construct null.

Definition at line 29 of file DynamicListI.H.

◆ DynamicList() [2/7]

DynamicList ( const label )

inlineexplicit

Construct given size.

◆ DynamicList() [3/7]

DynamicList ( const DynamicList< T, SizeInc, SizeMult, SizeDiv > & )

inline

Construct copy.

◆ DynamicList() [4/7]

DynamicList ( const UList< T > & )

inlineexplicit

Construct from UList. Size set to UList size.

Also constructs from DynamicList with different sizing parameters.

◆ DynamicList() [5/7]

DynamicList ( const UIndirectList< T > & )

inlineexplicit

Construct from UIndirectList. Size set to UIndirectList size.

◆ DynamicList() [6/7]

DynamicList ( const Xfer< List< T > > & )

inlineexplicit

Construct by transferring the parameter contents.

◆ DynamicList() [7/7]

DynamicList ( Istream & )

explicit

Construct from Istream. Size set to size of list read.

Member Function Documentation

◆ StaticAssert()

StaticAssert ( (SizeInc||SizeMult) && SizeDiv )

private

Avoid invalid sizing parameters.

◆ capacity()

Foam::label capacity ( ) const

inline

Size of the underlying storage.

Definition at line 100 of file DynamicListI.H.

Referenced by primitiveMesh::cellEdges(), primitiveMesh::cellPoints(), extendedEdgeMesh::cut(), primitiveMesh::faceEdges(), main(), primitiveMesh::pointPoints(), and printInfo().

Here is the caller graph for this function:

◆ setCapacity()

void setCapacity ( const label nElem )

inline

Alter the size of the underlying storage.

The addressed size will be truncated if needed to fit, but will remain otherwise untouched. Use this or reserve() in combination with append().

Definition at line 109 of file DynamicListI.H.

Referenced by polyDualMesh::calcDual(), patchSeedSet::calcSamples(), primitiveMesh::cellEdges(), primitiveMesh::cellPoints(), polyDualMesh::collectPatchSideFace(), hexRef8::consistentSlowRefinement(), extendedEdgeMesh::cut(), autoSnapDriver::detectWarpedFaces(), primitiveMesh::faceEdges(), fileMonitorWatcher::fileMonitorWatcher(), polyBoundaryMesh::findIndices(), main(), polyMeshAdder::mergeCellZones(), polyMeshAdder::mergeFaceZones(), polyMeshAdder::mergePointZones(), primitiveMesh::pointPoints(), Pstream::Pstream(), TRIsurfaceFormatCore::read(), surfaceFeatures::selectFeatureEdges(), PatchTools::sortedPointEdges(), extendedEdgeMesh::sortPointsAndEdges(), autoSnapDriver::splitDiagonals(), topoCellLooper::subsetList(), and isoSurface::trimToBox().

Here is the caller graph for this function:

◆ setSize() [1/2]

void setSize ( const label )

inline

Alter the addressed list size.

New space will be allocated if required. Use this to resize the list prior to using the operator[] for setting values (as per List usage).

Referenced by InteractionLists< typename CloudType::parcelType >::buildInteractionLists(), primitiveMesh::pointCells(), OBJedgeFormat::read(), refinementHistory::refinementHistory(), face::triangles(), streamLineBase::trimToBox(), and WallLocalSpringSliderDashpot< CloudType >::WallLocalSpringSliderDashpot().

Here is the caller graph for this function:

◆ setSize() [2/2]

void setSize	(	const	label,
		const T &
	)

inline

Alter the addressed list size and fill new space with a.

constant.

◆ resize() [1/2]

void resize ( const label )

inline

Alter the addressed list size.

New space will be allocated if required. Use this to resize the list prior to using the operator[] for setting values (as per List usage).

◆ resize() [2/2]

void resize	(	const	label,
		const T &
	)

inline

Alter the addressed list size and fill new space with a.

constant.

◆ reserve()

void reserve ( const label nElem )

inline

Reserve allocation space for at least this size.

Never shrinks the allocated size, use setCapacity() for that.

Definition at line 130 of file DynamicListI.H.

Referenced by PointEdgeWave< Type, TrackingData >::handleCyclicPatches(), PointEdgeWave< Type, TrackingData >::handleProcPatches(), main(), STARCDsurfaceFormat< Face >::read(), and STARCDedgeFormat::read().

Here is the caller graph for this function:

◆ clear()

void clear ( )

inline

Clear the addressed list, i.e. set the size to zero.

Allocated size does not change

Definition at line 242 of file DynamicListI.H.

Referenced by domainDecomposition::addInterProcFace(), chemkinReader::addReaction(), singleCellFvMesh::agglomerateMesh(), Foam::bandCompression(), cellCuts::calcAnchors(), CFCFaceToCellStencil::calcCellStencil(), polyDualMesh::calcDual(), createShellMesh::calcPointRegions(), isoSurfaceCell::calcSnappedCc(), isoSurface::calcSnappedCc(), isoSurfaceCell::calcSnappedPoint(), isoSurface::calcSnappedPoint(), faceHeatShading::calculate(), faceShading::calculate(), mapNearestAMI< SourcePatch, TargetPatch >::calculate(), correctedCellVolumeWeightMethod::calculateAddressing(), cellVolumeWeightMethod::calculateAddressing(), mapNearestMethod::calculateAddressing(), primitiveMesh::cellCells(), primitiveMesh::cellEdges(), primitiveMesh::cellPoints(), sampledSets::fieldGroup< Foam::SphericalTensor >::clear(), probes::clearFieldGroups(), edgeCollapser::collapseToEdge(), edgeCollapser::collapseToPoint(), hexRef8::consistentSlowRefinement(), autoSnapDriver::detectWarpedFaces(), triSurfaceTools::doRefine(), autoSnapDriver::doSnap(), primitiveMesh::edgeCells(), primitiveMesh::edgeFaces(), primitiveMesh::faceEdges(), autoSnapDriver::featureAttractionUsingReconstruction(), triSurfaceSearch::findLineAll(), searchableRotatedBox::findLineAll(), searchableBox::findLineAll(), isoSurface::generateTriPoints(), polyTopoChange::getCellOrder(), autoLayerDriver::getVertexString(), PointEdgeWave< Type, TrackingData >::handleCyclicPatches(), PointEdgeWave< Type, TrackingData >::handleProcPatches(), indexedOctree< Foam::treeDataFace >::indexedOctree(), ParticleCollector< CloudType >::initConcentricCircles(), polyMeshAdder::insertVertices(), hexRef8::matchHexShape(), primitiveMesh::pointCells(), primitiveMesh::pointPoints(), faceAreaWeightAMI< SourcePatch, TargetPatch >::processSourceFace(), STARCDsurfaceFormat< Face >::read(), STARCDedgeFormat::read(), STARCDCore::readPoints(), OBJedgeFormat::readVertices(), faceAreaWeightAMI< SourcePatch, TargetPatch >::restartUncoveredSourceFace(), extendedUpwindCellToFaceStencil::selectOppositeFaces(), Reaction::setLRhs(), boundaryCutter::setRefinement(), searchableSurfacesQueries::signedDistance(), procFacesGAMGProcAgglomeration::singleCellMesh(), PatchTools::sortedPointEdges(), autoSnapDriver::splitDiagonals(), polyDualMesh::splitFace(), patchInjectionBase::updateMesh(), cuttingPlane::walkCell(), and PairCollision< CloudType >::wallInteraction().

◆ clearStorage()

void clearStorage ( )

inline

Clear the list and delete storage.

Definition at line 249 of file DynamicListI.H.

Referenced by isoSurfaceCell::collapseSurface(), domainDecomposition::decomposeMesh(), NASedgeFormat::read(), NASsurfaceFormat< Face >::read(), and List< substance >::transfer().

Here is the caller graph for this function:

◆ shrink()

Foam::DynamicList< T, SizeInc, SizeMult, SizeDiv > & shrink ( )

inline

Shrink the allocated space to the number of elements used.

Returns a reference to the DynamicList.

Definition at line 258 of file DynamicListI.H.

Referenced by chemkinReader::addReaction(), chemkinReader::addReactionType(), cellCuts::calcAnchors(), enrichedPatch::calcCutFaces(), polyDualMesh::calcDual(), primitiveMesh::calcEdges(), globalMeshData::calcGlobalPointBoundaryCells(), distributedTriSurfaceMesh::calcLocalQueries(), thresholdCellFaces::calculate(), refinementHistory::clone(), polyDualMesh::collectPatchSideFace(), polyMeshAdder::combinePatches(), hexRef8::consistentSlowRefinement(), hexRef8::consistentSlowRefinement2(), localPointRegion::countPointRegions(), AABBTree::createBoxes(), geomCellLooper::cut(), determineCoupledFaces(), refinementHistory::distribute(), distributedTriSurfaceMesh::distributeSegments(), autoLayerDriver::doLayers(), triSurfaceTools::doRefine(), faceCollapser::filterFace(), filterPatches(), localPointRegion::findDuplicateFacePairs(), meshRefinement::findEdgeConnectedProblemCells(), meshRefinement::freeStandingBaffleFaces(), isoSurfaceCell::generateTriPoints(), isoSurface::generateTriPoints(), cloudSet::genSamples(), triSurfaceMeshPointSet::genSamples(), patchCloudSet::genSamples(), arraySet::genSamples(), patchSeedSet::genSamples(), polyLineSet::genSamples(), circleSet::genSamples(), faceOnlySet::genSamples(), uniformSet::genSamples(), removeCells::getExposedFaces(), combineFaces::getMergeSets(), boundaryMesh::getNearest(), router::getRoute(), getSelectedPatches(), undoableMeshCutter::getSplitFaces(), triSurfaceTools::greenRefine(), indexedOctree< Foam::treeDataFace >::indexedOctree(), intersectedSurface::intersectedSurface(), meshSearch::intersections(), isoSurfaceCell::isoSurfaceCell(), main(), immersedBoundaryFvPatch::makeIbFaces(), meshRefinement::markInternalGapRefinement(), meshRefinement::markSmallFeatureRefinement(), meshRefinement::markSurfaceGapRefinement(), faceCoupleInfo::matchEdgeFaces(), polyMeshAdder::mergeCellZones(), polyMeshAdder::mergeFaceZones(), meshRefinement::mergePatchFacesUndo(), polyMeshAdder::mergePatchNames(), polyMeshAdder::mergePointZones(), ProcessorTopology< Container, ProcPatch >::ProcessorTopology(), NASedgeFormat::read(), OBJsurfaceFormat< Face >::read(), NASsurfaceFormat< Face >::read(), triSurface::readAC(), triSurface::readNAS(), triSurface::readOBJ(), triSurface::readOFF(), searchableSurfaceCollection::regions(), surfaceFeatures::selectFeatureEdges(), dynamicRefineFvMesh::selectRefineCells(), dynamicRefineFvMesh::selectUnrefinePoints(), smoothDelta::setChangedFaces(), faceCoupleInfo::setCutEdgeToPoints(), cellCuts::setFromCellCutter(), Reaction::setLRhs(), faceCollapser::setRefinement(), boundaryCutter::setRefinement(), potential::setSiteIdList(), Foam::fvc::smooth(), polyDualMesh::splitFace(), intersectedSurface::splitFace(), meshRefinement::splitMesh(), meshRefinement::splitMeshRegions(), Foam::fvc::spread(), Foam::fvc::sweep(), List< substance >::transfer(), faceShading::triangulate(), faceHeatShading::triangulate(), triSurfaceTools::triangulate(), triSurfaceTools::triangulateFaceCentre(), streamLineBase::trimToBox(), medialAxisMeshMover::update(), externalDisplacementMeshMover::updateMesh(), vtkTools::write(), and writeFuns::write().

◆ transfer() [1/2]

void transfer ( List< T > & )

inline

Transfer contents of the argument List into this.

Referenced by indexedOctree< Foam::treeDataFace >::divide(), main(), OBJsurfaceFormat< Face >::read(), dynamicIndexedOctree::removeIndex(), polyTopoChange::reorder(), faceAreaWeightAMI< SourcePatch, TargetPatch >::restartUncoveredSourceFace(), and patchInjectionBase::updateMesh().

Here is the caller graph for this function:

◆ transfer() [2/2]

void transfer ( DynamicList< T, SizeInc, SizeMult, SizeDiv > & )

inline

Transfer contents of the argument DynamicList into this.

◆ xfer()

Foam::Xfer< Foam::List< T > > xfer ( )

inline

Transfer contents to the Xfer container as a plain List.

Definition at line 301 of file DynamicListI.H.

Referenced by hexRef8::cellShapes(), fileName::components(), autoSnapDriver::doSnap(), extractSurface(), InteractionLists< typename CloudType::parcelType >::findExtendedProcBbsInRange(), main(), immersedBoundaryFvPatch::makeIbFaces(), epsilonWallFunctionFvPatchScalarField::manipulateMatrix(), omegaWallFunctionFvPatchScalarField::manipulateMatrix(), OBJsurfaceFormat< Face >::read(), NASsurfaceFormat< Face >::read(), OFFsurfaceFormat< Face >::read(), VTKsurfaceFormat< Face >::read(), STARCDsurfaceFormat< Face >::read(), and dictionary::tokens().

Here is the caller graph for this function:

◆ append() [1/3]

DynamicList<T, SizeInc, SizeMult, SizeDiv>& append ( const T & )

inline

Append an element at the end of the list.

◆ append() [2/3]

DynamicList<T, SizeInc, SizeMult, SizeDiv>& append ( const UList< T > & )

inline

Append a List at the end of this list.

◆ append() [3/3]

DynamicList<T, SizeInc, SizeMult, SizeDiv>& append ( const UIndirectList< T > & )

inline

Append a UIndirectList at the end of this list.

◆ remove()

T remove ( )

inline

Remove and return the top element.

Definition at line 365 of file DynamicListI.H.

Referenced by refinementHistory::allocateSplitCell(), UPstream::allocateTag(), directAMI< SourcePatch, TargetPatch >::appendToDirectSeeds(), directMethod::appendToDirectSeeds(), correctedCellVolumeWeightMethod::calculateAddressing(), cellVolumeWeightMethod::calculateAddressing(), mapNearestMethod::findMappedSrcCell(), mapNearestAMI< SourcePatch, TargetPatch >::findMappedSrcFace(), mapNearestMethod::findNearestCell(), mapNearestAMI< SourcePatch, TargetPatch >::findNearestFace(), regionModel1D::initialise(), faceAreaWeightAMI< SourcePatch, TargetPatch >::processSourceFace(), and Reaction::setLRhs().

Here is the caller graph for this function:

◆ operator()()

T & operator() ( const label elemI )

inline

Return non-const access to an element, resizing list if.

necessary

Definition at line 387 of file DynamicListI.H.

◆ operator=() [1/4]

void operator= ( const T & )

inline

Assignment of all addressed entries to the given value.

◆ operator=() [2/4]

void operator= ( const DynamicList< T, SizeInc, SizeMult, SizeDiv > & )

inline

Assignment from DynamicList.

◆ operator=() [3/4]

void operator= ( const UList< T > & )

inline

Assignment from UList.

◆ operator=() [4/4]

void operator= ( const UIndirectList< T > & )

inline

Assignment from UIndirectList.

Friends And Related Function Documentation

◆ List< T >

friend class List< T >

friend

Declare friendship with the List class.

Definition at line 95 of file DynamicList.H.

◆ operator

Ostream& operator	(	Ostream &	,
		const DynamicList< T, SizeInc, SizeMult, SizeDiv > &
	)

friend

◆ operator>>

Istream& operator>>	(	Istream &	,
		DynamicList< T, SizeInc, SizeMult, SizeDiv > &
	)

friend

Read from Istream, discarding contents of existing DynamicList.

Field Documentation

◆ capacity_

label capacity_

private

The capacity (allocated size) of the underlying list.

Definition at line 87 of file DynamicList.H.

The documentation for this class was generated from the following files:

src/OpenFOAM/containers/Lists/DynamicList/DynamicList.H
src/OpenFOAM/containers/Lists/DynamicList/DynamicListI.H

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ DynamicList() [1/7]

◆ DynamicList() [2/7]

◆ DynamicList() [3/7]

◆ DynamicList() [4/7]

◆ DynamicList() [5/7]

◆ DynamicList() [6/7]

◆ DynamicList() [7/7]

Member Function Documentation

◆ StaticAssert()

◆ capacity()

◆ setCapacity()

◆ setSize() [1/2]

◆ setSize() [2/2]

◆ resize() [1/2]

◆ resize() [2/2]

◆ reserve()

◆ clear()

◆ clearStorage()

◆ shrink()

◆ transfer() [1/2]

◆ transfer() [2/2]

◆ xfer()

◆ append() [1/3]

◆ append() [2/3]

◆ append() [3/3]

◆ remove()

◆ operator()()

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

Friends And Related Function Documentation

◆ List< T >

◆ operator

◆ operator>>

Field Documentation

◆ capacity_