Locations for each instance of an obstacle group. More...

Inheritance diagram for obstacleGrouping:

Collaboration diagram for obstacleGrouping:

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

	obstacleGrouping (const vector &origin)
	Construct with one location (instance) More...

void	clear ()
	Clear obstacle count and locations. More...

void	addObstacle ()
	Increment the number of obstacles. More...

void	addCylinder ()
	Increment the number of cylinder-like obstacles. More...

label	nObstacle () const
	The number of obstacles. More...

label	nCylinder () const
	The number of cylinder-like obstacles. More...

label	nTotalObstacle () const
	The number of locations x number of obstacles. More...

label	nTotalCylinder () const
	The number of locations x number of cylinder-like obstacles. More...

label	nTotal () const
	The number of locations x number of obstacles. More...

void	append (const scalar x, const scalar y, const scalar z)
	Add a location. More...

Public Member Functions inherited from DynamicList< point >
constexpr	DynamicList () noexcept
	Default construct, an empty list without allocation. More...

	DynamicList (const label nElem)
	Construct an empty list with given reserve size. More...

	DynamicList (const label nElem, const point &val)
	Construct with given size and value for all elements. More...

	DynamicList (const label nElem, const zero)
	Construct with given size initializing all elements to zero. More...

	DynamicList (const DynamicList< point, 16 > &lst)
	Copy construct. More...

	DynamicList (const DynamicList< point, AnySizeMin > &lst)
	Copy construct from DynamicList with different sizing parameters. More...

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

	DynamicList (const FixedList< point, N > &lst)
	Construct from a FixedList. More...

	DynamicList (InputIterator begIter, InputIterator endIter)
	Construct given begin/end iterators. More...

	DynamicList (std::initializer_list< point > lst)
	Construct from an initializer list. Size set to list size. More...

	DynamicList (const IndirectListBase< point, Addr > &lst)
	Construct from IndirectList. Size set to addressing size. More...

	DynamicList (DynamicList< point, 16 > &&lst)
	Move construct. More...

	DynamicList (DynamicList< point, AnySizeMin > &&lst)
	Move construct with different sizing parameters. More...

	DynamicList (List< point > &&lst)
	Move construct from List. More...

	DynamicList (SortableList< point > &&lst)
	Move construct from SortableList. More...

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

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

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

void	setSize (const label nElem)
	Alter addressable list size. More...

void	setSize (const label nElem, const point &val)
	Alter addressable list size and fill new space with constant. More...

void	resize (const label nElem)
	Alter addressable list size. More...

void	resize (const label nElem, const point &val)
	Alter addressable list size and fill new space with constant. More...

void	reserve (const label nElem)
	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...

label	expandStorage ()
	Expand the addressable size to fit the allocated capacity. More...

DynamicList< point, 16 > &	shrink ()
	Shrink the allocated space to the number of elements used. More...

void	swap (DynamicList< point, AnySizeMin > &lst)
	Swap content with any sized DynamicList. More...

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

void	transfer (DynamicList< point, AnySizeMin > &lst)
	Transfer contents of any sized DynamicList into this. More...

void	transfer (SortableList< point > &lst)
	Transfer contents of the argument SortableList into this. More...

DynamicList< point, 16 > &	append (const point &val)
	Append an element to the end of this list. More...

DynamicList< point, 16 > &	append (point &&val)
	Move append an element. More...

DynamicList< point, 16 > &	append (const UList< point > &lst)
	Append another list to the end of this list. More...

DynamicList< point, 16 > &	append (const FixedList< point, N > &lst)
	Append a FixedList to the end of this list. More...

DynamicList< point, 16 > &	append (std::initializer_list< point > lst)
	Append an initializer list at the end of this list. More...

DynamicList< point, 16 > &	append (const IndirectListBase< point, Addr > &lst)
	Append a IndirectList at the end of this list. More...

DynamicList< point, 16 > &	append (List< point > &&lst)
	Move append list. More...

DynamicList< point, 16 > &	append (DynamicList< point, 16 > &&lst)
	Move append list. More...

DynamicList< point, 16 > &	append (DynamicList< point, AnySizeMin > &&lst)
	Move append list. More...

DynamicList< point, 16 > &	append (SortableList< point > &&lst)
	Move append list. More...

Foam::DynamicList< point, 16 > &	append (const FixedList< point, N > &lst)

Foam::DynamicList< point, 16 > &	append (const IndirectListBase< point, Addr > &lst)

Foam::DynamicList< point, 16 > &	append (DynamicList< point, AnySizeMin > &&lst)

