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 len)
	Construct empty field with given reserve size. 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)
	Move construct from List contents. More...

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

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

template<int AnySizeMin>
	DynamicField (DynamicList< T, AnySizeMin > &&list)
	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)

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 T &val)
	Alter addressable size and fill new space with constant value. More...

void	resize_nocopy (const label len)

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...

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...

DynamicField< T, SizeMin > &	shrink ()
	Shrink the allocated space to the number of elements used. 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...

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...

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

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

T &	operator() (const label i)
	Return non-const access to an element, resizing list if needed. 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...

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...

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)
	Move construct from Field. More...

	Field (List< T > &&list)
	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)

	Field (const tmp< Field< T > > &tmapF, const FieldMapper &map, const UList< T > &defaultValues, const bool applyFlip=true)

	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 word &keyword, const dictionary &dict, const label len)
	Construct from a dictionary entry. More...

tmp< Field< T > >	clone () const
	Clone. 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 ()

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...

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)
	Value assignment. More...

void	operator= (const Foam::zero)

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, refCount zero. More...

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

int	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 > &a)
	Copy construct from list. More...

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

	List (List< T > &a, 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...

	List (const SLList< T > &list)
	Construct as copy of SLList<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)
	Move construct from List. More...

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

	List (SLList< T > &&list)
	Move construct from SLList. 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_nocopy (const label len)
	Adjust allocated size of list without necessarily. More...

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

void	setSize (const label n, const T &val)
	Alias for resize() 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)
	Append an element if not already in the list. More...

void	transfer (List< T > &list)

template<int SizeMin>
void	transfer (DynamicList< T, SizeMin > &list)

T &	newElmt (const label i)

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

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

void	operator= (const SLList< T > &list)
	Assignment to SLList 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...

void	operator= (SLList< T > &&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...

Istream &	readList (Istream &is)

void	resize (const label newLen)

Istream &	readList (Istream &is)

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

label	rcIndex (const label i) const noexcept

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 &	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...

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

std::streamsize	byteSize () const

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...

label	find (const T &val, label pos=0) 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...

bool	found (const T &val, label pos=0) const
	True if the value if found in the list. 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 (const UList< T > &list)
	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...

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...

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 noexcept
	The number of elements in the UList. More...

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

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

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

bool	operator!= (const UList< T > &a) 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 > &a) const
	Compare two ULists lexicographically. Takes linear time. More...

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

bool	operator>= (const UList< T > &a) 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

template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	get (const label i) const

template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	unset (const label i)

Istream &	readList (Istream &is)

Ostream &	writeList (Ostream &os, const label) const

const bool &	operator[] (const label i) const

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

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

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

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

Ostream &	writeList (Ostream &os, const label) const

Istream &	readList (Istream &is)

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)

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

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

void	writeEntry (Ostream &os) const

void	writeEntry (Ostream &os) const

Detailed Description

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

Dynamically sized Field.

Source files

Definition at line 62 of file DynamicField.H.

Constructor & Destructor Documentation

◆ DynamicField() [1/16]

constexpr DynamicField

inlineconstexprnoexcept

Default construct, an empty field without allocation.

Definition at line 132 of file DynamicFieldI.H.

◆ DynamicField() [2/16]

DynamicField ( const label len )

inlineexplicit

Construct empty field with given reserve size.

Definition at line 140 of file DynamicFieldI.H.

◆ DynamicField() [3/16]

DynamicField	(	const label	len,
		const T &	val
	)

inline

Construct given size and initial value.

Definition at line 150 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 162 of file DynamicFieldI.H.

◆ DynamicField() [5/16]

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

inline

Copy construct.

Definition at line 174 of file DynamicFieldI.H.

◆ DynamicField() [6/16]

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

inline

Copy construct with different sizing parameters.

Definition at line 186 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 197 of file DynamicFieldI.H.

◆ DynamicField() [8/16]

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

inlineexplicit

Copy construct from IndirectList.

Definition at line 209 of file DynamicFieldI.H.

◆ DynamicField() [9/16]

DynamicField ( List< T > && content )

