stdFoam Namespace Reference

Namespace for std templates that are are part of future C++ standards or that are in a state of change. More...

Classes
class	span
	Rudimentary functionality similar to std::span for holding memory view. More...

Typedefs
template<class... >
using	void_t = void
	Map a sequence of any types to void as per C++17 std::void_t. More...

Functions
template<class C >
constexpr auto	begin (C &c) -> decltype(c.begin())
	Return iterator to the beginning of the container c. More...
template<class C >
constexpr auto	begin (const C &c) -> decltype(c.begin())
	Return const_iterator to the beginning of the container c. More...
template<class C >
constexpr auto	cbegin (const C &c) -> decltype(c.begin())
	Return const_iterator to the beginning of the container c. More...
template<class C >
constexpr auto	end (C &c) -> decltype(c.end())
	Return iterator to the end of the container c. More...
template<class C >
constexpr auto	end (const C &c) -> decltype(c.end())
	Return const_iterator to the end of the container c. More...
template<class C >
constexpr auto	cend (const C &c) -> decltype(c.end())
	Return const_iterator to the end of the container c. More...
template<class C >
constexpr auto	rbegin (C &c) -> decltype(c.rbegin())
	Return reverse_iterator to the reverse-begin of container c. More...
template<class C >
constexpr auto	rbegin (const C &c) -> decltype(c.rbegin())
	Return const_reverse_iterator to the reverse-begin of container c. More...
template<class C >
constexpr auto	crbegin (const C &c) -> decltype(c.rbegin())
	Return const_reverse_iterator to the reverse-begin of container c. More...
template<class C >
constexpr auto	rend (C &c) -> decltype(c.rend())
	Return reverse_iterator to reverse-end of container c. More...
template<class C >
constexpr auto	rend (const C &c) -> decltype(c.rend())
	Return const_reverse_iterator to reverse-end of container c. More...
template<class C >
constexpr auto	crend (const C &c) -> decltype(c.rend())
	Return const_reverse_iterator to reverse-end of container c. More...
template<class T >
constexpr const T &	min (const T &a, const T &b)
	Return the lesser of the parameters. More...
template<class T >
constexpr const T &	max (const T &a, const T &b)
	Return the greater of the parameters. More...

Detailed Description

Namespace for std templates that are are part of future C++ standards or that are in a state of change.

SeeAlso

• https://en.cppreference.com/w/cpp/iterator/begin
• https://en.cppreference.com/w/cpp/iterator/end
• https://en.cppreference.com/w/cpp/iterator/rbegin
• https://en.cppreference.com/w/cpp/iterator/rend

Typedef Documentation

void_t

using void_t = void

Map a sequence of any types to void as per C++17 std::void_t.

Definition at line 48 of file pTraits.H.

Function Documentation

begin() [1/2]

constexpr auto stdFoam::begin

(

C &

c

)

-> decltype(c.begin())

Return iterator to the beginning of the container c.

Definition as per std::begin C++17

Definition at line 168 of file stdFoam.H.

References Foam::constant::universal::c.

Referenced by distribution::add(), DictionaryBase< DLPtrList< T >, T >::addEntries(), scalars::assign(), HashPtrTable< exprResult >::clear(), objectRegistry::clear(), UList< Foam::vector >::contains(), FixedList< point, 2 >::crend(), UList< Foam::vector >::crend(), HashTable< const regIOobject * >::erase(), IOobjectList::filterClasses(), HashTable< const regIOobject * >::filterEntries(), HashTable< const regIOobject * >::filterKeys(), IOobjectList::filterObjects(), HashTable< const regIOobject * >::filterValues(), Matrix< RectangularMatrix< Type >, Type >::Matrix(), List< Field< scalar > >::operator=(), Matrix< RectangularMatrix< Type >, Type >::operator=(), List< Field< scalar > >::push_back(), DynamicList< Foam::vector >::push_back(), DynamicField< Foam::vector >::push_back(), Matrix< RectangularMatrix< Type >, Type >::readMatrix(), objectRegistry::readModifiedObjects(), SLListBase::remove(), string::removeRepeated(), FixedList< point, 2 >::rend(), UList< Foam::vector >::rend(), DynamicList< Foam::vector >::resize(), DynamicField< Foam::vector >::resize(), HashTable< const regIOobject * >::retain(), HashTable< const regIOobject * >::sorted(), VarName::stripInvalid(), and graph::y().