point	remove ()
	Remove and return the last element. Fatal on an empty list. More...

point	remove (const label idx, const bool fast=false)
	Remove and return the specified element. Fatal on an empty list. More...

label	remove (const labelRange &range)
	Remove a (start,size) subset from the list. More...

label	remove (std::initializer_list< label > start_size)
	Remove a (start,size) subset from the list. More...

label	subset (const labelRange &range)
	Retain a (start,size) subset from the list. More...

label	subset (std::initializer_list< label > start_size)
	Retain a (start,size) subset from List. More...

point &	operator() (const label i)

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

void	operator= (const zero)
	Assignment of all entries to zero. More...

void	operator= (const UList< point > &lst)
	Assignment to UList. More...

void	operator= (const FixedList< point, N > &lst)
	Assignment to FixedList. More...

void	operator= (const DynamicList< point, 16 > &lst)
	Assignment to DynamicList. More...

void	operator= (const DynamicList< point, AnySizeMin > &lst)
	Assignment from DynamicList with different sizing parameters. More...

void	operator= (std::initializer_list< point > lst)
	Assignment from initializer list. More...

void	operator= (const IndirectListBase< point, Addr > &lst)
	Assignment from IndirectList. More...

void	operator= (List< point > &&lst)
	Move assignment. More...

void	operator= (DynamicList< point, 16 > &&lst)
	Move assignment. More...

void	operator= (DynamicList< point, AnySizeMin > &&lst)
	Move assignment. More...

void	operator= (SortableList< point > &&lst)
	Move assignment. More...

Additional Inherited Members
Static Public Member Functions inherited from DynamicList< point >
static constexpr label	min_size () noexcept
	Normal lower capacity limit - the SizeMin template parameter. More...

Protected Member Functions inherited from DynamicList< point >
void	assignDynList (const ListType &lst)
	Copy assignment from another list. More...

Detailed Description

Locations for each instance of an obstacle group.

Definition at line 324 of file PDRobstacle.H.

Constructor & Destructor Documentation

◆ obstacleGrouping() [1/2]

obstacleGrouping ( )

inline

Construct null.

Definition at line 338 of file PDRobstacle.H.

◆ obstacleGrouping() [2/2]

obstacleGrouping ( const vector & origin )

inlineexplicit

Construct with one location (instance)

Definition at line 345 of file PDRobstacle.H.

References obstacleGrouping::append().

Here is the call graph for this function:

Member Function Documentation

◆ clear()

void clear ( )

inline

Clear obstacle count and locations.

Definition at line 353 of file PDRobstacle.H.

References DynamicList< T, SizeMin >::clear().

Here is the call graph for this function:

◆ addObstacle()

void addObstacle ( )

inline

Increment the number of obstacles.

Definition at line 361 of file PDRobstacle.H.

◆ addCylinder()

void addCylinder ( )

inline

Increment the number of cylinder-like obstacles.

Definition at line 367 of file PDRobstacle.H.

◆ nObstacle()

label nObstacle ( ) const

inline

The number of obstacles.

Definition at line 373 of file PDRobstacle.H.

◆ nCylinder()

label nCylinder ( ) const

inline

The number of cylinder-like obstacles.

Definition at line 379 of file PDRobstacle.H.

◆ nTotalObstacle()

label nTotalObstacle ( ) const

inline

The number of locations x number of obstacles.

Definition at line 385 of file PDRobstacle.H.

◆ nTotalCylinder()

label nTotalCylinder ( ) const

inline

The number of locations x number of cylinder-like obstacles.

Definition at line 391 of file PDRobstacle.H.

◆ nTotal()

label nTotal ( ) const

inline

The number of locations x number of obstacles.

Definition at line 397 of file PDRobstacle.H.

◆ append()

void append	(	const scalar	x,
		const scalar	y,
		const scalar	z
	)

inline

Add a location.

Definition at line 406 of file PDRobstacle.H.

References x, and y.

Referenced by obstacleGrouping::obstacleGrouping().

Here is the caller graph for this function:

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

applications/utilities/preProcessing/PDRsetFields/pdrFields/obstacles/PDRobstacle.H

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ obstacleGrouping() [1/2]

◆ obstacleGrouping() [2/2]

Member Function Documentation

◆ clear()

◆ addObstacle()

◆ addCylinder()

◆ nObstacle()

◆ nCylinder()

◆ nTotalObstacle()

◆ nTotalCylinder()

◆ nTotal()

◆ append()