inlineexplicit

Move construct from List contents.

Definition at line 220 of file DynamicFieldI.H.

◆ DynamicField() [10/16]

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

inline

Move construct from dynamic Field contents.

Definition at line 245 of file DynamicFieldI.H.

◆ DynamicField() [11/16]

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

inline

Move construct with different sizing parameters.

Definition at line 259 of file DynamicFieldI.H.

◆ DynamicField() [12/16]

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

inline

Move construct from DynamicList.

Definition at line 232 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 272 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 284 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 297 of file DynamicFieldI.H.

◆ DynamicField() [16/16]

DynamicField ( Istream & is )

inlineexplicit

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

Definition at line 309 of file DynamicFieldI.H.

Member Function Documentation

◆ null()

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

inlinestatic

Return a null field.

Definition at line 100 of file DynamicField.H.

◆ clone()

Foam::tmp< Foam::DynamicField< T, SizeMin > > clone

inline

Clone.

Definition at line 318 of file DynamicFieldI.H.

◆ min_size()

static constexpr label min_size ( )

inlinestaticconstexprnoexcept

Normal lower capacity limit - the SizeMin template parameter.

Definition at line 183 of file DynamicField.H.

◆ capacity()

Foam::label capacity

inlinenoexcept

Size of the underlying storage.

Definition at line 327 of file DynamicFieldI.H.

Referenced by searchableSurfaces::checkIntersection(), extendedEdgeMesh::cut(), and DynamicField< T, SizeMin >::transfer().

Here is the caller graph for this function:

◆ capacity_bytes()

std::streamsize capacity_bytes

inlinenoexcept

Number of contiguous bytes of the underlying storage.

Note: Only meaningful for contiguous data

Definition at line 335 of file DynamicFieldI.H.

References T.

◆ 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 append().

Definition at line 342 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 352 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 362 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 372 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 382 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 392 of file DynamicFieldI.H.

Referenced by DynamicField< T, SizeMin >::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 412 of file DynamicFieldI.H.

References resize().

Here is the call graph for this function:

◆ 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 402 of file DynamicFieldI.H.

◆ setSize() [1/2]

void setSize ( const label n )

inline

Alias for resize()

Definition at line 239 of file DynamicField.H.

References DynamicField< T, SizeMin >::resize().

Here is the call graph for this function:

◆ setSize() [2/2]

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

inline

Alias for resize()

Definition at line 242 of file DynamicField.H.

References DynamicField< T, SizeMin >::resize().

Here is the call graph for this function:

◆ clear()

void clear

inlinenoexcept

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

Allocated size does not change

Definition at line 431 of file DynamicFieldI.H.

Referenced by zoneDistribute::getFields(), and searchableSurfacesQueries::signedDistance().

Here is the caller graph for this function:

◆ clearStorage()

void clearStorage

inline

Clear the list and delete storage.

Definition at line 438 of file DynamicFieldI.H.

Referenced by DynamicField< T, SizeMin >::transfer().

Here is the caller graph for this function:

◆ expandStorage()

Foam::label expandStorage

inlinenoexcept

Expand the addressable size to fit the allocated capacity.

Returns the previous addressable size.

Definition at line 446 of file DynamicFieldI.H.

◆ shrinkStorage()

void shrinkStorage

inline

Shrink the allocated space to the number of elements used.

Definition at line 458 of file DynamicFieldI.H.

◆ shrink()

Foam::DynamicField< T, SizeMin > & shrink

inline

Shrink the allocated space to the number of elements used.

Returns a reference to the DynamicField.

Definition at line 475 of file DynamicFieldI.H.

◆ swap() [1/2]

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

inline

Swap content, independent of sizing parameter.

Definition at line 484 of file DynamicFieldI.H.

Referenced by DynamicField< T, SizeMin >::readList().

Here is the caller graph for this function:

◆ swap() [2/2]

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

inline

Swap content with DynamicList, independent of sizing parameter.

Definition at line 508 of file DynamicFieldI.H.

References DynamicList< T, SizeMin >::capacity(), and DynamicList< T, SizeMin >::setCapacity_unsafe().