Here is the caller graph for this function:

begin() [2/2]

constexpr auto stdFoam::begin

(

const C &

c

)

-> decltype(c.begin())

Return const_iterator to the beginning of the container c.

Definition as per std::begin C++17

Definition at line 179 of file stdFoam.H.

References Foam::constant::universal::c.

cbegin()

constexpr auto stdFoam::cbegin

(

const C &

c

)

-> decltype(c.begin())

Return const_iterator to the beginning of the container c.

Definition as per std::cbegin C++17

Definition at line 190 of file stdFoam.H.

References Foam::constant::universal::c.

Referenced by edgeFaceCirculator::begin(), labelRanges::begin(), LPtrList< LListBase, T >::begin(), UILList< LListBase, T >::begin(), LList< Foam::chemPointISAT< CompType, ThermoType > *>::begin(), globalIndex::begin(), labelRanges::cbegin(), FixedList< point, 2 >::contains(), HashTable< const regIOobject * >::countEntries(), HashTable< const regIOobject * >::countKeys(), HashTable< const regIOobject * >::countValues(), HashTable< const regIOobject * >::csorted(), FixedList< point, 2 >::find(), UList< Foam::vector >::find(), sliceRange::labels(), objectRegistry::modified(), FixedList< point, 2 >::operator<(), UList< Foam::vector >::operator<(), UILList< LListBase, T >::operator==(), FixedList< point, 2 >::operator==(), genericRagelLemonDriver::printBuffer(), string::removeRepeated(), genericRagelLemonDriver::reportFatal(), HashTable< const regIOobject * >::toc(), HashTable< const regIOobject * >::tocEntries(), HashTable< const regIOobject * >::tocKeys(), HashTable< const regIOobject * >::tocValues(), HashPtrTable< exprResult >::write(), topoSet::writeDebug(), HashTable< const regIOobject * >::writeKeys(), and objectRegistry::writeObject().

Here is the caller graph for this function:

end() [1/2]

constexpr auto stdFoam::end

(

C &

c

)

-> decltype(c.end())

Return iterator to the end of the container c.

Definition as per std::end C++17

Definition at line 201 of file stdFoam.H.

References Foam::constant::universal::c.

