Dynamically sized Field. More...
Public Member Functions | |
DynamicField () | |
Construct null. More... | |
DynamicField (const label) | |
Construct given size. More... | |
DynamicField (const label, const T &) | |
Construct given size and initial value. More... | |
DynamicField (const label, const zero) | |
Construct given size and initialised to zero. More... | |
DynamicField (const UList< T > &) | |
Construct from UList. Size set to UList size. More... | |
DynamicField (List< T > &&) | |
Move constructor transferring the list contents. More... | |
DynamicField (const UList< T > &mapF, const labelList &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 DynamicField< T, SizeInc, SizeMult, SizeDiv > &) | |
Copy constructor. More... | |
DynamicField (DynamicField< T, SizeInc, SizeMult, SizeDiv > &, const bool) | |
Copy constructor or reuse as specified. More... | |
DynamicField (DynamicField< T, SizeInc, SizeMult, SizeDiv > &&) | |
Move constructor. More... | |
DynamicField (Istream &) | |
Construct from Istream. Size set to size of list read. More... | |
DynamicField (const word &keyword, const dictionary &, const label size) | |
Construct from a dictionary entry. More... | |
DynamicField (const word &keyword, const unitConversion &, const dictionary &, const label size) | |
Construct from a dictionary entry with unit conversion. More... | |
tmp< DynamicField< T, SizeInc, SizeMult, SizeDiv > > | clone () const |
Clone. 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 T &) |
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 T &) |
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... | |
DynamicField< T, SizeInc, SizeMult, SizeDiv > & | shrink () |
Shrink the allocated space to the number of elements used. More... | |
DynamicField< T, SizeInc, SizeMult, SizeDiv > & | append (const T &) |
Append an element at the end of the list. More... | |
DynamicField< T, SizeInc, SizeMult, SizeDiv > & | append (const UList< T > &) |
Append a List at the end of this list. More... | |
T | remove () |
Remove and return the top element. More... | |
T & | operator() (const label) |
Return non-const access to an element, resizing list if. More... | |
void | operator= (const T &) |
Assignment of all addressed entries to the given value. More... | |
void | operator= (const DynamicField< T, SizeInc, SizeMult, SizeDiv > &) |
Assignment operator. More... | |
void | operator= (DynamicField< T, SizeInc, SizeMult, SizeDiv > &&) |
Move assignment operator. More... | |
void | operator= (const UList< T > &) |
Assignment to UList. More... | |
void | operator= (List< T > &&) |
Move assignment to List. More... | |
Public Member Functions inherited from Field< T > | |
Field () | |
Construct null. More... | |
Field (const label) | |
Construct given size. More... | |
Field (const label, const T &) | |
Construct given size and initial value. More... | |
Field (const label, const zero) | |
Construct given size and initialised to zero. More... | |
Field (const UList< T > &) | |
Copy constructor of a UList<Type> More... | |
Field (List< T > &&) | |
Mover constructor transferring the List contents. More... | |
Field (const UIndirectList< T > &) | |
Copy constructor of a UIndirectList<Type> More... | |
Field (const Field< T > &) | |
Copy constructor. More... | |
Field (Field< T > &, bool reuse) | |
Copy constructor or reuse as specified. More... | |
Field (Field< T > &&) | |
Move constructor transferring the Field contents. More... | |
Field (const tmp< Field< T >> &) | |
Copy constructor of tmp<Field> 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 (Istream &) | |
Construct from Istream. More... | |
Field (const word &keyword, const dictionary &, const label size) | |
Construct from a dictionary entry. More... | |
Field (const word &keyword, const unitConversion &, const dictionary &, const label size) | |
Construct from a dictionary entry with unit conversion. 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 | 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 | reset (const Field< T > &) |
Reset the field values to the given field. More... | |
void | negate () |
Negate this 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 | operator= (const Field< T > &) |
void | operator= (Field< T > &&) |
void | operator= (const UList< T > &) |
void | operator= (List< T > &&) |
void | operator= (const SubField< T > &) |
void | operator= (const tmp< Field< T >> &) |
void | operator= (const T &) |
void | operator= (const 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 refCount | |
int | count () const |
Return the current reference count. More... | |
bool | unique () const |
Return true if the reference count is zero. More... | |
void | operator++ () |
Increment the reference count. More... | |
void | operator++ (int) |
Increment the reference count. More... | |
void | operator-- () |
Decrement the reference count. More... | |
void | operator-- (int) |
Decrement the reference count. More... | |
void | operator= (const refCount &)=delete |
Disallow bitwise assignment. More... | |
Public Member Functions inherited from List< T > | |
List () | |
Null constructor. More... | |
List (const label) | |
Construct with given size. More... | |
List (const label, const T &) | |
Construct with given size and value for all elements. More... | |
List (const label, const zero) | |
Construct with given size initialising all elements to zero. More... | |
List (const List< T > &) | |
Copy constructor. More... | |
template<class T2 > | |
List (const UList< T2 > &) | |
Copy constructor from list containing another type. More... | |
List (List< T > &&) | |
Move constructor. More... | |
List (List< T > &, bool reuse) | |
Construct as copy or reuse as specified. More... | |
List (const UList< T > &, const labelUList &mapAddressing) | |
Construct as subset. More... | |
template<class InputIterator > | |
List (InputIterator first, InputIterator last) | |
Construct given start and end iterators. More... | |
template<unsigned Size> | |
List (const FixedList< T, Size > &) | |
Construct as copy of FixedList<T, Size> More... | |
List (const PtrList< T > &) | |
Construct as copy of PtrList<T> More... | |
List (const SLList< T > &) | |
Construct as copy of SLList<T> More... | |
List (const UIndirectList< T > &) | |
Construct as copy of UIndirectList<T> More... | |
List (const BiIndirectList< T > &) | |
Construct as copy of BiIndirectList<T> More... | |
List (std::initializer_list< T >) | |
Construct from an initialiser list. More... | |
List (Istream &) | |
Construct from Istream. More... | |
autoPtr< List< T > > | clone () const |
Clone. More... | |
~List () | |
Destructor. More... | |
label | size () const |
Return the number of elements in the UList. More... | |
void | resize (const label) |
Alias for setSize(const label) More... | |
void | resize (const label, const T &) |
Alias for setSize(const label, const T&) More... | |
void | setSize (const label) |
Reset size of List. More... | |
void | setSize (const label, const T &) |
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 T &) |
Append an element at the end of the list. More... | |
void | append (const UList< T > &) |
Append a List at the end of this list. More... | |
void | append (const UIndirectList< T > &) |
Append a UIndirectList at the end of this list. More... | |
void | transfer (List< T > &) |
Transfer the contents of the argument List into this list. More... | |
template<unsigned SizeInc, unsigned SizeMult, unsigned SizeDiv> | |
void | transfer (DynamicList< T, SizeInc, SizeMult, SizeDiv > &) |
Transfer the contents of the argument List into this list. More... | |
void | transfer (SortableList< T > &) |
Transfer the contents of the argument List into this list. More... | |
T & | newElmt (const label) |
Return subscript-checked element of UList. More... | |
void | shallowCopy (const UList< T > &)=delete |
Disallow implicit shallowCopy. More... | |
void | operator= (const UList< T > &) |
Assignment to UList operator. Takes linear time. More... | |
void | operator= (const List< T > &) |
Assignment operator. Takes linear time. More... | |
void | operator= (List< T > &&) |
Move assignment operator. More... | |
void | operator= (const SLList< T > &) |
Assignment to SLList operator. Takes linear time. More... | |
void | operator= (const UIndirectList< T > &) |
Assignment to UIndirectList operator. Takes linear time. More... | |
void | operator= (const BiIndirectList< T > &) |
Assignment to BiIndirectList operator. Takes linear time. More... | |
void | operator= (std::initializer_list< T >) |
Assignment to an initialiser list. 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... | |
Public Member Functions inherited from UList< T > | |
UList () | |
Null constructor. More... | |
UList (T *__restrict__ v, label size) | |
Construct from components. More... | |
UList (const UList< T > &)=default | |
Copy construct. 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... | |
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... | |
const bool & | operator[] (const label i) const |
Static Public Member Functions | |
static const DynamicField< T, SizeInc, SizeMult, SizeDiv > & | null () |
Return a null field. More... | |
Static Public Member Functions inherited from Field< T > | |
static const Field< T > & | null () |
Return a null field. More... | |
static tmp< Field< T > > | NewCalculatedType (const Field< Type2 > &f) |
Return a pointer to a new calculatedFvPatchFieldField created on. 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 null UList. More... | |
Friends | |
Ostream & | operator (Ostream &, const DynamicField< T, SizeInc, SizeMult, SizeDiv > &) |
Istream & | operator>> (Istream &, DynamicField< T, SizeInc, SizeMult, SizeDiv > &) |
Read from Istream, discarding contents of existing DynamicField. 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 |
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 std::reverse_iterator< iterator > | reverse_iterator |
Reverse iterator for reverse traversal of UList. More... | |
typedef std::reverse_iterator< const_iterator > | const_reverse_iterator |
Reverse iterator for reverse traversal of constant UList. More... | |
Static Public Attributes inherited from Field< T > | |
static const char *const | typeName |
Protected Member Functions inherited from refCount | |
refCount () | |
Construct null initialising count to 0. More... | |
refCount (const refCount &)=delete | |
Disallow copy. More... | |
Protected Member Functions inherited from List< T > | |
void | size (const label) |
Override size to be inconsistent with allocated storage. More... | |
Dynamically sized Field.
Definition at line 69 of file DynamicField.H.
|
inline |
Construct null.
Definition at line 29 of file DynamicFieldI.H.
|
inlineexplicit |
Construct given size.
Definition at line 37 of file DynamicFieldI.H.
References List< Type >::size().
|
inline |
Construct given size and initial value.
Definition at line 51 of file DynamicFieldI.H.
|
inline |
Construct given size and initialised to zero.
Definition at line 63 of file DynamicFieldI.H.
|
inlineexplicit |
Construct from UList. Size set to UList size.
Also constructs from DynamicField with different sizing parameters.
Definition at line 75 of file DynamicFieldI.H.
|
inlineexplicit |
Move constructor transferring the list contents.
Definition at line 86 of file DynamicFieldI.H.
|
inline |
Construct by 1 to 1 mapping from the given field.
Definition at line 97 of file DynamicFieldI.H.
|
inline |
Construct by interpolative mapping from the given field.
Definition at line 109 of file DynamicFieldI.H.
|
inline |
Copy constructor.
Definition at line 122 of file DynamicFieldI.H.
|
inline |
Copy constructor or reuse as specified.
Definition at line 133 of file DynamicFieldI.H.
|
inline |
Move constructor.
Definition at line 147 of file DynamicFieldI.H.
|
explicit |
Construct from Istream. Size set to size of list read.
Definition at line 31 of file DynamicField.C.
DynamicField | ( | const word & | keyword, |
const dictionary & | dict, | ||
const label | size | ||
) |
Construct from a dictionary entry.
Definition at line 39 of file DynamicField.C.
DynamicField | ( | const word & | keyword, |
const unitConversion & | defaultUnits, | ||
const dictionary & | dict, | ||
const label | size | ||
) |
Construct from a dictionary entry with unit conversion.
Definition at line 52 of file DynamicField.C.
|
inlinestatic |
Return a null field.
Definition at line 90 of file DynamicField.H.
Foam::tmp< Foam::DynamicField< T, SizeInc, SizeMult, SizeDiv > > clone |
Clone.
Definition at line 67 of file DynamicField.C.
|
inline |
Size of the underlying storage.
Definition at line 162 of file DynamicFieldI.H.
Referenced by searchableSurfaces::checkIntersection().
|
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 170 of file DynamicFieldI.H.
|
inline |
Alter the addressed list size.
New space will be allocated if required. Use this to resize the list prior to using the operator[] for setting values (as per List usage).
Definition at line 228 of file DynamicFieldI.H.
Alter the addressed list size and fill new space with a.
constant.
Definition at line 265 of file DynamicFieldI.H.
References setSize(), and List< Type >::size().
|
inline |
Alter the addressed list size.
New space will be allocated if required. Use this to resize the list prior to using the operator[] for setting values (as per List usage).
Definition at line 283 of file DynamicFieldI.H.
References setSize().
Referenced by streamlines::write().
Alter the addressed list size and fill new space with a.
constant.
Definition at line 293 of file DynamicFieldI.H.
References setSize().
|
inline |
Reserve allocation space for at least this size.
Never shrinks the allocated size, use setCapacity() for that.
Definition at line 191 of file DynamicFieldI.H.
|
inline |
Clear the addressed list, i.e. set the size to zero.
Allocated size does not change
Definition at line 304 of file DynamicFieldI.H.
References List< Type >::size().
Referenced by searchableSurfacesQueries::signedDistance().
|
inline |
Clear the list and delete storage.
Definition at line 311 of file DynamicFieldI.H.
References List< Type >::clear().
|
inline |
Shrink the allocated space to the number of elements used.
Returns a reference to the DynamicField.
Definition at line 320 of file DynamicFieldI.H.
References List< Type >::setSize(), and List< Type >::size().
|
inline |
Append an element at the end of the list.
Definition at line 339 of file DynamicFieldI.H.
References setSize(), and List< T >::size().
Referenced by extendedEdgeMesh::add(), searchableSurfaces::checkIntersection(), and searchableSurfacesQueries::signedDistance().
|
inline |
Append a List at the end of this list.
Definition at line 354 of file DynamicFieldI.H.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, forAll, setSize(), List< T >::size(), and UList< T >::size().
|
inline |
Remove and return the top element.
Definition at line 377 of file DynamicFieldI.H.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, UList< T >::operator[](), List< T >::size(), and Foam::T().
Return non-const access to an element, resizing list if.
necessary
Definition at line 398 of file DynamicFieldI.H.
References setSize().
Assignment of all addressed entries to the given value.
Definition at line 413 of file DynamicFieldI.H.
|
inline |
Assignment operator.
Definition at line 423 of file DynamicFieldI.H.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Field< Type >::operator=(), and List< Type >::size().
|
inline |
Move assignment operator.
Definition at line 452 of file DynamicFieldI.H.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and Field< Type >::operator=().
Assignment to UList.
Definition at line 470 of file DynamicFieldI.H.
References Field< Type >::operator=(), and List< Type >::size().
Move assignment to List.
Definition at line 493 of file DynamicFieldI.H.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Field< Type >::operator=(), and List< Type >::size().
|
friend |
|
friend |
Read from Istream, discarding contents of existing DynamicField.