Grid locations in an axis direction. More...
Public Member Functions | |
| bool | valid () const |
| The location list is valid if it contains 2 or more points. More... | |
| label | nCells () const |
| The number of cells in this direction. More... | |
| label | nPoints () const |
| The number of points in this direction. More... | |
| bool | contains (const scalar p) const |
| True if the location is within the range. More... | |
| const scalar & | min () const |
| The first() value is considered the min value. More... | |
| const scalar & | max () const |
| The last() value is considered the max value. More... | |
| scalar | centre () const |
| Mid-point location, zero for an empty list. More... | |
| scalar | length () const |
| The difference between min/max values, zero for an empty list. More... | |
| void | checkIndex (const label i) const |
| Check that element index is within valid range. More... | |
| scalar | width (const label i) const |
| Cell size at element position. More... | |
| scalar | C (const label i) const |
| Cell centre at element position. More... | |
| scalarMinMax | edgeLimits () const |
| Return min/max edge lengths. More... | |
| gradingDescriptors | grading () const |
| Return edge grading descriptors for the locations. More... | |
| label | findCell (const scalar p) const |
| Find the cell index enclosing this location. More... | |
| label | findIndex (const scalar p, const scalar tol) const |
| Find the grid index, within the given tolerance. More... | |
| const scalar & | clip (const scalar &val) const |
 Public Member Functions inherited from List< scalar > | |