Referenced by distribution::add(), DictionaryBase< DLPtrList< T >, T >::addEntries(), searchableSurfaceToFaceZone::applyToSet(), Foam::meshTools::bandCompression(), SLListBase::begin(), DLListBase::begin(), cellMatcher::calcEdgeAddressing(), meshRefinement::checkData(), singleRun::checkEndOfLoopAndUpdate(), steadyOptimisation::checkEndOfLoopAndUpdate(), searchableSurfaces::checkIntersection(), HashPtrTable< exprResult >::clear(), objectRegistry::clear(), blockEdge::compare(), UList< Foam::vector >::contains(), FixedList< point, 2 >::crbegin(), UList< Foam::vector >::crbegin(), extendedEdgeMesh::cut(), scotchDecomp::decomposeSerial(), snappySnapDriver::detectNearSurfaces(), Foam::drawHitProblem(), meshRefinement::dumpIntersections(), faMesh::edgeLengthCorrection(), HashTable< const regIOobject * >::erase(), Foam::PstreamDetail::exchangeChunkedBuf(), wallDistAddressing::extract(), searchablePlateFeatures::features(), IOobjectList::filterClasses(), HashTable< const regIOobject * >::filterEntries(), HashTable< const regIOobject * >::filterKeys(), IOobjectList::filterObjects(), HashTable< const regIOobject * >::filterValues(), searchableSurfacesQueries::findAllIntersections(), searchableSurfaces::findAllIntersections(), refinementSurfaces::findAllIntersections(), searchableSurfacesQueries::findAnyIntersection(), searchableSurfaces::findAnyIntersection(), refinementSurfaces::findAnyIntersection(), refinementSurfaces::findHigherIntersection(), treeDataPrimitivePatch< PatchType >::findIntersection(), triSurfaceSearch::findLine(), searchablePlane::findLine(), searchablePlate::findLine(), searchableDisk::findLine(), searchableRotatedBox::findLine(), searchableBox::findLine(), searchableCylinder::findLine(), searchableSurfaceWithGaps::findLine(), searchableSurfaceCollection::findLine(), triSurfaceMesh::findLine(), searchableCone::findLine(), searchableSphere::findLine(), dynamicIndexedOctree< Foam::dynamicTreeDataPoint >::findLine(), distributedTriSurfaceMesh::findLine(), indexedOctree< Foam::treeDataPrimitivePatch< PatchType > >::findLine(), triSurfaceSearch::findLineAll(), searchablePlane::findLineAll(), searchablePlate::findLineAll(), searchableDisk::findLineAll(), searchableCylinder::findLineAll(), searchableSurfaceWithGaps::findLineAll(), searchableSurfaceCollection::findLineAll(), searchableRotatedBox::findLineAll(), searchableBox::findLineAll(), searchableCone::findLineAll(), triSurfaceMesh::findLineAll(), searchableSphere::findLineAll(), distributedTriSurfaceMesh::findLineAll(), triSurfaceSearch::findLineAny(), searchablePlane::findLineAny(), searchablePlate::findLineAny(), searchableDisk::findLineAny(), searchableRotatedBox::findLineAny(), searchableCylinder::findLineAny(), searchableBox::findLineAny(), searchableSurfaceWithGaps::findLineAny(), searchableSurfaceCollection::findLineAny(), triSurfaceMesh::findLineAny(), searchableCone::findLineAny(), searchableSphere::findLineAny(), dynamicIndexedOctree< Foam::dynamicTreeDataPoint >::findLineAny(), distributedTriSurfaceMesh::findLineAny(), indexedOctree< Foam::treeDataPrimitivePatch< PatchType > >::findLineAny(), searchableSurfacesQueries::findNearestIntersection(), searchableSurfaces::findNearestIntersection(), refinementSurfaces::findNearestIntersection(), searchableExtrudedCircle::findParametricNearest(), for(), Random::globalPosition(), if(), Foam::stringOps::inplaceTrimLeft(), Foam::stringOps::inplaceTrimRight(), triangleFuncs::intersectBb(), treeBoundBox::intersects(), CollidingCloud< KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::motion(), line< Point, PointRef >::nearestDist(), meshRefinement::nearestIntersection(), NASCore::nextNasField(), findUniqueIntersectOp::operator()(), treeDataCell::findIntersectOp::operator()(), treeDataPrimitivePatch< PatchType >::findIntersectOp::operator()(), treeDataFace::findIntersectOp::operator()(), treeDataPrimitivePatch< PatchType >::findAllIntersectOp::operator()(), treeDataPrimitivePatch< PatchType >::findSelfIntersectOp::operator()(), steadyOptimisation::operator++(), Time::operator++(), Random::position(), powerLawLopesdaCostaZone::powerLawLopesdaCostaZone(), fileOperation::printRanks(), FixedList< point, 2 >::rbegin(), UList< Foam::vector >::rbegin(), GTSsurfaceFormat< Face >::read(), objectRegistry::readModifiedObjects(), SLListBase::remove(), DynamicList< Foam::vector >::resize(), DynamicField< Foam::vector >::resize(), HashTable< const regIOobject * >::retain(), sampledPatchInternalField::sampleOnFaces(), memorybuf::seekoff(), edgeFaceCirculator::setCanonical(), boundaryMesh::setFeatureEdges(), Foam::ListOps::setValue(), twoPhaseSystem::solve(), multiphaseSystem::solve(), MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::solveYi(), HashTable< const regIOobject * >::sorted(), Foam::stringOps::split(), Foam::stringOps::splitAny(), Foam::stringOps::splitFixed(), triSurfaceTools::trackToEdge(), Foam::stringOps::trim(), Foam::stringOps::trimLeft(), Foam::stringOps::trimRight(), steadyOptimisation::update(), timeVaryingMappedFixedValuePointPatchField< Type >::updateCoeffs(), meshRefinement::updateIntersections(), MappedFile< Type >::value(), wallLayerCells::wallLayerCells(), DMD::write(), and triSurfaceTools::writeCloseness().

