Includes some standard C++ headers, defines global macros and templates used in multiple places by OpenFOAM. More...

Include dependency graph for stdFoam.H:

This graph shows which files directly or indirectly include this file:

Classes
struct	identityOp
	A functor that returns its argument unchanged (cf. C++20 std::identity) Should never be specialized. More...

class	span< Type >
	Rudimentary functionality similar to std::span for holding memory view. More...

Namespaces
	Foam
	Namespace for OpenFOAM.

	Foam::Detail
	Implementation details for various OpenFOAM classes.

	Foam::Module
	Additional OpenFOAM modules.

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

Macros
#define	FOAM_DEPRECATED(since)

#define	FOAM_DEPRECATED_FOR(since, replacement)

#define	FOAM_DEPRECATED_STRICT(since, replacement)

#define	FOAM_DEPRECATED_STRICT(since, replacement)

#define	FOAM_NODISCARD

#define	forAllIters(container, iter)
	Iterate across all elements in the container object. More...

#define	forAllConstIters(container, iter)
	Iterate across all elements of the container object with const access. More...

#define	forAllReverseIters(container, iter)
	Reverse iterate across elements in the container object of type. More...

#define	forAllConstReverseIters(container, iter)
	Reverse iterate across elements of container object with const access. More...

#define	forAll(list, i) for (Foam::label i=0; i<(list).size(); ++i)
	Loop across all elements in list. More...

#define	forAllReverse(list, i) for (Foam::label i=(list).size()-1; i>=0; --i)
	Reverse loop across all elements in list. More...

#define	forAllIter(Container, container, iter)
	Iterate across all elements in the container object. More...

#define	forAllConstIter(Container, container, iter)
	Iterate across all elements in the container object. More...

Functions
template<class T >
void	Swap (T &a, T &b)
	Swap non-array types as per std::swap, but in Foam namespace. More...

template<class T , size_t N>
void	Swap (T(&a)[N], T(&b)[N])
	Swap array types as per std::swap example, but in Foam namespace. More...

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

Includes some standard C++ headers, defines global macros and templates used in multiple places by OpenFOAM.

Original source file stdFoam.H

Definition in file stdFoam.H.

Macro Definition Documentation

◆ FOAM_DEPRECATED

#define FOAM_DEPRECATED ( since )

Definition at line 49 of file stdFoam.H.

◆ FOAM_DEPRECATED_FOR

#define FOAM_DEPRECATED_FOR	(	since,
		replacement
	)

Definition at line 50 of file stdFoam.H.

◆ FOAM_DEPRECATED_STRICT [1/2]

#define FOAM_DEPRECATED_STRICT	(	since,
		replacement
	)

Definition at line 55 of file stdFoam.H.

◆ FOAM_DEPRECATED_STRICT [2/2]

#define FOAM_DEPRECATED_STRICT	(	since,
		replacement
	)

Definition at line 55 of file stdFoam.H.

◆ FOAM_NODISCARD

#define FOAM_NODISCARD

Definition at line 63 of file stdFoam.H.

◆ forAllIters

#define forAllIters	(	container,
		iter
	)

Value:

for                                                                        \
    (                                                                          \
        auto iter = stdFoam::begin(container);                                 \
        iter != stdFoam::end(container);                                       \
        ++iter                                                                 \
    )

Iterate across all elements in the container object.

Usage: forAllIters(container, iter)
{
statements;
}

See also: forAllConstIters, forAllIter, forAllConstIters

Definition at line 336 of file stdFoam.H.

Referenced by objectRegistry::checkCacheTemporaryObjects(), meshObject::clear(), meshObject::clearUpto(), fvExprDriver::clearVariables(), multiphaseInterSystem::correct(), multiphaseInterSystem::correctTurbulence(), fieldAverageItem::evolve(), Pstream::exchange(), mapDistributeBase::exchangeAddressing(), Foam::PstreamDetail::exchangeConsensus(), Foam::PstreamDetail::exchangeContainer(), namesList< solutionEntry >::find(), combineFaces::getMergeSets(), MassTransferPhaseSystem< BasePhaseSystem >::includeVolChange(), meshObject::movePoints(), multiphaseSystem::multiphaseSystem(), weightedPosition::operator()(), mapDistribute::transformPosition::operator()(), probes::prepare(), lumpedPointMovement::readDict(), regionSplit2D::regionSplit2D(), exprDriver::resetDb(), graph::setXRange(), UnsortedMeshedSurface< Face >::sortedZones(), Foam::transformList(), Raoult< Thermo, OtherThermo >::update(), meshObject::updateMesh(), fvExprDriver::updateSpecialVariables(), cuttingSurfaceBase::walkCellCuts(), regionSizeDistribution::write(), mappedPatchBase::writeDict(), CallbackRegistry< CallbackType >::~CallbackRegistry(), and undoableMeshCutter::~undoableMeshCutter().