| constexpr | List () noexcept |
| Default construct. More... | |
| List (const label len) | |
| Construct with given size. More... | |
| List (const label len, const scalar &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 scalar &val) | |
| Construct with length=1, copying the value as the only content. More... | |
| List (const Foam::one, scalar &&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< scalar > &a) | |
| Copy construct from list. More... | |
| List (const UList< scalar > &a) | |
| Copy construct contents from list. More... | |
| List (List< scalar > &a, bool reuse) | |
| Construct as copy or re-use as specified. More... | |
| List (const UList< scalar > &list, const labelUList &indices) | |
| Copy construct subset of list. More... | |
| List (const UList< scalar > &list, const FixedList< label, N > &indices) | |
| Copy construct subset of list. More... | |
| List (const FixedList< scalar, N > &list) | |
| Construct as copy of FixedList<T, N> More... | |
| List (const PtrList< scalar > &list) | |
| Construct as copy of PtrList<T> More... | |
| List (const SLList< scalar > &list) | |
| Construct as copy of SLList<T> More... | |
| List (const IndirectListBase< scalar, Addr > &list) | |
| Construct as copy of IndirectList contents. More... | |
| List (std::initializer_list< scalar > list) | |
| Construct from an initializer list. More... | |
| List (List< scalar > &&list) | |
| Move construct from List. More... | |
| List (DynamicList< scalar, SizeMin > &&list) | |
| Move construct from DynamicList. More... | |
| List (SortableList< scalar > &&list) | |
| Move construct from SortableList. More... | |
| List (SLList< scalar > &&list) | |
| Move construct from SLList. More... | |
| List (Istream &is) | |
| Construct from Istream. More... | |
| autoPtr< List< scalar > > | 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 scalar &val) |
| Adjust allocated size of list and set val for new elements. More... | |
| void | resize (const label newLen) |
| 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 scalar &val) |
| Alias for resize() More... | |
| void | append (const scalar &val) |
| Append an element at the end of the list. More... | |
| void | append (scalar &&val) |
| Move append an element at the end of the list. More... | |
| void | append (const UList< scalar > &list) |
| Append a List to the end of this list. More... | |
| void | append (const IndirectListBase< scalar, Addr > &list) |
| Append IndirectList contents at the end of this list. More... | |
| label | appendUniq (const scalar &val) |
| Append an element if not already in the list. More... | |
| void | transfer (List< scalar > &list) |
| void | transfer (DynamicList< scalar, SizeMin > &list) |
| void | transfer (SortableList< scalar > &list) |
| scalar & | newElmt (const label i) |
| void | operator= (const UList< scalar > &a) |
| Assignment to UList operator. Takes linear time. More... | |
| void | operator= (const List< scalar > &list) |
| Assignment operator. Takes linear time. More... | |
| void | operator= (const SLList< scalar > &list) |
| Assignment to SLList operator. Takes linear time. More... | |
| void | operator= (const IndirectListBase< scalar, Addr > &list) |
| Assignment from IndirectList. Takes linear time. More... | |
| void | operator= (const FixedList< scalar, N > &list) |
| Copy assignment from FixedList. More... | |
| void | operator= (std::initializer_list< scalar > list) |
| Assignment to an initializer list. More... | |
| void | operator= (const scalar &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< scalar > &&list) |
| Move assignment. Takes constant time. More... | |
| void | operator= (DynamicList< scalar, SizeMin > &&list) |
| Move assignment. Takes constant time. More... | |
| void | operator= (SortableList< scalar > &&list) |
| Move assignment. Takes constant time. More... | |
| void | operator= (SLList< scalar > &&list) |
| Move assignment. Takes constant time. More... | |
| Istream & | readList (Istream &is) |
| Read List from Istream, discarding contents of existing List. More... | |
| Istream & | readList (Istream &is) |
| Istream & | readList (Istream &is) |
| void | shallowCopy (const UList< scalar > &)=delete |
| No shallowCopy permitted. More... | |
| 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... | |
Additional Inherited Members | |
| Public Types inherited from List< scalar > | |
| typedef SubList< scalar > | subList |
| Declare type of subList. More... | |
| Static Public Member Functions inherited from List< scalar > | |
| static const List< scalar > & | null () |
| Return a null List. More... | |
Grid locations in an axis direction.
The number of points is one larger than the number of elements it represents
Definition at line 178 of file PDRblock.H.
|
inline |
The location list is valid if it contains 2 or more points.
Definition at line 31 of file PDRblockI.H.
|
inline |
The number of cells in this direction.
Definition at line 37 of file PDRblockI.H.
|
inline |
The number of points in this direction.
Definition at line 43 of file PDRblockI.H.
|
inline |
|
inline |
The first() value is considered the min value.
Definition at line 55 of file PDRblockI.H.
|
inline |
The last() value is considered the max value.
Definition at line 61 of file PDRblockI.H.
|
inline |
Mid-point location, zero for an empty list.
Definition at line 67 of file PDRblockI.H.
|
inline |
The difference between min/max values, zero for an empty list.
Definition at line 73 of file PDRblockI.H.
References Foam::mag().
|
inline |
Check that element index is within valid range.
Definition at line 79 of file PDRblockI.H.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, ijkMesh::nCells(), and Foam::nl.
|
inline |
Cell size at element position.
Definition at line 91 of file PDRblockI.H.
References ijkAddressing::checkIndex().
|
inline |
Cell centre at element position.
Treats -1 and nCells positions like a halo cell.
Definition at line 101 of file PDRblockI.H.
References ijkAddressing::checkIndex().
| Foam::scalarMinMax edgeLimits | ( | ) | const |
Return min/max edge lengths.
Definition at line 263 of file PDRblockLocation.C.
References MinMax< T >::add().
| gradingDescriptors grading | ( | ) | const |
Return edge grading descriptors for the locations.
| Foam::label findCell | ( | const scalar | p | ) | const |
Find the cell index enclosing this location.
Definition at line 276 of file PDRblockLocation.C.
References Foam::equal(), Foam::findLower(), and p.
| Foam::label findIndex | ( | const scalar | p, |
| const scalar | tol | ||
| ) | const |
Find the grid index, within the given tolerance.
Return -1 for out-of-bounds and -2 for a point that is within bounds, but not aligned with a grid point.
Definition at line 303 of file PDRblockLocation.C.
References delta, Foam::diff(), Foam::mag(), and p.
|
inline |
If out of range, return the respective min/max limits, otherwise return the value itself.
If the range is invalid, always return the value.
Definition at line 127 of file PDRblockI.H.
1.8.17 