Class used for grouping field types. More...

Inheritance diagram for probes::fieldGroup< Type >:

[legend]

Collaboration diagram for probes::fieldGroup< Type >:

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

Public Member Functions inherited from DynamicList< word >
	DynamicList ()
	Construct null. More...

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

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

	DynamicList (const DynamicList< word, 0, 2, 1 > &)
	Construct copy. More...

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

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

	DynamicList (const Xfer< List< word >> &)
	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 word &)
	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 word &)
	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< word, 0, 2, 1 > &	shrink ()
	Shrink the allocated space to the number of elements used. More...

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

void	transfer (DynamicList< word, 0, 2, 1 > &)
	Transfer contents of the argument DynamicList into this. More...

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

DynamicList< word, 0, 2, 1 > &	append (const word &)
	Append an element at the end of the list. More...

DynamicList< word, 0, 2, 1 > &	append (const UList< word > &)
	Append a List at the end of this list. More...

DynamicList< word, 0, 2, 1 > &	append (const UIndirectList< word > &)
	Append a UIndirectList at the end of this list. More...

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

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

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

void	operator= (const DynamicList< word, 0, 2, 1 > &)
	Assignment to DynamicList. More...

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

void	operator= (const UIndirectList< word > &)
	Assignment to UIndirectList. More...

UList< word >::iterator	erase (typename UList< word >::iterator)
	Erase an element, move the remaining elements to fill the gap. More...

Public Member Functions inherited from List< word >
	List ()
	Null constructor. More...

	List (const label)
	Construct with given size. More...

	List (const label, const word &)
	Construct with given size and value for all elements. More...

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

	List (const List< word > &)
	Copy constructor. More...

	List (const List< T2 > &)
	Copy constructor from list containing another type. More...

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

	List (List< word > &, bool reuse)
	Construct as copy or re-use as specified. More...

	List (const UList< word > &, const labelUList &mapAddressing)
	Construct as subset. More...

	List (InputIterator first, InputIterator last)
	Construct given start and end iterators. More...

	List (const FixedList< word, Size > &)
	Construct as copy of FixedList<T, Size> More...

	List (const PtrList< word > &)
	Construct as copy of PtrList<T> More...

	List (const SLList< word > &)
	Construct as copy of SLList<T> More...

	List (const UIndirectList< word > &)
	Construct as copy of UIndirectList<T> More...

	List (const BiIndirectList< word > &)
	Construct as copy of BiIndirectList<T> More...

	List (std::initializer_list< word >)
	Construct from an initializer list. More...

	List (Istream &)
	Construct from Istream. More...

label	size () const
	Return the number of elements in the UList. More...

autoPtr< List< word > >	clone () const
	Clone. More...

	~List ()
	Destructor. More...

void	resize (const label)
	Alias for setSize(const label) More...

void	resize (const label, const word &)
	Alias for setSize(const label, const T&) More...

void	setSize (const label)
	Reset size of List. More...

void	setSize (const label, const word &)
	Reset size of List and value for new elements. More...

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

void	append (const word &)
	Append an element at the end of the list. More...

void	append (const UList< word > &)
	Append a List at the end of this list. More...

void	append (const UIndirectList< word > &)
	Append a UIndirectList at the end of this list. More...

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

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

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

Xfer< List< word > >	xfer ()
	Transfer contents to the Xfer container. More...

word &	newElmt (const label)
	Return subscript-checked element of UList. More...

void	shallowCopy (const UList< word > &)=delete
	Disallow implicit shallowCopy. More...

void	operator= (const UList< word > &)
	Assignment to UList operator. Takes linear time. More...

void	operator= (const List< word > &)
	Assignment operator. Takes linear time. More...

void	operator= (const SLList< word > &)
	Assignment to SLList operator. Takes linear time. More...

void	operator= (const UIndirectList< word > &)
	Assignment to UIndirectList operator. Takes linear time. More...

void	operator= (const BiIndirectList< word > &)
	Assignment to BiIndirectList operator. Takes linear time. More...

void	operator= (std::initializer_list< word >)
	Assignment to an initializer list. More...

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

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

Public Member Functions inherited from UList< T >
	UList ()
	Null constructor. More...

	UList (T *__restrict__ v, label size)
	Construct from components. More...

label	fcIndex (const label i) const
	Return the forward circular index, i.e. the next index. More...

label	rcIndex (const label i) const
	Return the reverse circular index, i.e. the previous index. More...

std::streamsize	byteSize () const
	Return the binary size in number of characters of the UList. More...