end() [2/2]

constexpr auto stdFoam::end

(

const C &

c

)

-> decltype(c.end())

Return const_iterator to the end of the container c.

Definition as per std::end C++17

Definition at line 212 of file stdFoam.H.

References Foam::constant::universal::c.

cend()

constexpr auto stdFoam::cend

(

const C &

c

)

-> decltype(c.end())

Return const_iterator to the end of the container c.

Definition as per std::cend C++17

Definition at line 223 of file stdFoam.H.

References Foam::constant::universal::c.

Referenced by labelRanges::cbegin(), SLListBase::cbegin(), DLListBase::cbegin(), FixedList< point, 2 >::contains(), HashTable< const regIOobject * >::countEntries(), HashTable< const regIOobject * >::countKeys(), HashTable< const regIOobject * >::countValues(), HashTable< const regIOobject * >::csorted(), FixedList< point, 2 >::find(), UList< Foam::vector >::find(), sliceRange::labels(), objectRegistry::modified(), FixedList< point, 2 >::operator<(), UList< Foam::vector >::operator<(), UILList< LListBase, T >::operator==(), FixedList< point, 2 >::operator==(), UList< Foam::vector >::operator==(), genericRagelLemonDriver::printBuffer(), string::removeRepeated(), genericRagelLemonDriver::reportFatal(), HashTable< const regIOobject * >::toc(), HashTable< const regIOobject * >::tocEntries(), HashTable< const regIOobject * >::tocKeys(), HashTable< const regIOobject * >::tocValues(), HashPtrTable< exprResult >::write(), topoSet::writeDebug(), HashTable< const regIOobject * >::writeKeys(), and objectRegistry::writeObject().

Here is the caller graph for this function:

rbegin() [1/2]

constexpr auto stdFoam::rbegin

(

C &

c

)

-> decltype(c.rbegin())

Return reverse_iterator to the reverse-begin of container c.

Definition as per std::rbegin C++17

Definition at line 237 of file stdFoam.H.

References Foam::constant::universal::c.

rbegin() [2/2]

constexpr auto stdFoam::rbegin

(

const C &

c

)

-> decltype(c.rbegin())

Return const_reverse_iterator to the reverse-begin of container c.

Definition as per std::rbegin C++17

Definition at line 248 of file stdFoam.H.

References Foam::constant::universal::c.

crbegin()

constexpr auto stdFoam::crbegin

(

const C &

c

)

-> decltype(c.rbegin())

Return const_reverse_iterator to the reverse-begin of container c.

Definition as per std::crbegin C++17

Definition at line 259 of file stdFoam.H.

References Foam::constant::universal::c.

rend() [1/2]

constexpr auto stdFoam::rend

(

C &

c

)

-> decltype(c.rend())

Return reverse_iterator to reverse-end of container c.

Definition as per std::rend C++17

Definition at line 270 of file stdFoam.H.

References Foam::constant::universal::c.

rend() [2/2]

constexpr auto stdFoam::rend

(

const C &

c

)

-> decltype(c.rend())

Return const_reverse_iterator to reverse-end of container c.

Definition as per std::rend C++17

Definition at line 281 of file stdFoam.H.

References Foam::constant::universal::c.

crend()

constexpr auto stdFoam::crend

(

const C &

c

)

-> decltype(c.rend())

Return const_reverse_iterator to reverse-end of container c.

Definition as per std::crend C++17

Definition at line 292 of file stdFoam.H.

References Foam::constant::universal::c.

Referenced by DLListBase::crbegin().

Here is the caller graph for this function:

min()

constexpr const T& stdFoam::min ( const T &  a, const T &  b  )

inline

Return the lesser of the parameters.

Definition as per std::min C++14

Definition at line 303 of file stdFoam.H.

References Foam::constant::physicoChemical::b.

Referenced by span< Type >::subspan().

Here is the caller graph for this function:

max()

constexpr const T& stdFoam::max ( const T &  a, const T &  b  )

inline

Return the greater of the parameters.

Definition as per std::max C++14

Definition at line 314 of file stdFoam.H.

References Foam::constant::physicoChemical::b.