Specifies an x,y,z array of uniformly distributed sampling points. More...
Public Member Functions | |
| TypeName ("array") | |
| Runtime type information. More... | |
| arraySet (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const word &axis, const coordSystem::cartesian &csys, const Vector< label > &pointsDensity, const Vector< scalar > &spanBox) | |
| Construct from components. More... | |
| arraySet (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const dictionary &dict) | |
| Construct from dictionary. More... | |
| virtual | ~arraySet ()=default |
| Destructor. More... | |
 Public Member Functions inherited from sampledSet | |
| TypeName ("sampledSet") | |
| Runtime type information. More... | |
| declareRunTimeSelectionTable (autoPtr, sampledSet, word,(const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const dictionary &dict),(name, mesh, searchEngine, dict)) | |
| sampledSet (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const coordSet::coordFormat axisType) | |
| Construct from components. More... | |
| sampledSet (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const word &axis) | |
| Construct from components. More... | |
| sampledSet (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const dictionary &dict) | |
| Construct from dictionary. More... | |
| autoPtr< sampledSet > | clone () const |
| Clone. More... | |
| virtual | ~sampledSet ()=default |
| Destructor. More... | |
| const polyMesh & | mesh () const noexcept |
| const meshSearch & | searchEngine () const noexcept |
| const labelList & | segments () const noexcept |
| const labelList & | cells () const noexcept |
| const labelList & | faces () const noexcept |
| Ostream & | write (Ostream &) const |
| Output for debugging. More... | |
| Public Member Functions inherited from coordSet | |
| coordSet (const word &name, const coordFormat axisType) | |
| Default construct with name and axis type. More... | |
| coordSet (const word &name, const word &axis) | |
| Default construct with name and axis type. More... | |
| coordSet (const word &name, const word &axis, const List< point > &points, const scalarList &dist) | |
| Copy construct from components. More... | |
| coordSet (const word &name, const word &axis, List< point > &&points, scalarList &&dist) | |
| Move construct from components. More... | |
| const word & | name () const noexcept |
| The coord-set name. More... | |
| const word & | axis () const |
| The sort axis name. More... | |
| const pointField & | points () const noexcept |
| Return the points. More... | |
| const scalarList & | distance () const noexcept |
| Return the cumulative distance. More... | |
| label | nPoints () const noexcept |
| Return the number of points. More... | |
| void | rename (const word &newName) |
| Rename the coordinate set. More... | |
| void | setPoints (const List< point > &newPoints) |
| Copy assign new points. More... | |
| void | setPoints (List< point > &&newPoints) |
| Move assign new points. More... | |
| void | setDistance (const scalarList &dist, const bool check=true) |
| Copy assign the cumulative distance. More... | |
| void | setDistance (scalarList &&dist, const bool check=true) |
| Move assign the cumulative distance. More... | |
| bool | hasVectorAxis () const noexcept |
| True if axis specification is a vector. More... | |
| scalar | scalarCoord (const label index) const |
| Get coordinate of point according to axis specification. More... | |
| const vector & | vectorCoord (const label index) const |
| Get point according to axis="xyz" specification. More... | |
| Ostream & | write (Ostream &os) const |
| Write to stream. More... | |
| autoPtr< coordSet > | gatherSort (labelList &sortOrder) const |
| Gather and sort. More... | |
| const scalarList & | curveDist () const noexcept |
| Return the cumulative distance. More... | |
| void | setCurveDist (const scalarList &dist) |
| Copy assign the cumulative distance. More... | |
| Public Member Functions inherited from Field< vector > | |
| constexpr | Field () noexcept |
| Default construct. More... | |
| Field (const label len) | |
| Construct given size. More... | |
| Field (const label len, const vector &val) | |
| Construct given size and initial value. More... | |
| Field (const label len, Foam::zero) | |
| Construct given size and initial values of zero. More... | |
| Field (Foam::one, const vector &val) | |
| Construct with length=1, copying the value as the only content. More... | |
| Field (Foam::one, vector &&val) | |
| Construct with length=1, moving the value as the only content. More... | |
| Field (Foam::one, Foam::zero) | |
| Construct with length=1, initializing content to zero. More... | |
| Field (const Field< vector > &fld) | |
| Copy construct. More... | |
| Field (const UList< vector > &list) | |
| Copy construct from UList<Type> More... | |
| Field (const IndirectListBase< vector, Addr > &list) | |
| Copy construct from IndirectList. More... | |
| Field (Field< vector > &&fld) noexcept | |
| Move construct from Field. More... | |
| Field (List< vector > &&list) noexcept | |
| Move construct from List. More... | |
| Field (DynamicList< vector, SizeMin > &&list) | |
| Move construct from DynamicList. More... | |
| Field (const UList< vector > &mapF, const labelUList &mapAddressing) | |
| Construct by 1 to 1 mapping from the given field. More... | |
| Field (const tmp< Field< vector >> &tmapF, const labelUList &mapAddressing) | |
| Construct by 1 to 1 mapping from the given tmp field. More... | |
| Field (const UList< vector > &mapF, const labelListList &mapAddressing, const scalarListList &weights) | |
| Construct by interpolative mapping from the given field. More... | |
| Field (const tmp< Field< vector >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights) | |
| Construct by interpolative mapping from the given tmp field. More... | |
| Field (const UList< vector > &mapF, const FieldMapper &map, const bool applyFlip=true) | |
| Construct by mapping from the given field. More... | |
| Field (const UList< vector > &mapF, const FieldMapper &map, const vector &defaultValue, const bool applyFlip=true) | |
| Construct by mapping from the given field. More... | |
| Field (const UList< vector > &mapF, const FieldMapper &map, const UList< vector > &defaultValues, const bool applyFlip=true) | |
| Construct by mapping from the given field. More... | |
| Field (const tmp< Field< vector >> &tmapF, const FieldMapper &map, const bool applyFlip=true) | |
| Construct by mapping from the given tmp field. More... | |
| Field (const tmp< Field< vector >> &tmapF, const FieldMapper &map, const vector &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< vector >> &tmapF, const FieldMapper &map, const UList< vector > &defaultValues, const bool applyFlip=true) | |
| Construct by mapping from the given tmp field. Uses supplied values for unmapped items. More... | |
| Field (Field< vector > &fld, bool reuse) | |
| Copy construct or re-use as specified. More... | |
| Field (const tmp< Field< vector >> &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< vector > > | 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< vector > &mapF, const labelUList &mapAddressing) |
| 1 to 1 map from the given field More... | |
| void | map (const tmp< Field< vector >> &tmapF, const labelUList &mapAddressing) |
| 1 to 1 map from the given tmp field More... | |
| void | map (const UList< vector > &mapF, const labelListList &mapAddressing, const scalarListList &weights) |
| Interpolative map from the given field. More... | |
| void | map (const tmp< Field< vector >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights) |
| Interpolative map from the given tmp field. More... | |
| void | map (const UList< vector > &mapF, const FieldMapper &map, const bool applyFlip=true) |
| Map from the given field. More... | |
| void | map (const tmp< Field< vector >> &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< vector > &mapF, const labelUList &mapAddressing) |
| 1 to 1 reverse-map from the given field More... | |
| void | rmap (const tmp< Field< vector >> &tmapF, const labelUList &mapAddressing) |
| 1 to 1 reverse-map from the given tmp field More... | |
| void | rmap (const UList< vector > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights) |
| Interpolative reverse map from the given field. More... | |
| void | rmap (const tmp< Field< vector >> &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 vector &lower) |
| Impose lower (floor) clamp on the field values (in-place) More... | |
| void | clamp_min (const UList< vector > &lower) |
| Impose lower (floor) clamp on the field values (in-place) More... | |
| void | clamp_max (const vector &upper) |
| Impose upper (ceiling) clamp on the field values (in-place) More... | |
| void | clamp_max (const UList< vector > &upper) |
| Impose upper (ceiling) clamp on the field values (in-place) More... | |
| void | clamp_range (const vector &lower, const vector &upper) |
| Clamp field values (in-place) to the specified range. More... | |
| void | clamp_range (const MinMax< vector > &range) |
| Clamp field values (in-place) to the specified range. More... | |
| VSForm | block (const label start) const |
| tmp< Field< vector > > | 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< vector > | slice (const label pos, label len=-1) |
| Return SubField slice (non-const access) - no range checking. More... | |
| const SubField< vector > | slice (const label pos, label len=-1) const |
| Return SubField slice (const access) - no range checking. More... | |
| SubField< vector > | slice (const labelRange &range) |
| Return SubField slice (non-const access) - with range checking. More... | |
| const SubField< vector > | slice (const labelRange &range) const |
| Return SubField slice (const access) - with range checking. More... | |
| void | operator= (const Field< vector > &) |
| Copy assignment. More... | |
| void | operator= (const tmp< Field< vector >> &) |
| void | operator= (const UList< vector > &rhs) |
| void | operator= (const SubField< vector > &rhs) |
| void | operator= (const IndirectListBase< vector, Addr > &rhs) |
| Copy assign from IndirectList. More... | |
| void | operator= (Field< vector > &&rhs) |
| Move assignment. More... | |
| void | operator= (List< vector > &&rhs) |
| void | operator= (DynamicList< vector, SizeMin > &&rhs) |
| void | operator= (const vector &val) |
| Assign entries to the given value. More... | |
| void | operator= (Foam::zero) |
| Assign entries to zero. More... | |
| void | operator= (const VectorSpace< Form, Cmpt, nCmpt > &) |
| void | operator= (const tmp< Field > &rhs) |
| void | operator+= (const UList< vector > &) |
| void | operator+= (const tmp< Field< vector >> &) |
| void | operator+= (const vector &) |
| void | operator-= (const UList< vector > &) |
| void | operator-= (const tmp< Field< vector >> &) |
| void | operator-= (const vector &) |
| 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< vector > | |
| constexpr | List () noexcept |
| Default construct. More... | |
| List (const label len) | |
| Construct with given size. More... | |
| List (const label len, const vector &val) | |
| Construct with given size and value for all elements. More... | |
| List (const label len, Foam::zero) | |
| Construct with given size initializing all elements to zero. More... | |
| List (Foam::one, const vector &val) | |
| Construct with length=1, copying the value as the only content. More... | |
| List (Foam::one, vector &&val) | |
| Construct with length=1, moving the value as the only content. More... | |
| List (Foam::one, Foam::zero) | |
| Construct with length=1, initializing content to zero. More... | |
| List (const List< vector > &list) | |
| Copy construct from list. More... | |
| List (const UList< vector > &list) | |
| Copy construct contents from list. More... | |
| List (List< vector > &list, bool reuse) | |
| Construct as copy or re-use as specified. More... | |
| List (const UList< vector > &list, const labelUList &indices) | |
| Copy construct subset of list. More... | |
| List (const UList< vector > &list, const FixedList< label, N > &indices) | |
| Copy construct subset of list. More... | |
| List (const FixedList< vector, N > &list) | |
| Construct as copy of FixedList<T, N> More... | |
| List (const PtrList< vector > &list) | |
| Construct as copy of PtrList<T> More... | |
| List (const IndirectListBase< vector, Addr > &list) | |
| Construct as copy of IndirectList contents. More... | |
| List (std::initializer_list< vector > list) | |
| Construct from an initializer list. More... | |
| List (List< vector > &&list) noexcept | |
| Move construct from List. More... | |
| List (DynamicList< vector, SizeMin > &&list) | |
| Move construct from DynamicList. More... | |
| List (Istream &is) | |
| Construct from Istream. More... | |
| autoPtr< List< vector > > | 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 vector &val) |
| Adjust allocated size of list and set val for new elements. More... | |
| void | resize (const label len) |
| void | resize_fill (const label len, const vector &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 vector &val) |
| Alias for resize() More... | |
| void | transfer (List< vector > &list) |
| Transfer the contents of the argument List into this list and annul the argument list. More... | |
| void | transfer (DynamicList< vector, SizeMin > &list) |
| Transfer the contents of the argument List into this list and annul the argument list. More... | |
| vector & | newElmt (const label i) |
| Return subscript-checked element of UList and resizing the list if required. More... | |
| vector & | 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 vector &val) |
| Append an element at the end of the list. More... | |
| void | push_back (vector &&val) |
| Move append an element at the end of the list. More... | |
| void | push_back (const UList< vector > &list) |
| Append a List to the end of this list. More... | |
| void | push_back (const IndirectListBase< vector, Addr > &list) |
| Append IndirectList contents at the end of this list. More... | |
| label | push_uniq (const vector &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< vector > &list) |
| Assignment to UList operator. Takes linear time. More... | |
| void | operator= (const List< vector > &list) |
| Assignment operator. Takes linear time. More... | |
| void | operator= (const IndirectListBase< vector, Addr > &list) |
| Assignment from IndirectList. Takes linear time. More... | |
| void | operator= (const FixedList< vector, N > &list) |
| Copy assignment from FixedList. More... | |
| void | operator= (std::initializer_list< vector > list) |
| Assignment to an initializer list. More... | |
| void | operator= (const vector &val) |
| Assignment of all entries to the given value. More... | |
| void | operator= (Foam::zero) |
| Assignment of all entries to zero. More... | |
| void | operator= (List< vector > &&list) |
| Move assignment. Takes constant time. More... | |
| void | operator= (DynamicList< vector, 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< vector > &)=delete |
| No shallowCopy permitted. More... | |
| std::enable_if_t< std::is_same_v< bool, TypeT >, bool > | set (const label i, bool val=true) |
| A bitSet::set() method for a list of bool. More... | |
| void | append (const vector &val) |
| Append an element at the end of the list. More... | |
| void | append (vector &&val) |
| Move append an element at the end of the list. More... | |
| void | append (const UList< vector > &list) |
| Append a List to the end of this list. More... | |
| void | append (const IndirectListBase< vector, Addr > &list) |
| Append IndirectList contents at the end of this list. More... | |
| label | appendUniq (const vector &val) |
| Same as push_uniq() More... | |
| Public Member Functions inherited from UList< T > | |
| UList (const UList< T > &) noexcept=default | |
| Copy construct, shallow copy. More... | |
| UList (UList< T > &&) noexcept=default | |
| Move construct, shallow copy. More... | |
| UList< T > & | operator= (const UList< T > &)=delete |
| No copy assignment (default: shallow copy) More... | |
| UList< T > & | operator= (UList< T > &&) noexcept=default |
| Move assignment, shallow copy. More... | |
| constexpr | UList () noexcept |
| Default construct, zero-sized and nullptr. More... | |
| UList (T *__restrict__ ptr, const label len) noexcept | |
| Construct from components. More... | |
| UList (SubList< T > &&) noexcept | |
| Move construct from a SubList, shallow copy. 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 (std::nullptr_t) noexcept |
| Copy nullptr and zero 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= (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_t< std::is_same_v< bool, TypeT >, bool > | 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_t< std::is_same_v< bool, TypeT >, bool > | 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_t< std::is_same_v< bool, TypeT >, bool > | 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... | |
| void | operator= (Foam::zero) |
| Character list assign zero - avoids Foam::zero casting ambiguities. More... | |
| const bool & | operator[] (const label i) const |
| void | operator= (const Foam::zero) |
Additional Inherited Members | |
| Public Types inherited from coordSet | |
| enum class | coordFormat { X , Y , Z , RADIUS , DISTANCE , XYZ } |
| Enumeration defining the output format for coordinates. More... | |
| Public Types inherited from Field< vector > | |
| typedef pTraits< vector >::cmptType | cmptType |
| Component type. More... | |
| typedef SubField< vector > | subField |
| Declare type of subField. More... | |
| Public Types inherited from List< vector > | |
| typedef SubList< vector > | 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 Member Functions inherited from sampledSet | |
| static autoPtr< sampledSet > | New (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const dictionary &dict) |
| Return a reference to the selected sampledSet. More... | |
| Static Public Member Functions inherited from Field< vector > | |
| static const Field< vector > & | null () noexcept |
| Return a null Field (reference to a nullObject). Behaves like an empty Field. More... | |
| static autoPtr< Field< vector > > | New (Istream &is) |
| Return a pointer to a new Field created on freestore. More... | |
| static tmp< Field< vector > > | 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 FieldBase | |
| static void | warnLocalBoundaryConsistencyCompat (const dictionary &) |
| Warn about keyword changes for local boundary consistency checks. More... | |
| static int | localBoundaryConsistency () noexcept |
| Get flag for local boundary consistency checks. More... | |
| static int | localBoundaryConsistency (int val) noexcept |
| Set flag for local boundary consistency checks. More... | |
| Static Public Member Functions inherited from List< vector > | |
| static const List< vector > & | null () noexcept |
| Return a null List (reference to a nullObject). Behaves like an empty List. More... | |
| Static Public Member Functions inherited from UList< T > | |
| static const UList< T > & | null () noexcept |
| Return a null UList (reference to a nullObject). Behaves like an empty UList. More... | |
| static constexpr label | max_size () noexcept |
| The size of the largest possible UList. More... | |
| Static Public Attributes inherited from coordSet | |
| static const Enum< coordFormat > | coordFormatNames |
| String representation of coordFormat enum. 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... | |
| static bool | unifiedGeometricField |
| GeometricField with extra capacity for flattened boundary fields. Uses opt-switch "unifiedGeometricField". More... | |
| static int | localBoundaryConsistency_ |
| Local boundary field consistency checks. Uses opt-switch "localBoundaryConsistency". More... | |
| static scalar | localBoundaryTolerance_ |
| Tolerance for local boundary field consistency checks. Uses opt-switch "localBoundaryConsistency::tolerance". More... | |
| Protected Member Functions inherited from sampledSet | |
| void | checkDimensions () const |
| Check for consistent sizing. More... | |
| label | getBoundaryCell (const label) const |
| Returns cell next to boundary face. More... | |
| label | getNeighbourCell (const label) const |
| Returns the neighbour cell or the owner if face in on the boundary. More... | |
| label | pointInCell (const point &p, const label samplei) const |
| Return the cell in which the point on the sample line. More... | |
| scalar | calcSign (const label facei, const point &sample) const |
| Calculates inproduct of face normal and vector sample-face centre. More... | |
| label | findNearFace (const label celli, const point &sample, const scalar smallDist) const |
| Returns face label (or -1) of face which is close to sample. More... | |
| point | pushIn (const point &sample, const label facei) const |
| Moves sample in direction of -n to it is 'inside' of facei. More... | |
| bool | getTrackingPoint (const point &samplePt, const point &bPoint, const label bFacei, const scalar smallDist, point &trackPt, label &trackCelli, label &trackFacei) const |
| Calculates start of tracking given samplePt and first boundary. More... | |
| void | setSamples (const List< point > &samplingPts, const labelList &samplingCells, const labelList &samplingFaces, const labelList &samplingSegments, const scalarList &samplingDistance) |
| Set sample data. Copy list contents. More... | |
| void | setSamples (List< point > &&samplingPts, labelList &&samplingCells, labelList &&samplingFaces, labelList &&samplingSegments, scalarList &&samplingDistance) |
| Set sample data. Move list contents. More... | |
| Protected Member Functions inherited from coordSet | |
| void | checkDimensions () const |
| Check for consistent dimensions of points and curve distance. More... | |
| Protected Member Functions inherited from List< vector > | |
| void | resize_copy (const label count, const label len) |
| Low-level resizing (backend for resize). Change allocation size of list, retaining the first count contents. 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 (Foam::zero) |
| Assign all entries to zero. More... | |
| void | writeEntry (Ostream &os) const |
| Character list writeEntry. More... | |
| void | writeEntry (Ostream &os) const |
| Protected Attributes inherited from sampledSet | |
| labelList | segments_ |
| Segment numbers. More... | |
| labelList | cells_ |
| Cell numbers. More... | |
| labelList | faces_ |
| Face numbers (-1 if not known) More... | |
| Protected Attributes inherited from coordSet | |
| word | name_ |
| Name. More... | |
| scalarList | distance_ |
| Cumulative distance for "distance" write specifier. More... | |
| coordFormat | axis_ |
| Axis type. More... | |
Specifies an x,y,z array of uniformly distributed sampling points.
For a dictionary specification:
| Property | Description | Required | Default |
|---|---|---|---|
type | array | yes | |
axis | x, y, z, xyz, distance | yes | |
pointsDensity | The sampling density as (x y z) integers | yes | |
spanBox | The sample box dimensions (vector) | yes |
The dictionary should also contain an embedded (Cartesian) coordinateSystem specification, for example,
origin (-0.05 -0.05 -0.05);
rotation
{
type axes;
e1 (1 0 0);
e2 (0 1 0);
}Definition at line 98 of file arraySet.H.
| arraySet | ( | const word & | name, |
| const polyMesh & | mesh, | ||
| const meshSearch & | searchEngine, | ||
| const word & | axis, | ||
| const coordSystem::cartesian & | csys, | ||
| const Vector< label > & | pointsDensity, | ||
| const Vector< scalar > & | spanBox | ||
| ) |
Construct from components.
Definition at line 138 of file arraySet.C.
| arraySet | ( | const word & | name, |
| const polyMesh & | mesh, | ||
| const meshSearch & | searchEngine, | ||
| const dictionary & | dict | ||
| ) |
Construct from dictionary.
Definition at line 158 of file arraySet.C.
|
virtualdefault |
Destructor.
| TypeName | ( | "array" | ) |
Runtime type information.
1.9.1