Dynamically sized Field. More...

Inheritance diagram for DynamicField< T, SizeMin >:

Collaboration diagram for DynamicField< T, SizeMin >:

Public Member Functions
constexpr	DynamicField () noexcept
	Default construct, an empty field without allocation. More...

	DynamicField (const label initialCapacity)
	Construct empty field with given initial capacity. More...

	DynamicField (const label len, const T &val)
	Construct given size and initial value. More...

	DynamicField (const label len, const Foam::zero)
	Construct given size and initial value of zero. More...

	DynamicField (const DynamicField< T, SizeMin > &list)
	Copy construct. More...

template<int AnySizeMin>
	DynamicField (const DynamicField< T, AnySizeMin > &list)
	Copy construct with different sizing parameters. More...

	DynamicField (const UList< T > &list)
	Copy construct from UList. Size set to UList size. More...

template<class Addr >
	DynamicField (const IndirectListBase< T, Addr > &list)
	Copy construct from IndirectList. More...

	DynamicField (List< T > &&content) noexcept
	Move construct from List contents. More...

	DynamicField (DynamicField< T, SizeMin > &&content) noexcept
	Move construct from dynamic Field contents. More...

template<int AnySizeMin>
	DynamicField (DynamicField< T, AnySizeMin > &&content) noexcept
	Move construct with different sizing parameters. More...

