An ordered pair of two objects of type <T> with first() and second() elements. More...
#include <Pair.H>
Classes | |
| struct | symmHasher |
| Symmetric hashing functor for Pair, hashes lower value first. More... | |
Public Member Functions | |
| Pair ()=default | |
| Default construct. | |
| void | front ()=delete |
| The front() accessor (from FixedList) has no purpose. | |
| void | back ()=delete |
| The back() accessor (from FixedList) has no purpose. | |
| Pair (const T &f, const T &s) | |
| Copy construct from components. | |
| Pair (T &&f, T &&s) | |
| Move construct from components. | |
| Pair (const std::pair< T, T > &vals) | |
| Copy construct from std::pair. | |
| Pair (std::pair< T, T > &&vals) | |
| Move construct from std::pair. | |
| Pair (const FixedList< T, 2 > &list) | |
| Copy construct FixedList of two items. | |
| Pair (const T &f, const T &s, const bool doSort) | |
| Copy construct, optionally sorted with first less-than second. | |
| Pair (const FixedList< T, 2 > &list, const bool doSort) | |
| Copy construct, optionally sorted with first less-than second. | |
| Pair (Istream &is) | |
| Construct from Istream. | |
| const T & | first () const noexcept |
| Access the first element. | |
| T & | first () noexcept |
| Access the first element. | |
| const T & | second () const noexcept |
| Access the second element. | |
| T & | second () noexcept |
| Access the second element. | |
| const T & | other (const T &a) const |
| Return other element. | |
| bool | is_sorted () const |
| True if first() is less-than-equal second(). | |
| void | flip () |
| Flip the Pair in-place. | |
| void | sort () |
| Sort so that first() is less-than second(). | |
| Public Member Functions inherited from FixedList< T, 2 > | |
| FixedList ()=default | |
| Default construct. | |
| autoPtr< FixedList< T, N > > | clone () const |
| Clone. | |
| const T * | cdata () const noexcept |
| Return pointer to the underlying array serving as data storage. | |
| T * | 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,. | |
| T & | get () noexcept |
| Element access using compile-time indexing. | |
| T & | front () noexcept |
| Access first element of the list, position [0]. | |
| T & | back () noexcept |
| Access last element of the list, position [N-1]. | |
| label | fcIndex (const label i) const noexcept |
| Return the forward circular index, i.e. next index which returns to the first at the end of the list. | |
| const T & | fcValue (const label i) const |
| Return forward circular value (ie, next value in the list). | |
| label | rcIndex (const label i) const noexcept |
| Return the reverse circular index, i.e. previous index which returns to the last at the beginning of the list. | |
| const T & | rcValue (const label i) const |
| Return reverse circular value (ie, previous value in the list). | |
| void | checkStart (const label start) const |
| Check start is within valid range [0,size). | |
| void | checkSize (const label size) const |
| Check size is identical to template parameter N. | |
| void | checkIndex (const label i) const |
| Check index is within valid range [0,N). | |
| bool | uniform () const |
| True if all entries have identical values, and list is non-empty. | |
| bool | contains (const T &val) const |
| True if the value is contained in the list. | |
| label | find (const T &val) const |
| Find index of the first occurrence of the value. | |
| label | rfind (const T &val, label pos=-1) const |
| Find index of the last occurrence of the value. | |
| void | resize (const label n) |
| Dummy function, to make FixedList consistent with List Any resizing is ignored (Fatal with bad sizing in full debug). | |
| void | resize_fill (const label n, const T &val) |
| Set val for all elements. Any resizing is ignored (Fatal with bad sizing in full debug). | |
| void | resize_nocopy (const label n) |
| Dummy function, to make FixedList consistent with List Any resizing is ignored (Fatal with bad sizing in full debug). | |
| void | setSize (const label n) |
| Dummy function, to make FixedList consistent with List. | |
| void | fill (const T &val) |
| Assign all entries to the given 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. | |
| void | swapLast (const label i) |
| Swap element with the last element. | |
| void | transfer (FixedList< T, N > &list) |
| Transfer by swapping using a move assignment for the content of the individual list elements. | |
| T & | operator[] (const label i) |
| Return element of FixedList. | |
| void | operator= (const UList< T > &list) |
| Assignment to UList operator. Takes linear time. | |
| iterator | begin () noexcept |
| Return an iterator to begin traversing the FixedList. | |
| iterator | end () noexcept |
| Return an iterator to end traversing the FixedList. | |
| const_iterator | cbegin () const noexcept |
| Return const_iterator to begin traversing the constant FixedList. | |
| const_iterator | cend () const noexcept |
| Return const_iterator to end traversing the constant FixedList. | |
| reverse_iterator | rbegin () |
| Return reverse_iterator to begin reverse traversing the FixedList. | |
| reverse_iterator | rend () |
| Return reverse_iterator to end reverse traversing the FixedList. | |
| const_reverse_iterator | crbegin () const |
| Return const_reverse_iterator to begin reverse traversing FixedList. | |
| const_reverse_iterator | crend () const |
| Return const_reverse_iterator to end reverse traversing FixedList. | |
| void | swap (FixedList< T, N > &other) |
| Swap lists by swapping the content of the individual list elements. | |
| bool | operator== (const FixedList< T, N > &list) const |
| Equality operation on FixedLists of the same type. | |
| bool | operator!= (const FixedList< T, N > &list) const |
| The opposite of the equality operation. Takes linear time. | |
| bool | operator< (const FixedList< T, N > &list) const |
| Compare two FixedLists lexicographically. Takes linear time. | |
| bool | operator> (const FixedList< T, N > &list) const |
| Compare two FixedLists lexicographically. Takes linear time. | |
| bool | operator<= (const FixedList< T, N > &list) const |
| Return true if !(a > b). Takes linear time. | |
| bool | operator>= (const FixedList< T, N > &list) const |
| Return true if !(a < b). Takes linear time. | |
| Istream & | readList (Istream &is) |
| Read from Istream, discarding contents of existing List. | |
| Ostream & | writeList (Ostream &os, const label shortLen=0) const |
| Write List, with line-breaks in ASCII when length exceeds shortLen. | |
| T & | first () noexcept |
| Access first element of the list, position [0] - front(). | |
| T & | last () noexcept |
| Access last element of the list, position [N-1] - back(). | |
| bool | found (const T &val, label pos=0) const |
| Same as contains(). | |
Static Public Member Functions | |
| static int | compare (const Pair< T > &a, const Pair< T > &b) |
| Compare Pairs. | |
| Static Public Member Functions inherited from FixedList< T, 2 > | |
| static const FixedList< T, N > & | null () noexcept |
| Return a null FixedList (reference to a nullObject). Read/write access is questionable. | |
| static std::streamsize | size_bytes () noexcept |
| Number of contiguous bytes for the list data,. | |
| static std::streamsize | byteSize () |
| Number of contiguous bytes for the list data, runtime FatalError if type is not contiguous. | |
| static constexpr bool | empty () noexcept |
| Always false since zero-sized FixedList is compile-time disabled. | |
| static constexpr label | size () noexcept |
| Return the number of elements in the FixedList. | |
| static constexpr unsigned | max_size () noexcept |
| The dimensioned size (template parameter N) of the FixedList. | |
Additional Inherited Members | |
| Public Types inherited from FixedList< T, 2 > | |
| typedef T | value_type |
| The value type the FixedList contains. | |
| typedef T * | pointer |
| The pointer type for non-const access to value_type items. | |
| typedef const T * | const_pointer |
| The pointer type for const access to value_type items. | |
| typedef T & | reference |
| The type used for storing into value_type objects. | |
| typedef const T & | const_reference |
| The type used for reading from constant value_type objects. | |
| typedef T * | iterator |
| Random access iterator for traversing FixedList. | |
| typedef const T * | const_iterator |
| Random access iterator for traversing FixedList. | |
| typedef label | size_type |
| The type to represent the size of a FixedList. | |
| 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). | |
| Protected Member Functions inherited from FixedList< T, 2 > | |
| void | writeEntry (Ostream &os) const |
| Write the FixedList with its compound type. | |
An ordered pair of two objects of type <T> with first() and second() elements.
|
default |
Default construct.
Referenced by compare(), Pair< T >::symmHasher::operator()(), and Pair().
Copy construct FixedList of two items.
Definition at line 74 of file PairI.H.
References FixedList< T, 2 >::FixedList(), and Foam::T().
Copy construct, optionally sorted with first less-than second.
Definition at line 97 of file PairI.H.
References FixedList< T, 2 >::FixedList(), FixedList< T, 2 >::get(), Pair(), and Foam::T().
Construct from Istream.
Definition at line 104 of file PairI.H.
References FixedList< T, 2 >::FixedList(), and Foam::T().
Access the first element.
Definition at line 137 of file Pair.H.
Referenced by linePoints::a(), linePoints::a(), phaseChange::addToDriftRate(), globalIndexAndTransform::addToTransformIndex(), equationMaxIterCondition::apply(), meshRefinement::balance(), zoneBlended< Type >::blendingFactor(), cell::box(), face::box(), PrimitivePatch< FaceList, PointField >::box(), fieldMinMax::calcMinMaxFieldType(), commSchedule::commSchedule(), compare(), injectionModelList::correct(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), multiWorldConnections::createComms(), pimpleControl::criteriaSatisfied(), simpleControl::criteriaSatisfied(), snappyRefineDriver::doRefine(), face::edges(), Foam::extractTimeset(), Foam::faceNij(), pointMeshTools::featurePointsEdges(), shellSurfaces::findDirectionalLevel(), flip(), globalIndexAndTransform::globalIndexAndTransform(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::iDmdt(), globalIndexAndTransform::index(), SurfaceFilmModel< Foam::KinematicCloud< Foam::DSMCCloud< dsmcParcel > > >::injectParticles(), linearInterpolationWeights::integrationWeights(), isoSurfaceTopo::interpolateTemplate(), is_sorted(), isoSurfaceTopo::isoSurfaceTopo(), volSurfaceMapping::mapToSurface(), volSurfaceMapping::mapToSurface(), volSurfaceMapping::mapToVolume(), solutionControl::maxTypeResidual(), slidingInterface::modifyMotionPoints(), maxFirstOp< T1 >::operator()(), minFirstOp< T1 >::operator()(), Pair< T >::symmHasher::operator()(), Foam::operator<(), Foam::operator==(), FieldField< Field, Type >::operator[](), FieldField< Field, Type >::operator[](), other(), Pair(), Pair(), Pair(), Pair(), Pair(), face::rcEdges(), ensightSurfaceReader::readGeometry(), ensightSurfaceReader::readGeometryHeader(), RectangularMatrix< Type >::RectangularMatrix(), equationInitialResidualCondition::setResidual(), sort(), edge::sorted(), meshRefinement::splitFacesUndo(), SquareMatrix< Type >::SquareMatrix(), SquareMatrix< Type >::SquareMatrix(), SquareMatrix< Type >::SquareMatrix(), SquareMatrix< Type >::SquareMatrix(), globalIndexAndTransform::transformIndicesForPatches(), solverInfo::updateSolverInfo(), polyBoundaryMesh::whichPatch(), ABAQUSsurfaceFormat< Face >::write(), and meshRefinement::zonify().
Access the second element.
Definition at line 147 of file Pair.H.
Referenced by globalIndexAndTransform::addToTransformIndex(), linePoints::b(), linePoints::b(), meshRefinement::balance(), zoneBlended< Type >::blendingFactor(), cell::box(), face::box(), PrimitivePatch< FaceList, PointField >::box(), fieldMinMax::calcMinMaxFieldType(), commSchedule::commSchedule(), compare(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), snappyRefineDriver::doRefine(), face::edges(), Foam::extractTimeset(), Foam::faceNij(), pointMeshTools::featurePointsEdges(), shellSurfaces::findDirectionalLevel(), flip(), SurfaceFilmModel< Foam::KinematicCloud< Foam::DSMCCloud< dsmcParcel > > >::injectParticles(), linearInterpolationWeights::integrationWeights(), isoSurfaceTopo::interpolateTemplate(), is_sorted(), isoSurfaceTopo::isoSurfaceTopo(), volSurfaceMapping::mapToSurface(), slidingInterface::modifyMotionPoints(), Pair< T >::symmHasher::operator()(), Foam::operator<(), Foam::operator==(), FieldField< Field, Type >::operator[](), FieldField< Field, Type >::operator[](), other(), Pair(), Pair(), Pair(), Pair(), Pair(), globalIndexAndTransform::processor(), face::rcEdges(), ensightSurfaceReader::readGeometry(), ensightSurfaceReader::readGeometryHeader(), RectangularMatrix< Type >::RectangularMatrix(), meshState::setSolverPerformance(), sort(), edge::sorted(), meshRefinement::splitFacesUndo(), SquareMatrix< Type >::SquareMatrix(), SquareMatrix< Type >::SquareMatrix(), SquareMatrix< Type >::SquareMatrix(), SquareMatrix< Type >::SquareMatrix(), globalIndexAndTransform::transformIndex(), globalIndexAndTransform::transformIndicesForPatches(), ABAQUSsurfaceFormat< Face >::write(), and meshRefinement::zonify().
Return other element.
Definition at line 113 of file PairI.H.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, first(), second(), and Foam::T().
|
inline |
|
inline |
Flip the Pair in-place.
Definition at line 137 of file PairI.H.
References first(), second(), and Foam::Swap().
Referenced by sort(), patchEdgeFaceRegions::updateEdge(), patchEdgeFaceRegions::updateEdge(), and patchEdgeFaceRegions::updateFace().
|
inline |
Compare Pairs.
Definition at line 24 of file PairI.H.
References b, first(), Pair(), and second().
Referenced by ThermalPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::iDmdt(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::iDmdt(), AttouFerschneider::K(), multiphaseMixture::interfacePair::operator==, multiphaseMixtureThermo::interfacePair::operator==, multiphaseSystem::interfacePair::operator==, Foam::operator==(), PopulationBalancePhaseSystem< BasePhaseSystem >::pDmdt(), PhaseTransferPhaseSystem< BasePhaseSystem >::rDmdt(), and ThermalPhaseChangePhaseSystem< BasePhaseSystem >::wDmdt().
1.16.1 
