stdFoam Namespace Reference

Global macros and templates used by OpenFOAM and some standard C++ headers. 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 Tmin (const T &a, const T &b)
 Return the lesser of the parameters. More...
 
template<class T >
constexpr const Tmax (const T &a, const T &b)
 Return the greater of the parameters. More...
 

Detailed Description

Global macros and templates used by OpenFOAM and some standard C++ headers.

Some of the templates defined here correspond to useful std templates that are part of future C++ standards, or that are in a state of change. Defining them here provides some additional control over which definitions are used within the OpenFOAM code-base.

See also

Function Documentation

◆ begin() [1/2]

constexpr auto stdFoam::begin ( C c) -> decltype(c.begin())
constexpr

◆ begin() [2/2]

constexpr auto stdFoam::begin ( const C c) -> decltype(c.begin())
constexpr

Return const_iterator to the beginning of the container c.

Definition as per std::begin C++17

Definition at line 105 of file stdFoam.H.

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

◆ cbegin()

◆ end() [1/2]

constexpr auto stdFoam::end ( C c) -> decltype(c.end())
constexpr

Return iterator to the end of the container c.

Definition as per std::end C++17

Definition at line 121 of file stdFoam.H.

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

Referenced by distribution::add(), DictionaryBase< IDLList< simpleObjectRegistryEntry >, simpleObjectRegistryEntry >::addEntries(), searchableSurfaceToFaceZone::applyToSet(), Foam::bandCompression(), SLListBase::begin(), DLListBase::begin(), cellMatcher::calcEdgeAddressing(), meshRefinement::checkData(), singleRun::checkEndOfLoopAndUpdate(), steadyOptimisation::checkEndOfLoopAndUpdate(), searchableSurfaces::checkIntersection(), HashPtrTable< exprResult >::clear(), objectRegistry::clear(), blockEdge::compare(), FixedList< Type, 3 >::crbegin(), UList< Foam::wordRe >::crbegin(), extendedEdgeMesh::cut(), snappySnapDriver::detectNearSurfaces(), Foam::drawHitProblem(), meshRefinement::dumpIntersections(), faMesh::edgeLengthCorrection(), HashTable< Foam::autoPtr< Foam::interfaceCompositionModel > >::erase(), searchablePlateFeatures::features(), IOobjectList::filterClasses(), HashTable< Foam::autoPtr< Foam::interfaceCompositionModel > >::filterEntries(), HashTable< Foam::autoPtr< Foam::interfaceCompositionModel > >::filterKeys(), IOobjectList::filterObjects(), HashTable< Foam::autoPtr< Foam::interfaceCompositionModel > >::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(), searchableCylinder::findLine(), searchableRotatedBox::findLine(), searchableBox::findLine(), searchableSurfaceCollection::findLine(), searchableSurfaceWithGaps::findLine(), searchableCone::findLine(), triSurfaceMesh::findLine(), searchableSphere::findLine(), distributedTriSurfaceMesh::findLine(), dynamicIndexedOctree< Foam::dynamicTreeDataPoint >::findLine(), indexedOctree< Foam::treeDataPrimitivePatch< PatchType > >::findLine(), triSurfaceSearch::findLineAll(), searchablePlane::findLineAll(), searchablePlate::findLineAll(), searchableDisk::findLineAll(), searchableCylinder::findLineAll(), searchableSurfaceCollection::findLineAll(), searchableSurfaceWithGaps::findLineAll(), searchableRotatedBox::findLineAll(), searchableBox::findLineAll(), searchableCone::findLineAll(), triSurfaceMesh::findLineAll(), searchableSphere::findLineAll(), distributedTriSurfaceMesh::findLineAll(), triSurfaceSearch::findLineAny(), searchablePlane::findLineAny(), searchablePlate::findLineAny(), searchableDisk::findLineAny(), searchableCylinder::findLineAny(), searchableRotatedBox::findLineAny(), searchableBox::findLineAny(), searchableSurfaceCollection::findLineAny(), searchableSurfaceWithGaps::findLineAny(), triSurfaceMesh::findLineAny(), searchableCone::findLineAny(), searchableSphere::findLineAny(), distributedTriSurfaceMesh::findLineAny(), dynamicIndexedOctree< Foam::dynamicTreeDataPoint >::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(), Matrix< RectangularMatrix< Type >, Type >::Matrix(), CollidingCloud< KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::motion(), line< Point, PointRef >::nearestDist(), 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++(), UList< Foam::wordRe >::operator<(), Matrix< RectangularMatrix< Type >, Type >::operator=(), treeDataEdge::overlaps(), Random::position(), powerLawLopesdaCostaZone::powerLawLopesdaCostaZone(), collatedFileOperation::printBanner(), FixedList< Type, 3 >::rbegin(), UList< Foam::wordRe >::rbegin(), GTSsurfaceFormat< Face >::read(), Matrix< RectangularMatrix< Type >, Type >::readMatrix(), objectRegistry::readModifiedObjects(), SLListBase::remove(), HashTable< Foam::autoPtr< Foam::interfaceCompositionModel > >::retain(), sampledPatchInternalField::sampleOnFaces(), countstreambuf::seekoff(), memorybuf::seekoff(), edgeFaceCirculator::setCanonical(), boundaryMesh::setFeatureEdges(), Foam::ListOps::setValue(), twoPhaseSystem::solve(), multiphaseSystem::solve(), KirchhoffShell::solveDisplacement(), MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::solveYi(), 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< scalar >::value(), wallLayerCells::wallLayerCells(), DMD::write(), triSurfaceTools::writeCloseness(), and Foam::stringOps::writeWrapped().