const T *	cdata () const
	Return a const pointer to the first data element,. More...

T *	data ()
	Return a pointer to the first data element,. More...

T &	first ()
	Return the first element of the list. More...

const T &	first () const
	Return first element of the list. More...

T &	last ()
	Return the last element of the list. More...

const T &	last () const
	Return the last element of the list. More...

void	checkStart (const label start) const
	Check start is within valid range (0 ... size-1) More...

void	checkSize (const label size) const
	Check size is within valid range (0 ... size) More...

void	checkIndex (const label i) const
	Check index i is within valid range (0 ... size-1) More...

void	shallowCopy (const UList< T > &)
	Copy the pointer held by the given UList. More...

void	deepCopy (const UList< T > &)
	Copy elements of the given UList. More...

void	writeEntry (Ostream &) const
	Write the UList as a dictionary entry. More...

void	writeEntry (const word &keyword, Ostream &) const
	Write the UList as a dictionary entry with keyword. More...

T &	operator[] (const label)
	Return element of UList. More...

const T &	operator[] (const label) const
	Return element of constant UList. More...

	operator const Foam::List< T > & () const
	Allow cast to a const List<T>&. More...

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

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

iterator	begin ()
	Return an iterator to begin traversing the UList. More...

iterator	end ()
	Return an iterator to end traversing the UList. More...

const_iterator	cbegin () const
	Return const_iterator to begin traversing the constant UList. More...

const_iterator	cend () const
	Return const_iterator to end traversing the constant UList. More...

const_iterator	begin () const
	Return const_iterator to begin traversing the constant UList. More...

const_iterator	end () const
	Return const_iterator to end traversing the constant UList. More...

reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the UList. More...

reverse_iterator	rend ()
	Return reverse_iterator to end reverse traversing the UList. More...

const_reverse_iterator	crbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList. More...

const_reverse_iterator	crend () const
	Return const_reverse_iterator to end reverse traversing the UList. More...

const_reverse_iterator	rbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList. More...

const_reverse_iterator	rend () const
	Return const_reverse_iterator to end reverse traversing the UList. More...

label	size () const
	Return the number of elements in the UList. More...

label	max_size () const
	Return size of the largest possible UList. More...

bool	empty () const
	Return true if the UList is empty (ie, size() is zero) More...

void	swap (UList< T > &)
	Swap two ULists of the same type in constant time. More...

bool	operator== (const UList< T > &) const
	Equality operation on ULists of the same type. More...

bool	operator!= (const UList< T > &) const
	The opposite of the equality operation. Takes linear time. More...

bool	operator< (const UList< T > &) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator> (const UList< T > &) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator<= (const UList< T > &) const
	Return true if !(a > b). Takes linear time. More...

bool	operator>= (const UList< T > &) const
	Return true if !(a < b). Takes linear time. More...

template<>
const bool &	operator[] (const label i) const

Additional Inherited Members
Public Types inherited from List< word >
typedef SubList< word >	subList
	Declare type of subList. More...

Public Types inherited from UList< T >
typedef T	value_type
	Type of values the UList contains. More...

typedef T &	reference
	Type that can be used for storing into. More...

typedef const T &	const_reference
	Type that can be used for storing into. More...

typedef label	difference_type
	The type that can represent the difference between any two. More...

typedef label	size_type
	The type that can represent the size of a UList. More...

typedef T *	iterator
	Random access iterator for traversing UList. More...

typedef const T *	const_iterator
	Random access iterator for traversing UList. More...

typedef T *	reverse_iterator
	Reverse iterator for reverse traversal of UList. More...

typedef const T *	const_reverse_iterator
	Reverse iterator for reverse traversal of constant UList. More...

Static Public Member Functions inherited from List< word >
static const List< word > &	null ()
	Return a null List. More...

Static Public Member Functions inherited from UList< T >
static const UList< T > &	null ()
	Return a null UList. More...

Protected Member Functions inherited from List< word >
void	size (const label)
	Override size to be inconsistent with allocated storage. More...

Detailed Description

template<class Type>
class Foam::probes::fieldGroup< Type >

Class used for grouping field types.

Definition at line 79 of file probes.H.

Constructor & Destructor Documentation

◆ fieldGroup()

fieldGroup ( )

inline

Construct null.

Definition at line 85 of file probes.H.

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

src/sampling/probes/probes.H

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::probes::fieldGroup< Type >

Constructor & Destructor Documentation

◆ fieldGroup()

template<class Type>
class Foam::probes::fieldGroup< Type >