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 len)
	Construct an empty list with given reserve size. More...

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

	DynamicList (const label len, const Foam::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 (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...

std::streamsize	capacity_bytes () const noexcept
	Number of contiguous bytes of the underlying storage. More...

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

void	setCapacity_nocopy (const label len)

void	setCapacity_unsafe (const label len) noexcept

void	reserve (const label len)

void	reserve_nocopy (const label len)

void	resize (const label len)

void	resize (const label len, const point &val)
	Alter addressable size and fill new entries with constant value. More...

void	resize_nocopy (const label len)

void	setSize (const label n)
	Same as resize() More...

void	setSize (const label n, const point &val)
	Same as resize() More...

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

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

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

void	shrinkStorage ()
	Shrink the allocated space to the number of elements used. More...

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

void	swap (DynamicList< point, AnySizeMin > &other)
	Swap content, independent of sizing parameter. More...

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

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

void	transfer (SortableList< point > &list)
	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)

label	appendUniq (const point &val)
	Append an element if not already in the list. More...

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)
	Return non-const access to an element, resizing list if needed. More...

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

void	operator= (const Foam::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...

Istream &	readList (Istream &is)
	Read from Istream, discarding existing contents. 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...

Detailed Description

Locations for each instance of an obstacle group.

Definition at line 326 of file PDRobstacle.H.

Constructor & Destructor Documentation

◆ obstacleGrouping() [1/2]

obstacleGrouping ( )

inline

Construct null.

Definition at line 340 of file PDRobstacle.H.

◆ obstacleGrouping() [2/2]

obstacleGrouping ( const vector & origin )

inlineexplicit

Construct with one location (instance)

Definition at line 347 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 355 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 363 of file PDRobstacle.H.

◆ addCylinder()

void addCylinder ( )

inline

Increment the number of cylinder-like obstacles.

Definition at line 369 of file PDRobstacle.H.

◆ nObstacle()

label nObstacle ( ) const

inline

The number of obstacles.

Definition at line 375 of file PDRobstacle.H.

◆ nCylinder()

label nCylinder ( ) const

inline

The number of cylinder-like obstacles.

Definition at line 381 of file PDRobstacle.H.

◆ nTotalObstacle()

label nTotalObstacle ( ) const

inline

The number of locations x number of obstacles.

Definition at line 387 of file PDRobstacle.H.

◆ nTotalCylinder()

label nTotalCylinder ( ) const

inline

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

Definition at line 393 of file PDRobstacle.H.

◆ nTotal()

label nTotal ( ) const

inline

The number of locations x number of obstacles.

Definition at line 399 of file PDRobstacle.H.

◆ append()

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

inline

Add a location.

Definition at line 408 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/PDR/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()