template<int AnySizeMin>
	DynamicField (DynamicList< T, AnySizeMin > &&content) noexcept
	Move construct from DynamicList. More...

	DynamicField (const UList< T > &mapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given field. More...

	DynamicField (const UList< T > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given field. More...

	DynamicField (const UList< T > &mapF, const FieldMapper &map)
	Construct by mapping from the given field. More...

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

tmp< DynamicField< T, SizeMin > >	clone () const
	Clone. 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)
	Alter the size of the underlying storage, without retaining old content. More...

void	setCapacity_unsafe (const label len) noexcept
	Change the value for the list capacity directly (ADVANCED, UNSAFE) Does not perform any memory management or resizing. More...

void	reserve (const label len)
	Reserve allocation space for at least this size, allocating new space if required and retaining old content. More...

void	reserve_nocopy (const label len)
	Reserve allocation space for at least this size, allocating new space if required without retaining old content. More...

void	resize (const label len)
	Alter addressable list size, allocating new space if required while recovering old content. More...

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

void	resize_nocopy (const label len)
	Alter addressable list size, allocating new space if required without necessarily recovering old content. More...

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

void	setSize (const label n, const T &val)
	Alias for 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...

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

void	shrink_unsafe ()
	Shrink the internal bookkeeping of the allocated space to the number of addressed elements without affecting allocation. More...

DynamicField< T, SizeMin > &	shrink ()
	Calls shrink_to_fit() and returns a reference to the DynamicField. More...

void	swap (List< T > &list)
	Swap with plain List content. Implies shrink_to_fit(). More...

template<int AnySizeMin>
void	swap (DynamicField< T, AnySizeMin > &other)
	Swap content, independent of sizing parameter. More...

template<int AnySizeMin>
void	swap (DynamicList< T, AnySizeMin > &other)
	Swap content with DynamicList, independent of sizing parameter. More...

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

template<int AnySizeMin>
void	transfer (DynamicList< T, AnySizeMin > &list)
	Transfer the parameter contents into this. More...

template<int AnySizeMin>
void	transfer (DynamicField< T, AnySizeMin > &list)
	Transfer the parameter contents into this. More...

template<class... Args>
T &	emplace_back (Args &&... args)
	Construct an element at the end of the list, return reference to the new list element. More...

void	push_back (const T &val)
	Copy append an element at the end of the list. More...

void	push_back (T &&val)
	Move append an element. More...

void	push_back (const UList< T > &list)
	Copy append another list to the end of this list. More...

void	push_back (List< T > &&list)
	Move append another list to the end of this list. More...

void	pop_back (label n=1)
	Reduce size by 1 or more elements. Can be called on an empty list. More...

Istream &	readList (Istream &is)
	Read from Istream, discarding existing contents. More...

void	operator= (const T &val)
	Assign addressed entries to the given value. More...

void	operator= (const Foam::zero)
	Assign addressed entries to zero. More...

void	operator= (const UList< T > &list)
	Copy assignment. More...

void	operator= (const DynamicField< T, SizeMin > &list)
	Copy assignment. More...

template<class Addr >
void	operator= (const IndirectListBase< T, Addr > &rhs)
	Copy assign from IndirectList. More...

void	operator= (List< T > &&list)
	Move assignment. More...

template<int AnySizeMin>
void	operator= (DynamicList< T, AnySizeMin > &&list)
	Move assignment. More...

void	operator= (DynamicField< T, SizeMin > &&list)
	Move assignment. More...

template<int AnySizeMin>
void	operator= (DynamicField< T, AnySizeMin > &&list)
	Move assignment. More...

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

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

void	append (T &&val)
	Move append an element. More...

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

Public Member Functions inherited from Field< T >
constexpr	Field () noexcept
	Default construct. More...

	Field (const label len)
	Construct given size. More...

	Field (const label len, const T &val)
	Construct given size and initial value. More...

	Field (const label len, const Foam::zero)
	Construct given size and initial values of zero. More...

	Field (const Foam::one, const T &val)
	Construct with length=1, copying the value as the only content. More...

	Field (const Foam::one, T &&val)
	Construct with length=1, moving the value as the only content. More...

	Field (const Foam::one, const Foam::zero)
	Construct with length=1, initializing content to zero. More...

	Field (const Field< T > &fld)
	Copy construct. More...

	Field (const UList< T > &list)
	Copy construct from UList<Type> More...

	Field (const IndirectListBase< T, Addr > &list)
	Copy construct from IndirectList. More...

	Field (Field< T > &&fld) noexcept
	Move construct from Field. More...

	Field (List< T > &&list) noexcept
	Move construct from List. More...

	Field (DynamicList< T, SizeMin > &&list)
	Move construct from DynamicList. More...

	Field (const UList< T > &mapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given field. More...

	Field (const tmp< Field< T >> &tmapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given tmp field. More...

	Field (const UList< T > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given field. More...

	Field (const tmp< Field< T >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given tmp field. More...

	Field (const UList< T > &mapF, const FieldMapper &map, const bool applyFlip=true)
	Construct by mapping from the given field. More...

	Field (const UList< T > &mapF, const FieldMapper &map, const T &defaultValue, const bool applyFlip=true)
	Construct by mapping from the given field. More...

	Field (const UList< T > &mapF, const FieldMapper &map, const UList< T > &defaultValues, const bool applyFlip=true)
	Construct by mapping from the given field. More...

	Field (const tmp< Field< T >> &tmapF, const FieldMapper &map, const bool applyFlip=true)
	Construct by mapping from the given tmp field. More...

	Field (const tmp< Field< T >> &tmapF, const FieldMapper &map, const T &defaultValue, const bool applyFlip=true)
	Construct by mapping from the given tmp field. Uses supplied uniform value for unmapped items. More...

	Field (const tmp< Field< T >> &tmapF, const FieldMapper &map, const UList< T > &defaultValues, const bool applyFlip=true)
	Construct by mapping from the given tmp field. Uses supplied values for unmapped items. More...

	Field (Field< T > &fld, bool reuse)
	Copy construct or re-use as specified. More...

	Field (const tmp< Field< T >> &tfld)
	Copy or move construct from tmp. More...

	Field (Istream &is)
	Construct from Istream. More...

	Field (const entry &e, const label len)
	Construct from a dictionary (primitive) entry. More...

	Field (const word &key, const dictionary &dict, const label len, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ)
	Lookup of a primitive dictionary entry by (literal) name and assign its contents to this. The behaviour largely as described in assign(): More...

tmp< Field< T > >	clone () const
	Clone. More...

void	assign (const entry &e, const label len)
	Assign from a primitive dictionary entry with the following behaviour: More...

bool	assign (const word &key, const dictionary &dict, const label len, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ)
	Lookup a primitive dictionary entry by (literal) name and assign its contents to this (behaviour as described above). More...

void	map (const UList< T > &mapF, const labelUList &mapAddressing)
	1 to 1 map from the given field More...

void	map (const tmp< Field< T >> &tmapF, const labelUList &mapAddressing)
	1 to 1 map from the given tmp field More...

void	map (const UList< T > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Interpolative map from the given field. More...

void	map (const tmp< Field< T >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
	Interpolative map from the given tmp field. More...

void	map (const UList< T > &mapF, const FieldMapper &map, const bool applyFlip=true)
	Map from the given field. More...

void	map (const tmp< Field< T >> &tmapF, const FieldMapper &map, const bool applyFlip=true)
	Map from the given tmp field. More...

void	autoMap (const FieldMapper &map, const bool applyFlip=true)
	Map from self. More...

void	rmap (const UList< T > &mapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given field More...

void	rmap (const tmp< Field< T >> &tmapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given tmp field More...

void	rmap (const UList< T > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given field. More...

void	rmap (const tmp< Field< T >> &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given tmp field. More...

void	negate ()
	Inplace negate this field (negative). More...

void	normalise ()
	Inplace normalise this field. Generally a no-op except for vector fields. More...

void	normalise ()

void	normalise ()

void	normalise ()
	Inplace normalise (float) vector field. More...

void	normalise ()
	Inplace normalise (double) vector field. More...

tmp< Field< cmptType > >	component (const direction) const
	Return a component field of the field. More...

void	replace (const direction, const UList< cmptType > &)
	Replace a component field of the field. More...

void	replace (const direction, const tmp< Field< cmptType >> &)
	Replace a component field of the field. More...

void	replace (const direction, const cmptType &)
	Replace a component field of the field. More...

void	clamp_min (const T &lower)
	Impose lower (floor) clamp on the field values (in-place) More...

void	clamp_max (const T &upper)
	Impose upper (ceiling) clamp on the field values (in-place) More...

void	clamp_range (const T &lower, const T &upper)
	Clamp field values (in-place) to the specified range. More...

void	clamp_range (const MinMax< T > &range)
	Clamp field values (in-place) to the specified range. More...

VSForm	block (const label start) const

tmp< Field< T > >	T () const
	Return the field transpose (only defined for second rank tensors) More...

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

SubField< T >	slice (const label pos, label len=-1)
	Return SubField slice (non-const access) - no range checking. More...

const SubField< T >	slice (const label pos, label len=-1) const
	Return SubField slice (const access) - no range checking. More...

SubField< T >	slice (const labelRange &range)
	Return SubField slice (non-const access) - with range checking. More...

const SubField< T >	slice (const labelRange &range) const
	Return SubField slice (const access) - with range checking. More...

void	operator= (const Field< T > &)
	Copy assignment. More...

void	operator= (const tmp< Field< T >> &)

void	operator= (const UList< T > &rhs)

void	operator= (const SubField< T > &rhs)

void	operator= (const IndirectListBase< T, Addr > &rhs)
	Copy assign from IndirectList. More...

void	operator= (Field< T > &&rhs)
	Move assignment. More...

void	operator= (List< T > &&rhs)

void	operator= (DynamicList< T, SizeMin > &&rhs)

void	operator= (const T &val)
	Assign entries to the given value. More...

void	operator= (const Foam::zero)
	Assign entries to zero. More...

void	operator= (const VectorSpace< Form, Cmpt, nCmpt > &)

void	operator= (const tmp< Field > &rhs)

void	operator+= (const UList< T > &)

void	operator+= (const tmp< Field< T >> &)

void	operator+= (const T &)

void	operator-= (const UList< T > &)

void	operator-= (const tmp< Field< T >> &)

void	operator-= (const T &)

void	operator*= (const UList< scalar > &)

void	operator*= (const tmp< Field< scalar >> &)

void	operator*= (const scalar &)

void	operator/= (const UList< scalar > &)

void	operator/= (const tmp< Field< scalar >> &)

void	operator/= (const scalar &)

Public Member Functions inherited from FieldBase
constexpr	FieldBase () noexcept
	Default construct. More...

Public Member Functions inherited from refCount
constexpr	refCount () noexcept
	Default construct, initializing count to 0. More...

int	use_count () const noexcept
	Return the current reference count. More...

bool	unique () const noexcept
	Return true if the reference count is zero. More...

void	operator++ () noexcept
	Increment the reference count. More...

void	operator++ (int) noexcept
	Increment the reference count. More...

void	operator-- () noexcept
	Decrement the reference count. More...

void	operator-- (int) noexcept
	Decrement the reference count. More...

Public Member Functions inherited from List< T >
constexpr	List () noexcept
	Default construct. More...

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

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

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

	List (const Foam::one, const T &val)
	Construct with length=1, copying the value as the only content. More...

	List (const Foam::one, T &&val)
	Construct with length=1, moving the value as the only content. More...

	List (const Foam::one, const Foam::zero)
	Construct with length=1, initializing content to zero. More...

	List (const List< T > &list)
	Copy construct from list. More...

	List (const UList< T > &list)
	Copy construct contents from list. More...

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

	List (const UList< T > &list, const labelUList &indices)
	Copy construct subset of list. More...

template<unsigned N>
	List (const UList< T > &list, const FixedList< label, N > &indices)
	Copy construct subset of list. More...

template<unsigned N>
	List (const FixedList< T, N > &list)
	Construct as copy of FixedList<T, N> More...

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

template<class Addr >
	List (const IndirectListBase< T, Addr > &list)
	Construct as copy of IndirectList contents. More...

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

	List (List< T > &&list) noexcept
	Move construct from List. More...

template<int SizeMin>
	List (DynamicList< T, SizeMin > &&list)
	Move construct from DynamicList. More...

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

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

	~List ()
	Destructor. More...

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

void	resize (const label len)
	Adjust allocated size of list. More...

void	resize (const label len, const T &val)
	Adjust allocated size of list and set val for new elements. More...

void	resize_fill (const label len, const T &val)
	Adjust allocated size of list and set val for all elements. More...

void	resize_nocopy (const label len)
	Adjust allocated size of list without necessarily. More...

void	resize_unsafe (const label len) noexcept
	Change the addressed list size directly without affecting any memory management (advanced usage). More...

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

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

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

template<int SizeMin>
void	transfer (DynamicList< T, SizeMin > &list)
	Transfer the contents of the argument List into this list and annul the argument list. More...

T &	newElmt (const label i)
	Return subscript-checked element of UList and resizing the list if required. More...

template<class... Args>
T &	emplace_back (Args &&... args)
	Construct an element at the end of the list, return reference to the new list element. More...

void	push_back (const T &val)
	Append an element at the end of the list. More...

void	push_back (T &&val)
	Move append an element at the end of the list. More...

void	push_back (const UList< T > &list)
	Append a List to the end of this list. More...

template<class Addr >
void	push_back (const IndirectListBase< T, Addr > &list)
	Append IndirectList contents at the end of this list. More...

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

void	pop_back (label n=1)
	Reduce size by 1 or more elements. Can be called on an empty list. More...

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

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

template<class Addr >
void	operator= (const IndirectListBase< T, Addr > &list)
	Assignment from IndirectList. Takes linear time. More...

template<unsigned N>
void	operator= (const FixedList< T, N > &list)
	Copy assignment from FixedList. More...

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

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

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

void	operator= (List< T > &&list)
	Move assignment. Takes constant time. More...

template<int SizeMin>
void	operator= (DynamicList< T, SizeMin > &&list)
	Move assignment. Takes constant time. More...

Istream &	readList (Istream &is)
	Read List from Istream, discarding contents of existing List. More...

void	shallowCopy (const UList< T > &)=delete
	No shallowCopy permitted. More...

template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	set (const label i, bool val=true)
	A bitSet::set() method for a list of bool. More...

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

void	append (T &&val)
	Move append an element at the end of the list. More...

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

template<class Addr >
void	append (const IndirectListBase< T, Addr > &list)
	Append IndirectList contents at the end of this list. More...

label	appendUniq (const T &val)
	Same as push_uniq() More...

	List (const SLList< T > &list)
	Copy construct from SLList. More...

void	operator= (const SLList< T > &list)
	Copy assign from SLList in linear time. More...

template<>
void	resize (const label newLen)

Public Member Functions inherited from UList< T >
	UList (const UList< T > &)=default
	Copy construct. More...

constexpr	UList () noexcept
	Default construct, zero-sized and nullptr. More...

	UList (T *__restrict__ v, const label len) noexcept
	Construct from components. More...

label	fcIndex (const label i) const noexcept
	The forward circular index. The next index in the list which returns to the first at the end of the list. More...

label	rcIndex (const label i) const noexcept
	The reverse circular index. The previous index in the list which returns to the last at the beginning of the list. More...

const T &	fcValue (const label i) const
	Return forward circular value (ie, next value in the list) More...

T &	fcValue (const label i)
	Return forward circular value (ie, next value in the list) More...

const T &	rcValue (const label i) const
	Return reverse circular value (ie, previous value in the list) More...

T &	rcValue (const label i)
	Return reverse circular value (ie, previous value in the list) More...

const T *	cdata () const noexcept
	Return pointer to the underlying array serving as data storage. More...

T *	data () noexcept
	Return pointer to the underlying array serving as data storage. More...

const char *	cdata_bytes () const noexcept
	Return pointer to the underlying array serving as data storage,. More...

char *	data_bytes () noexcept
	Return pointer to the underlying array serving as data storage,. More...

T &	front ()
	Access first element of the list, position [0]. More...

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

T &	back ()
	Access last element of the list, position [size()-1]. More...

const T &	back () const
	Access last element of the list, position [size()-1]. More...

std::streamsize	size_bytes () const noexcept
	Number of contiguous bytes for the List data. More...

std::streamsize	byteSize () const
	Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous. More...

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

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

void	checkRange (const label start, const label len) const
	Check that start and length define a valid range. More...

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

bool	uniform () const
	True if all entries have identical values, and list is non-empty. More...

bool	contains (const T &val) const
	True if the value is contained in the list. More...

bool	contains (const T &val, label pos, label len=-1) const
	Is the value contained in the list? More...

label	find (const T &val) const
	Find index of the first occurrence of the value. More...

label	find (const T &val, label pos, label len=-1) const
	Find index of the first occurrence of the value. More...

label	rfind (const T &val, label pos=-1) const
	Find index of the last occurrence of the value. More...

void	moveFirst (const label i)
	Move element to the first position. More...

void	moveLast (const label i)
	Move element to the last position. More...

void	swapFirst (const label i)
	Swap element with the first element. Fatal on an empty list. More...

void	swapLast (const label i)
	Swap element with the last element. Fatal on an empty list. More...

void	shallowCopy (T *__restrict__ ptr, const label len) noexcept
	Copy the pointer and size. More...

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

void	deepCopy (const UList< T > &list)
	Copy elements of the given UList. Sizes must match! More...

template<class Addr >
void	deepCopy (const IndirectListBase< T, Addr > &list)
	Copy elements of the given indirect list. Sizes must match! More...

SubList< T >	slice (const label pos, label len=-1)
	Return SubList slice (non-const access) - no range checking. More...

const SubList< T >	slice (const label pos, label len=-1) const
	Return SubList slice (const access) - no range checking. More...

SubList< T >	slice (const labelRange &range)
	Return SubList slice (non-const access) - with range checking. More...

const SubList< T >	slice (const labelRange &range) const
	Return SubList slice (const access) - with range checking. More...

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

const T &	operator[] (const label i) 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 &val)
	Assignment of all entries to the given value. More...

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

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

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

iterator	begin (const label i) noexcept
	Return iterator at offset i from begin, clamped to [0,size] range. More...

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

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

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

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

const_iterator	cbegin (const label i) const noexcept
	Return const_iterator at offset i from begin, clamped to [0,size] range. More...

const_iterator	begin (const label i) const noexcept
	Return const_iterator at offset i from begin, clamped to [0,size] range. 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...

bool	empty () const noexcept
	True if List is empty (ie, size() is zero) More...

label	size () const noexcept
	The number of elements in the container. More...

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

void	swap (UList< T > &list) noexcept
	Swap content with another UList of the same type in constant time. More...

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

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

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

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

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

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

Istream &	readList (Istream &is)
	Read List contents from Istream. More...

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

Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write List, with line-breaks in ASCII when length exceeds shortLen. More...

template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	test (const label i) const
	Test `bool` value at specified position, always false for out-of-range access. More...

template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	get (const label i) const
	Return `bool` value at specified position, always false for out-of-range access. More...

template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	unset (const label i)
	Unset the `bool` entry at specified position, always false for out-of-range access. More...

T &	first ()
	Access first element of the list, position [0]. More...

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

T &	last ()
	Access last element of the list, position [size()-1]. More...

const T &	last () const
	Access last element of the list, position [size()-1]. More...

bool	found (const T &val, label pos=0) const
	Same as contains() More...

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

template<>
UPstream::commsStruct &	operator[] (const label procID)

template<>
const UPstream::commsStruct &	operator[] (const label procID) const

template<>
Foam::UPstream::commsStruct &	operator[] (const label procID)

template<>
const Foam::UPstream::commsStruct &	operator[] (const label procID) const

Static Public Member Functions
static const DynamicField< T, SizeMin > &	null ()
	Return a null field. More...

static constexpr label	min_size () noexcept
	Normal lower capacity limit - the SizeMin template parameter. More...

Static Public Member Functions inherited from Field< T >
static const Field< T > &	null ()
	Return nullObject reference Field. More...

static autoPtr< Field< T > >	New (Istream &is)
	Return a pointer to a new Field created on freestore. More...

static tmp< Field< T > >	NewCalculatedType (const Field< Type2 > &f)
	Return a pointer to a new calculatedFvPatchFieldField created on freestore without setting patchField values. More...

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

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

static constexpr label	max_size () noexcept
	The size of the largest possible UList. More...

Friends
Istream &	operator>> (Istream &is, DynamicField< T, SizeMin > &rhs)
	Use the readList() method to read contents from Istream. More...

Ostream &	operator (Ostream &os, const DynamicField< T, SizeMin > &rhs)
	Write to Ostream. More...

Additional Inherited Members
Public Types inherited from Field< T >
typedef pTraits< T >::cmptType	cmptType
	Component type. More...

typedef SubField< T >	subField
	Declare type of subField. More...

Public Types inherited from List< T >
typedef SubList< T >	subList
	Declare type of subList. More...

Public Types inherited from UList< T >
typedef T	value_type
	The value type the list contains. More...

typedef T *	pointer
	The pointer type for non-const access to value_type items. More...

typedef const T *	const_pointer
	The pointer type for const access to value_type items. More...

typedef T &	reference
	The type used for storing into value_type objects. More...

typedef const T &	const_reference
	The type used for reading from constant value_type objects. More...

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

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

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

typedef label	difference_type
	The difference between iterator objects. More...

typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator (non-const access) More...

typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator (const access) More...

Static Public Attributes inherited from FieldBase
static const char *const	typeName
	Typename for Field. More...

static bool	allowConstructFromLargerSize = false
	Permit read construct from a larger size. More...

Protected Member Functions inherited from UList< T >
void	setAddressableSize (const label n) noexcept
	Set addressed size to be inconsistent with allocated storage. More...

void	size (const label n)
	Older name for setAddressableSize. More...

void	writeEntry (Ostream &os) const
	Write the UList with its compound type. More...

labelRange	validateRange (const labelRange &requestedRange) const
	Return a validated (start,size) subset range, which means that it always addresses a valid section of the list. More...

void	fill_uniform (const T &val)
	Assign all entries to the given value. More...

void	fill_uniform (const Foam::zero)
	Assign all entries to zero. More...

UList< T > &	operator= (const UList< T > &)=delete
	No copy assignment (default: shallow copy) More...

template<>
void	writeEntry (Ostream &os) const
	Character list writeEntry. More...

template<>
void	operator= (const Foam::zero)
	Character list assign zero - avoids Foam::zero casting ambiguities. More...

template<>
void	writeEntry (Ostream &os) const

template<>
void	operator= (const Foam::zero)

Detailed Description

template<class T, int SizeMin = 64>
class Foam::DynamicField< T, SizeMin >

Dynamically sized Field.

Source files

Definition at line 45 of file DynamicField.H.

Constructor & Destructor Documentation

◆ DynamicField() [1/16]

constexpr DynamicField ( )

inlinenoexcept

Default construct, an empty field without allocation.

Definition at line 125 of file DynamicFieldI.H.

◆ DynamicField() [2/16]

DynamicField ( const label initialCapacity )

inlineexplicit

Construct empty field with given initial capacity.

Definition at line 133 of file DynamicFieldI.H.

◆ DynamicField() [3/16]

DynamicField	(	const label	len,
		const T &	val
	)

inline

Construct given size and initial value.

Definition at line 144 of file DynamicFieldI.H.

◆ DynamicField() [4/16]

DynamicField	(	const label	len,
		const Foam::zero
	)

inline

Construct given size and initial value of zero.

Definition at line 156 of file DynamicFieldI.H.

◆ DynamicField() [5/16]

DynamicField ( const DynamicField< T, SizeMin > & list )

inline

Copy construct.

Definition at line 168 of file DynamicFieldI.H.

◆ DynamicField() [6/16]

DynamicField ( const DynamicField< T, AnySizeMin > & list )

inline

Copy construct with different sizing parameters.

Definition at line 180 of file DynamicFieldI.H.

◆ DynamicField() [7/16]

DynamicField ( const UList< T > & list )

inlineexplicit

Copy construct from UList. Size set to UList size.

Also constructs from DynamicField with different sizing parameters.

Definition at line 191 of file DynamicFieldI.H.

◆ DynamicField() [8/16]

DynamicField ( const IndirectListBase< T, Addr > & list )

inlineexplicit

Copy construct from IndirectList.

Definition at line 203 of file DynamicFieldI.H.

◆ DynamicField() [9/16]

DynamicField ( List< T > && content )

inlineexplicitnoexcept

Move construct from List contents.

Definition at line 214 of file DynamicFieldI.H.

◆ DynamicField() [10/16]

DynamicField ( DynamicField< T, SizeMin > && content )

inlinenoexcept

Move construct from dynamic Field contents.

Definition at line 239 of file DynamicFieldI.H.

◆ DynamicField() [11/16]

DynamicField ( DynamicField< T, AnySizeMin > && content )

inlinenoexcept

Move construct with different sizing parameters.

Definition at line 253 of file DynamicFieldI.H.

◆ DynamicField() [12/16]

DynamicField ( DynamicList< T, AnySizeMin > && content )

inlinenoexcept

Move construct from DynamicList.

Definition at line 226 of file DynamicFieldI.H.

◆ DynamicField() [13/16]

DynamicField	(	const UList< T > &	mapF,
		const labelUList &	mapAddressing
	)

inline

Construct by 1 to 1 mapping from the given field.

Definition at line 266 of file DynamicFieldI.H.

◆ DynamicField() [14/16]

DynamicField	(	const UList< T > &	mapF,
		const labelListList &	mapAddressing,
		const scalarListList &	weights
	)

inline

Construct by interpolative mapping from the given field.

Definition at line 278 of file DynamicFieldI.H.

◆ DynamicField() [15/16]

DynamicField	(	const UList< T > &	mapF,
		const FieldMapper &	map
	)

inline

Construct by mapping from the given field.

Definition at line 291 of file DynamicFieldI.H.

◆ DynamicField() [16/16]

DynamicField ( Istream & is )

inlineexplicit

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

Definition at line 302 of file DynamicFieldI.H.

Member Function Documentation

◆ null()

static const DynamicField<T, SizeMin>& null ( )

inlinestatic

Return a null field.

Definition at line 111 of file DynamicField.H.

◆ clone()

Foam::tmp< Foam::DynamicField< T, SizeMin > > clone ( ) const

inline

Clone.

Definition at line 311 of file DynamicFieldI.H.

◆ min_size()

static constexpr label min_size ( )

inlinestaticnoexcept

Normal lower capacity limit - the SizeMin template parameter.

Definition at line 231 of file DynamicField.H.

◆ capacity()

label capacity ( ) const

inlinenoexcept

Size of the underlying storage.

Definition at line 236 of file DynamicField.H.

Referenced by extendedEdgeMesh::cut(), and DynamicField< Foam::vector >::transfer().

Here is the caller graph for this function:

◆ capacity_bytes()

std::streamsize capacity_bytes ( ) const

inlinenoexcept

Number of contiguous bytes of the underlying storage.

Note: Only meaningful for contiguous data

Definition at line 321 of file DynamicFieldI.H.

◆ setCapacity()

void setCapacity ( const label len )

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 push_back().

Definition at line 329 of file DynamicFieldI.H.

Referenced by extendedEdgeMesh::cut().

Here is the caller graph for this function:

◆ setCapacity_nocopy()

void setCapacity_nocopy ( const label len )

inline

Alter the size of the underlying storage, without retaining old content.

The addressed size will be truncated if needed to fit, but will remain otherwise untouched.

Definition at line 339 of file DynamicFieldI.H.

◆ setCapacity_unsafe()

void setCapacity_unsafe ( const label len )

inlinenoexcept

Change the value for the list capacity directly (ADVANCED, UNSAFE) Does not perform any memory management or resizing.

Definition at line 349 of file DynamicFieldI.H.

◆ reserve()

void reserve ( const label len )

inline

Reserve allocation space for at least this size, allocating new space if required and retaining old content.

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

Definition at line 359 of file DynamicFieldI.H.

◆ reserve_nocopy()

void reserve_nocopy ( const label len )

inline

Reserve allocation space for at least this size, allocating new space if required without retaining old content.

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

Definition at line 369 of file DynamicFieldI.H.

◆ resize() [1/2]

void resize ( const label len )

inline

Alter addressable list size, allocating new space if required while recovering old content.

If no reallocation is required, the contents remain untouched. Otherwise new entries will be uninitialized. Use this to resize the list prior to using the operator[] for setting values (as per List usage).

Definition at line 379 of file DynamicFieldI.H.

Referenced by DynamicField< Foam::vector >::setSize().

Here is the caller graph for this function:

◆ resize() [2/2]

void resize	(	const label	len,
		const T &	val
	)

inline

Alter addressable size and fill new space with constant value.

Definition at line 399 of file DynamicFieldI.H.

◆ resize_nocopy()

void resize_nocopy ( const label len )

inline

Alter addressable list size, allocating new space if required without necessarily recovering old content.

If no reallocation is required, the contents remain untouched. Otherwise all entries will be uninitialized.

Definition at line 389 of file DynamicFieldI.H.

◆ setSize() [1/2]

void setSize ( const label n )

inline

Alias for resize()

Definition at line 316 of file DynamicField.H.

◆ setSize() [2/2]

void setSize	(	const label	n,
		const T &	val
	)

inline

Alias for resize()

Definition at line 321 of file DynamicField.H.

◆ clear()

void clear ( )

inlinenoexcept

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

Allocated size does not change

Definition at line 419 of file DynamicFieldI.H.

Referenced by zoneDistribute::getFields(), and isoAlpha::reconstruct().

Here is the caller graph for this function:

◆ clearStorage()

void clearStorage ( )

inline

Clear the list and delete storage.

Definition at line 426 of file DynamicFieldI.H.

Referenced by DynamicField< Foam::vector >::transfer().

Here is the caller graph for this function:

◆ shrink_to_fit()

void shrink_to_fit ( )

inline

Shrink the allocated space to the number of elements used.

Definition at line 434 of file DynamicFieldI.H.

◆ shrink_unsafe()

void shrink_unsafe ( )

inline

Shrink the internal bookkeeping of the allocated space to the number of addressed elements without affecting allocation.

Note: when empty() it will delete any allocated memory.

Definition at line 449 of file DynamicFieldI.H.

◆ shrink()

Foam::DynamicField< T, SizeMin > & shrink ( )

inline

Calls shrink_to_fit() and returns a reference to the DynamicField.

Definition at line 462 of file DynamicFieldI.H.

◆ swap() [1/3]

void swap ( List< T > & list )

inline

Swap with plain List content. Implies shrink_to_fit().

Definition at line 471 of file DynamicFieldI.H.

◆ swap() [2/3]

void swap ( DynamicField< T, AnySizeMin > & other )

inline

Swap content, independent of sizing parameter.

Definition at line 496 of file DynamicFieldI.H.

◆ swap() [3/3]

void swap ( DynamicList< T, AnySizeMin > & other )

inline

Swap content with DynamicList, independent of sizing parameter.

Definition at line 520 of file DynamicFieldI.H.

◆ transfer() [1/3]

void transfer ( List< T > & list )

inline

Transfer the parameter contents into this.

Definition at line 546 of file DynamicFieldI.H.

◆ transfer() [2/3]

void transfer ( DynamicList< T, AnySizeMin > & list )

inline

Transfer the parameter contents into this.

Definition at line 556 of file DynamicFieldI.H.

◆ transfer() [3/3]

void transfer ( DynamicField< T, AnySizeMin > & list )

inline

Transfer the parameter contents into this.

Definition at line 579 of file DynamicFieldI.H.

◆ emplace_back()

T & emplace_back ( Args &&... args )

inline

Construct an element at the end of the list, return reference to the new list element.

Definition at line 601 of file DynamicFieldI.H.

◆ push_back() [1/4]

void push_back ( const T & val )

inline

Copy append an element at the end of the list.

Definition at line 618 of file DynamicFieldI.H.

Referenced by DynamicField< Foam::vector >::append().

Here is the caller graph for this function:

◆ push_back() [2/4]

void push_back ( T && val )

inline

Move append an element.

Definition at line 631 of file DynamicFieldI.H.

◆ push_back() [3/4]

void push_back ( const UList< T > & list )

inline

Copy append another list to the end of this list.

Definition at line 644 of file DynamicFieldI.H.

◆ push_back() [4/4]

void push_back ( List< T > && list )

inline

Move append another list to the end of this list.

Definition at line 664 of file DynamicFieldI.H.

◆ pop_back()

void pop_back ( label n = 1 )

inline

Reduce size by 1 or more elements. Can be called on an empty list.

Definition at line 685 of file DynamicFieldI.H.

◆ readList()

Foam::Istream & readList ( Istream & is )

inline

Read from Istream, discarding existing contents.

Uses a DynamicList::readList internally

Definition at line 824 of file DynamicFieldI.H.

◆ operator=() [1/9]

void operator= ( const T & val )

inline

Assign addressed entries to the given value.

Definition at line 717 of file DynamicFieldI.H.

◆ operator=() [2/9]

void operator= ( const Foam::zero )

inline

Assign addressed entries to zero.

Definition at line 727 of file DynamicFieldI.H.

◆ operator=() [3/9]

void operator= ( const UList< T > & list )

inline

Copy assignment.

Definition at line 737 of file DynamicFieldI.H.

◆ operator=() [4/9]

void operator= ( const DynamicField< T, SizeMin > & list )

inline

Copy assignment.

Definition at line 747 of file DynamicFieldI.H.

◆ operator=() [5/9]

void operator= ( const IndirectListBase< T, Addr > & rhs )

inline

Copy assign from IndirectList.

if ( static_cast<const UList<T>*>(this) == static_cast<const UList<T>*>(&list.values()) )

Definition at line 763 of file DynamicFieldI.H.

◆ operator=() [6/9]

void operator= ( List< T > && list )

inline

Move assignment.

Definition at line 780 of file DynamicFieldI.H.

◆ operator=() [7/9]

void operator= ( DynamicList< T, AnySizeMin > && list )

inline

Move assignment.

Definition at line 812 of file DynamicFieldI.H.

◆ operator=() [8/9]

void operator= ( DynamicField< T, SizeMin > && list )

inline

Move assignment.

Definition at line 790 of file DynamicFieldI.H.

◆ operator=() [9/9]

void operator= ( DynamicField< T, AnySizeMin > && list )

inline

Move assignment.

Definition at line 801 of file DynamicFieldI.H.

◆ operator()()

T & operator() ( const label i )

inline

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

Definition at line 702 of file DynamicFieldI.H.

◆ append() [1/3]

void append ( const T & val )

inline

Append an element at the end of the list.

FOAM_DEPRECATED_FOR(2022-10, "push_back()")

Definition at line 520 of file DynamicField.H.

Referenced by extendedEdgeMesh::add(), extendedEdgeMesh::cut(), zoneDistribute::getFields(), and isoAlpha::reconstruct().

Here is the caller graph for this function:

◆ append() [2/3]

void append ( T && val )

inline

Move append an element.

FOAM_DEPRECATED_FOR(2022-10, "push_back()")

Definition at line 527 of file DynamicField.H.

◆ append() [3/3]

void append ( const UList< T > & list )

inline

Append a List at the end of this list.

FOAM_DEPRECATED_FOR(2022-10, "push_back()")

Definition at line 534 of file DynamicField.H.

Friends And Related Function Documentation

◆ operator>>

Istream& operator>>	(	Istream &	is,
		DynamicField< T, SizeMin > &	rhs
	)

friend

Use the readList() method to read contents from Istream.

◆ operator

Ostream& operator	(	Ostream &	os,
		const DynamicField< T, SizeMin > &	rhs
	)

friend

Write to Ostream.

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

src/OpenFOAM/fields/Fields/DynamicField/DynamicField.H
src/OpenFOAM/fields/Fields/DynamicField/DynamicFieldI.H

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

template<class T, int SizeMin = 64> class Foam::DynamicField< T, SizeMin >

Constructor & Destructor Documentation

◆ DynamicField() [1/16]

◆ DynamicField() [2/16]

◆ DynamicField() [3/16]

◆ DynamicField() [4/16]

◆ DynamicField() [5/16]

◆ DynamicField() [6/16]

◆ DynamicField() [7/16]

◆ DynamicField() [8/16]

◆ DynamicField() [9/16]

◆ DynamicField() [10/16]

◆ DynamicField() [11/16]

◆ DynamicField() [12/16]

◆ DynamicField() [13/16]

◆ DynamicField() [14/16]

◆ DynamicField() [15/16]

◆ DynamicField() [16/16]

Member Function Documentation

◆ null()

◆ clone()

◆ min_size()

◆ capacity()

◆ capacity_bytes()

◆ setCapacity()

◆ setCapacity_nocopy()

◆ setCapacity_unsafe()

◆ reserve()

◆ reserve_nocopy()

◆ resize() [1/2]

◆ resize() [2/2]

◆ resize_nocopy()

◆ setSize() [1/2]

◆ setSize() [2/2]

◆ clear()

◆ clearStorage()

◆ shrink_to_fit()

◆ shrink_unsafe()

◆ shrink()

◆ swap() [1/3]

◆ swap() [2/3]

◆ swap() [3/3]

◆ transfer() [1/3]

◆ transfer() [2/3]

◆ transfer() [3/3]

◆ emplace_back()

◆ push_back() [1/4]

◆ push_back() [2/4]

◆ push_back() [3/4]

◆ push_back() [4/4]

◆ pop_back()

◆ readList()

◆ operator=() [1/9]

◆ operator=() [2/9]

◆ operator=() [3/9]

◆ operator=() [4/9]

◆ operator=() [5/9]

◆ operator=() [6/9]

◆ operator=() [7/9]

◆ operator=() [8/9]

◆ operator=() [9/9]

◆ operator()()

◆ append() [1/3]

◆ append() [2/3]

◆ append() [3/3]

Friends And Related Function Documentation

◆ operator>>

◆ operator

template<class T, int SizeMin = 64>
class Foam::DynamicField< T, SizeMin >