◆ end() [2/2]

constexpr auto stdFoam::end ( const C c) -> decltype(c.end())
constexpr

Return const_iterator to the end of the container c.

Definition as per std::end C++17

Definition at line 129 of file stdFoam.H.

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

◆ cend()

◆ rbegin() [1/2]

constexpr auto stdFoam::rbegin ( C c) -> decltype(c.rbegin())
constexpr

Return reverse_iterator to the reverse-begin of container c.

Definition as per std::rbegin C++17

Definition at line 148 of file stdFoam.H.

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

◆ rbegin() [2/2]

constexpr auto stdFoam::rbegin ( const C c) -> decltype(c.rbegin())
constexpr

Return const_reverse_iterator to the reverse-begin of container c.

Definition as per std::rbegin C++17

Definition at line 156 of file stdFoam.H.

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

◆ crbegin()

constexpr auto stdFoam::crbegin ( const C c) -> decltype(c.rbegin())
constexpr

Return const_reverse_iterator to the reverse-begin of container c.

Definition as per std::crbegin C++17

Definition at line 164 of file stdFoam.H.

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

◆ rend() [1/2]

constexpr auto stdFoam::rend ( C c) -> decltype(c.rend())
constexpr

Return reverse_iterator to reverse-end of container c.

Definition as per std::rend C++17

Definition at line 172 of file stdFoam.H.

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

◆ rend() [2/2]

constexpr auto stdFoam::rend ( const C c) -> decltype(c.rend())
constexpr

Return const_reverse_iterator to reverse-end of container c.

Definition as per std::rend C++17

Definition at line 180 of file stdFoam.H.

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

◆ crend()

constexpr auto stdFoam::crend ( const C c) -> decltype(c.rend())
constexpr

Return const_reverse_iterator to reverse-end of container c.

Definition as per std::crend C++17

Definition at line 188 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 
)
inlineconstexpr

Return the lesser of the parameters.

Definition as per std::min C++14

Definition at line 196 of file stdFoam.H.

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

◆ max()

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

Return the greater of the parameters.

Definition as per std::max C++14

Definition at line 204 of file stdFoam.H.

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