Here is the call graph for this function:

◆ transfer() [1/3]

void transfer ( List< T > & list )

inline

Transfer the parameter contents into this.

Definition at line 535 of file DynamicFieldI.H.

References UList< T >::size().

Here is the call graph for this function:

◆ transfer() [2/3]

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

inline

Transfer the parameter contents into this.

Definition at line 545 of file DynamicFieldI.H.

References DynamicList< T, SizeMin >::capacity(), and DynamicList< T, SizeMin >::clearStorage().

Here is the call graph for this function:

◆ transfer() [3/3]

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

inline

Transfer the parameter contents into this.

Definition at line 570 of file DynamicFieldI.H.

References DynamicField< T, SizeMin >::capacity(), and DynamicField< T, SizeMin >::clearStorage().

Here is the call graph for this function:

◆ append() [1/3]

void append ( const T & val )

inline

Append an element at the end of the list.

Definition at line 594 of file DynamicFieldI.H.

References resize().

Referenced by extendedEdgeMesh::add(), searchableSurfaces::checkIntersection(), extendedEdgeMesh::cut(), zoneDistribute::getFields(), distributedTriSurfaceMesh::getVolumeType(), and searchableSurfacesQueries::signedDistance().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ append() [2/3]

void append ( T && val )

inline

Move append an element.

Definition at line 607 of file DynamicFieldI.H.

References resize().

Here is the call graph for this function:

◆ append() [3/3]

void append ( const UList< T > & list )

inline

Append a List at the end of this list.

Definition at line 620 of file DynamicFieldI.H.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, resize(), UList< T >::size(), and T.

Here is the call graph for this function:

◆ remove()

T remove

inline

Remove and return the top element.

Definition at line 643 of file DynamicFieldI.H.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and T.

Here is the call graph for this function:

◆ readList()

Foam::Istream & readList ( Istream & is )

inline

Read from Istream, discarding existing contents.

Uses a DynamicList::readList internally

Definition at line 769 of file DynamicFieldI.H.

References DynamicList< T, SizeMin >::readList(), and DynamicField< T, SizeMin >::swap().

Here is the call graph for this function:

◆ operator()()

T & operator() ( const label i )

inline

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

Definition at line 665 of file DynamicFieldI.H.

References resize().

Here is the call graph for this function:

◆ operator=() [1/8]

void operator= ( const T & val )

inline

Assign addressed entries to the given value.

Definition at line 680 of file DynamicFieldI.H.

◆ operator=() [2/8]

void operator= ( const Foam::zero )

inline

Assign addressed entries to zero.

Definition at line 690 of file DynamicFieldI.H.

◆ operator=() [3/8]

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

inline

Copy assignment.

Definition at line 700 of file DynamicFieldI.H.

◆ operator=() [4/8]

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

inline

Copy assignment.

Definition at line 710 of file DynamicFieldI.H.

◆ operator=() [5/8]

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

inline

Move assignment.

Definition at line 725 of file DynamicFieldI.H.

◆ operator=() [6/8]

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

inline

Move assignment.

Definition at line 757 of file DynamicFieldI.H.

◆ operator=() [7/8]

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

inline

Move assignment.

Definition at line 735 of file DynamicFieldI.H.

◆ operator=() [8/8]

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

inline

Move assignment.

Definition at line 746 of file DynamicFieldI.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

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

◆ expandStorage()

◆ shrinkStorage()

◆ shrink()

◆ swap() [1/2]

◆ swap() [2/2]

◆ transfer() [1/3]

◆ transfer() [2/3]

◆ transfer() [3/3]

◆ append() [1/3]

◆ append() [2/3]

◆ append() [3/3]

◆ remove()

◆ readList()

◆ operator()()

◆ operator=() [1/8]

◆ operator=() [2/8]

◆ operator=() [3/8]

◆ operator=() [4/8]

◆ operator=() [5/8]

◆ operator=() [6/8]

◆ operator=() [7/8]

◆ operator=() [8/8]

Friends And Related Function Documentation

◆ operator>>

◆ operator