◆ forAllConstIters

#define forAllConstIters	(	container,
		iter
	)

Value:

for                                                                        \
    (                                                                          \
        auto iter = stdFoam::cbegin(container);                                \
        iter != stdFoam::cend(container);                                      \
        ++iter                                                                 \
    )

Iterate across all elements of the container object with const access.

Usage: forAllConstIters(container, iter)
{
statements;
}

See also: forAllIters, forAllIter, forAllConstIter

Definition at line 357 of file stdFoam.H.

◆ forAllReverseIters

#define forAllReverseIters	(	container,
		iter
	)

Value:

for                                                                        \
    (                                                                          \
        auto iter = stdFoam::rbegin(container);                                \
        iter != stdFoam::rend(container);                                      \
        ++iter                                                                 \
    )

Reverse iterate across elements in the container object of type.

Container.

Usage: forAllReverseIters(container, iter)
{
statements;
}

See also: forAllConstReverseIters

Definition at line 379 of file stdFoam.H.

◆ forAllConstReverseIters

#define forAllConstReverseIters	(	container,
		iter
	)

Value:

for                                                                        \
    (                                                                          \
        auto iter = stdFoam::crbegin(container);                               \
        iter != stdFoam::crend(container);                                     \
        ++iter                                                                 \
    )

Reverse iterate across elements of container object with const access.

Usage: forAllReverseConstIters(container, iter)
{
statements;
}

See also: forAllReverseIters

Definition at line 400 of file stdFoam.H.

◆ forAll

#define forAll	(	list,
		i
	)	for (Foam::label i=0; i<(list).size(); ++i)

Loop across all elements in list.

Usage: forAll(anyList, i)
{
statements;
}

See also: forAllReverse

Definition at line 421 of file stdFoam.H.

◆ forAllReverse

#define forAllReverse	(	list,
		i
	)	for (Foam::label i=(list).size()-1; i>=0; --i)

Reverse loop across all elements in list.

Usage: forAllReverse(anyList, i)
{
statements;
}

See also: forAll

Definition at line 437 of file stdFoam.H.

Referenced by regIOobject::addWatch(), GAMGAgglomeration::agglomerateLduAddressing(), regIOobject::checkOut(), GAMGProcAgglomeration::clearCommunicators(), dlLibraryTable::close(), Pstream::combineScatter(), controlDict(), curvatureSeparation::curvatureSeparation(), masterUncollatedFileOperation::findInstancePath(), Time::findInstancePath(), Pstream::listCombineScatter(), Foam::listSwitches(), Pstream::mapCombineScatter(), regIOobject::modified(), patchInteractionDataList::patchInteractionDataList(), SprayCloud< Foam::DSMCCloud >::penetration(), regIOobject::read(), Time::readDict(), regIOobject::readIfModified(), masterUncollatedFileOperation::readObjects(), Pstream::scatter(), Pstream::scatterList(), patchInjectionBase::setPositionAndCell(), addPatchCellLayer::setRefinement(), fileOperation::subRanks(), reactingOneDim::updatePhiGas(), patchInjectionBase::whichProc(), and Time::~Time().

◆ forAllIter

#define forAllIter	(	Container,
		container,
		iter
	)

Value:

for                                                                        \
    (                                                                          \
        Container::iterator iter = (container).begin();                        \
        iter != (container).end();                                             \
        ++iter                                                                 \
    )

Iterate across all elements in the container object.

of type Container.

Usage: forAllIter(ContainerType, container, iter)
{
statements;
}

See also: forAllConstIter

Definition at line 456 of file stdFoam.H.

Referenced by phaseForces::execute(), phaseSystem::generatePairsAndSubModels(), and phaseForces::write().

◆ forAllConstIter

#define forAllConstIter	(	Container,
		container,
		iter
	)

Value:

for                                                                        \
    (                                                                          \
        Container::const_iterator iter = (container).cbegin();                 \
        iter != (container).cend();                                            \
        ++iter                                                                 \
    )

Iterate across all elements in the container object.

of type Container with const access.

Usage: forAllConstIter(ContainerType, container, iter)
{
statements;
}

See also: forAllIter

Definition at line 478 of file stdFoam.H.

Classes

Namespaces

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ FOAM_DEPRECATED

◆ FOAM_DEPRECATED_FOR

◆ FOAM_DEPRECATED_STRICT [1/2]

◆ FOAM_DEPRECATED_STRICT [2/2]

◆ FOAM_NODISCARD

◆ forAllIters

◆ forAllConstIters

◆ forAllReverseIters

◆ forAllConstReverseIters

◆ forAll

◆ forAllReverse

◆ forAllIter

◆ forAllConstIter