Set of directions for each cell in the mesh. Either uniform and size=1 or one set of directions per cell. More...
#include <directions.H>
Public Types | |
| enum | directionType { TAN1 , TAN2 , NORMAL } |
| Enumeration listing the possible coordinate directions. More... | |
| Public Types inherited from List< vectorField > | |
| typedef SubList< vectorField > | subList |
| Declare type of subList. | |
| Public Types inherited from UList< vectorField > | |
| typedef vectorField | value_type |
| The value type the list contains. | |
| typedef vectorField * | pointer |
| The pointer type for non-const access to value_type items. | |
| typedef const vectorField * | const_pointer |
| The pointer type for const access to value_type items. | |
| typedef vectorField & | reference |
| The type used for storing into value_type objects. | |
| typedef const vectorField & | const_reference |
| The type used for reading from constant value_type objects. | |
| typedef vectorField * | iterator |
| Random access iterator for traversing a UList. | |
| typedef const vectorField * | const_iterator |
| Random access iterator for traversing a UList. | |
| typedef label | size_type |
| The type to represent the size of a UList. | |
| typedef label | difference_type |
| The difference between iterator objects. | |
| typedef std::reverse_iterator< iterator > | reverse_iterator |
| Reverse iterator (non-const access). | |
| typedef std::reverse_iterator< const_iterator > | const_reverse_iterator |
| Reverse iterator (const access). | |
| using | is_List |
| Have unique tag. | |
Public Member Functions | |
| directions (const polyMesh &mesh, const dictionary &dict, const twoDPointCorrector *correct2DPtr=nullptr) | |
| Construct from mesh and dictionary and optional 2D corrector. | |
| Public Member Functions inherited from List< vectorField > | |
| void | resize (const label len) |
| autoPtr< List< vectorField > > | clone () const |
| Clone. | |
| ~List () | |
| Destructor. | |
| void | clear () |
| Clear the list, i.e. set size to zero. | |
| void | resize_copy (label count, const label len) |
| Change allocated size of list, retaining the first count elements. | |
| void | resize_fill (const label len, const vectorField &val) |
| Adjust allocated size of list and set val for all elements. | |
| void | resize_nocopy (const label len) |
| Adjust allocated size of list without necessarily. | |
| void | transfer (List< vectorField > &list) |
| Transfer the contents of the argument List into this list and annul the argument list. | |
| vectorField & | newElmt (const label i) |
| Return subscript-checked element of UList and resizing the list if required. | |
| vectorField & | emplace_back (Args &&... args) |
| Construct an element at the end of the list, return reference to the new list element. | |
| void | push_back (const vectorField &val) |
| Append an element at the end of the list. | |
| label | push_uniq (const vectorField &val) |
| Append an element if not already in the list. | |
| void | pop_back (label n=1) |
| Reduce size by 1 or more elements. Can be called on an empty list. | |
| void | operator= (const UList< vectorField > &list) |
| Assignment to UList operator. Takes linear time. | |
| Istream & | readList (Istream &is) |
| Read List from Istream, discarding contents of existing List. | |
| void | shallowCopy (const UList< vectorField > &)=delete |
| No shallowCopy permitted. | |
| bool | set (const label i, bool val=true) |
| A bitSet::set() method for a list of bool. | |
| void | append (const vectorField &val) |
| Append an element at the end of the list. | |
| label | appendUniq (const vectorField &val) |
| Same as push_uniq(). | |
| void | setSize (label n) |
| Alias for resize(). | |
| Public Member Functions inherited from UList< vectorField > | |
| UList (const UList< vectorField > &) noexcept=default | |
| Copy construct, shallow copy. | |
| UList< vectorField > & | operator= (const UList< vectorField > &)=delete |
| No copy assignment (default: shallow copy). | |
| 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. | |
| 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. | |
| const vectorField & | fcValue (const label i) const |
| Return forward circular value (ie, next value in the list). | |
| const vectorField & | rcValue (const label i) const |
| Return reverse circular value (ie, previous value in the list). | |
| const vectorField * | cdata () const noexcept |
| Return pointer to the underlying array serving as data storage. | |
| vectorField * | data () noexcept |
| Return pointer to the underlying array serving as data storage. | |
| const char * | cdata_bytes () const noexcept |
| Return pointer to the underlying array serving as data storage,. | |
| char * | data_bytes () noexcept |
| Return pointer to the underlying array serving as data storage,. | |
| vectorField & | front () |
| Access first element of the list, position [0]. | |
| vectorField & | back () |
| Access last element of the list, position [size()-1]. | |
| std::streamsize | size_bytes () const noexcept |
| Number of contiguous bytes for the List data. | |
| std::streamsize | byteSize () const |
| Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous. | |
| void | checkStart (const label start) const |
| Check start is within valid range [0,size). | |
| void | checkSize (const label size) const |
| Check size is within valid range [0,size]. | |
| void | checkRange (const label start, const label len) const |
| Check that start and length define a valid range. | |
| void | checkIndex (const label i) const |
| Check index is within valid range [0,size). | |
| bool | uniform () const |
| True if all entries have identical values, and list is non-empty. | |
| bool | contains (const vectorField &val) const |
| True if the value is contained in the list. | |
| label | find (const vectorField &val) const |
| Find index of the first occurrence of the value. | |
| label | rfind (const vectorField &val, label pos=-1) const |
| Find index of the last occurrence of the value. | |
| void | moveFirst (const label i) |
| Move element to the first position. | |
| void | moveLast (const label i) |
| Move element to the last position. | |
| void | swapFirst (const label i) |
| Swap element with the first element. Fatal on an empty list. | |
| void | swapLast (const label i) |
| Swap element with the last element. Fatal on an empty list. | |
| void | shallowCopy (vectorField *__restrict__ ptr, const label len) noexcept |
| Copy the pointer and size. | |
| void | deepCopy (const UList< vectorField > &list) |
| Copy elements of the given UList. Sizes must match! | |
| SubList< vectorField > | slice (const label pos, label len=-1) |
| Return SubList slice (non-const access) - no range checking. | |
| vectorField & | operator[] (const label i) |
| Return element of UList. | |
| operator const Foam::List< vectorField > & () const | |
| Allow cast to a const List<T>&. | |
| iterator | begin () noexcept |
| Return an iterator to begin traversing the UList. | |
| iterator | end () noexcept |
| Return an iterator to end traversing the UList. | |
| const_iterator | cbegin () const noexcept |
| Return const_iterator to begin traversing the constant UList. | |
| const_iterator | cend () const noexcept |
| Return const_iterator to end traversing the constant UList. | |
| reverse_iterator | rbegin () |
| Return reverse_iterator to begin reverse traversing the UList. | |
| reverse_iterator | rend () |
| Return reverse_iterator to end reverse traversing the UList. | |
| const_reverse_iterator | crbegin () const |
| Return const_reverse_iterator to begin reverse traversing the UList. | |
| const_reverse_iterator | crend () const |
| Return const_reverse_iterator to end reverse traversing the UList. | |
| bool | empty () const noexcept |
| True if List is empty (ie, size() is zero). | |
| label | capacity () const noexcept |
| Size of the underlying storage. | |
| void | swap (UList< vectorField > &list) noexcept |
| Swap content with another UList of the same type in constant time. | |
| bool | operator== (const UList< vectorField > &list) const |
| Equality operation on ULists of the same type. | |
| bool | operator!= (const UList< vectorField > &list) const |
| The opposite of the equality operation. Takes linear time. | |
| bool | operator< (const UList< vectorField > &list) const |
| Compare two ULists lexicographically. Takes linear time. | |
| bool | operator> (const UList< vectorField > &list) const |
| Compare two ULists lexicographically. Takes linear time. | |
| bool | operator<= (const UList< vectorField > &list) const |
| Return true if !(a > b). Takes linear time. | |
| bool | operator>= (const UList< vectorField > &list) const |
| Return true if !(a < b). Takes linear time. | |
| Istream & | readList (Istream &is) |
| Read List contents from Istream. | |
| Ostream & | writeList (Ostream &os, const label shortLen=0) const |
| Write List, with line-breaks in ASCII when length exceeds shortLen. | |
| bool | all () const |
| True if all entries are 'true' or if the list is empty. | |
| bool | any () const |
| True if any entries are 'true'. | |
| bool | none () const |
| True if no entries are 'true'. | |
| bool | test (const label i) const |
Test bool value at specified position, always false for out-of-range access. | |
| bool | get (const label i) const |
Return bool value at specified position, always false for out-of-range access. | |
| bool | unset (const label i) |
Unset the bool entry at specified position, always false for out-of-range access. | |
| std::string_view | view () const |
| Return a string_view of the charList. Content is non-modifiable. | |
| vectorField & | first () |
| Access first element of the list, position [0]. | |
| vectorField & | last () |
| Access last element of the list, position [size()-1]. | |
| bool | found (const vectorField &val, label pos=0) const |
| Same as contains(). | |
| auto | expr () const |
| Wrap value as expression. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from List< vectorField > | |
| static const List< vectorField > & | null () noexcept |
| Return a null List (reference to a nullObject). Behaves like an empty List. | |
| Static Public Member Functions inherited from UList< vectorField > | |
| static const UList< vectorField > & | null () noexcept |
| Return a null UList (reference to a nullObject). Behaves like an empty UList. | |
| static constexpr label | max_size () noexcept |
| The size of the largest possible UList. | |
| Protected Member Functions inherited from UList< vectorField > | |
| void | setAddressableSize (const label n) noexcept |
| Set addressed size to be inconsistent with allocated storage. | |
| void | size (const label n) |
| Older name for setAddressableSize. | |
| void | writeEntry (Ostream &os) const |
| Write the UList with its compound type. | |
| 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. | |
| void | fill_uniform (const vectorField &val) |
| Assign all entries to the given value. | |
Set of directions for each cell in the mesh. Either uniform and size=1 or one set of directions per cell.
Used in splitting cells. Options:
Definition at line 64 of file directions.H.
| enum directionType |
Enumeration listing the possible coordinate directions.
| Enumerator | |
|---|---|
| TAN1 | |
| TAN2 | |
| NORMAL | |
Definition at line 75 of file directions.H.
| directions | ( | const polyMesh & | mesh, |
| const dictionary & | dict, | ||
| const twoDPointCorrector * | correct2DPtr = nullptr ) |
Construct from mesh and dictionary and optional 2D corrector.
Definition at line 266 of file directions.C.
References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, dictionary::get(), Foam::Info, mesh, IOobjectOption::MUST_READ, IOobjectOption::NO_WRITE, NORMAL, Foam::normalised(), UList< vectorField >::operator[](), twoDPointCorrector::planeNormal(), pp(), List< T >::resize(), UList< T >::size(), TAN1, TAN2, and WarningInFunction.
1.16.1 