Includes some common 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
namespace	Foam
	Namespace for OpenFOAM.
namespace	Foam::Detail
	Implementation details for various OpenFOAM classes.
namespace	Foam::Module
	Additional OpenFOAM modules.
namespace	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_STRICTER(since, replacement)
#define	FOAM_UNLIKELY(cond)
#define	FOAM_LIKELY(cond)
#define	FOAM_NO_DANGLING_REFERENCE
#define	forAllIters(container, iter)
	Iterate across all elements in the container object.
#define	forAllConstIters(container, iter)
	Iterate across all elements of the container object with const access.
#define	forAllReverseIters(container, iter)
	Reverse iterate across elements in the container object of type.
#define	forAllConstReverseIters(container, iter)
	Reverse iterate across elements of container object with const access.
#define	forAll(list, i)
	Loop across all elements in list.
#define	forAllReverse(list, i)
	Reverse loop across all elements in list.
#define	forAllIter(Container, container, iter)
	Iterate across all elements in the container object.
#define	forAllConstIter(Container, container, iter)
	Iterate across all elements in the container object.

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

Variables
template<typename...>
constexpr bool	dependent_false_v = false
	Map any dependent type to false (workaround before CWG2518).
template<typename T>
constexpr bool	is_bool_v = std::is_same<bool, std::remove_cv_t<T>>::value
	Test for `bool` type (after removing cv).
template<typename T>
constexpr bool	is_char_v = std::is_same<char, std::remove_cv_t<T>>::value
	Test for `char` type (after removing cv).

Detailed Description

Includes some common 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 )

Value:

[[deprecated("Since " #since)]]

Definition at line 42 of file stdFoam.H.

◆ FOAM_DEPRECATED_FOR

#define FOAM_DEPRECATED_FOR	(		since,
			replacement )

Value:

[[deprecated("Since " #since "; use " #replacement)]]

Definition at line 43 of file stdFoam.H.

◆ FOAM_DEPRECATED_STRICT

#define FOAM_DEPRECATED_STRICT	(		since,
			replacement )

Definition at line 53 of file stdFoam.H.

Referenced by decompositionMethod::decompose(), dimensioned< label >::dimensioned(), argList::getList(), globalIndex::globalIndex(), and CompactListList< label >::operator<<.

◆ FOAM_DEPRECATED_STRICTER

#define FOAM_DEPRECATED_STRICTER	(		since,
			replacement )

Definition at line 56 of file stdFoam.H.

Referenced by UList< bool >::operator[](), SubList< bool >::reset(), and SubField< Type >::SubField().

◆ FOAM_UNLIKELY

#define FOAM_UNLIKELY ( cond )

Value:

(cond)

Definition at line 64 of file stdFoam.H.

◆ FOAM_LIKELY

#define FOAM_LIKELY ( cond )

Value:

(cond)

Definition at line 65 of file stdFoam.H.

Referenced by List< T >::resize_copy().

◆ FOAM_NO_DANGLING_REFERENCE

#define FOAM_NO_DANGLING_REFERENCE

Definition at line 80 of file stdFoam.H.

Referenced by MeshObject< polyMesh, UpdateableMeshObject, manifoldCellsMeshObject >::New(), faMeshesRegistry::operator=(), meshRefinement::removeLeakCells(), and MeshObject< polyMesh, UpdateableMeshObject, manifoldCellsMeshObject >::~MeshObject().

◆ forAllIters

#define forAllIters	(		container,
			iter )

Value:

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

Iterate across all elements in the container object.

Usage: forAllIters(container, iter)

{

statements;

}

forAllIters
#define forAllIters(container, iter)
Iterate across all elements in the container object.
Definition stdFoam.H:214

See also: forAllConstIters, forAllIter, forAllConstIters

Definition at line 214 of file stdFoam.H.

Referenced by objectRegistry::checkCacheTemporaryObjects(), fvExprDriver::clearVariables(), multiphaseInterSystem::correct(), multiphaseInterSystem::correctTurbulence(), fieldAverageItem::evolve(), combineFaces::getMergeSets(), MassTransferPhaseSystem< BasePhaseSystem >::includeVolChange(), mapDistribute::mapDistributeBase(), multiphaseSystem::multiphaseSystem(), mapDistribute::transformPosition::operator()(), weightedPosition::operator()(), FreezeParticles< CloudType >::preEvolve(), Probes< ProbeType >::prepare(), regionSplit2D::regionSplit2D(), exprDriver::resetDb(), graph::setXRange(), UnsortedMeshedSurface< Face >::sortedZones(), Foam::transformList(), Foam::transformList(), Raoult< Thermo, OtherThermo >::update(), fvExprDriver::updateSpecialVariables(), cuttingSurfaceBase::walkCellCuts(), regionSizeDistribution::write(), mappedPatchBase::writeDict(), CallbackRegistry< CallbackType >::~CallbackRegistry(), and undoableMeshCutter::~undoableMeshCutter().

◆ forAllConstIters

#define forAllConstIters	(		container,
			iter )

Value:

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

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

Usage: forAllConstIters(container, iter)

{

statements;

}

forAllConstIters
#define forAllConstIters(container, iter)
Iterate across all elements of the container object with const access.
Definition stdFoam.H:235

See also: forAllIters, forAllIter, forAllConstIter

Definition at line 235 of file stdFoam.H.

Referenced by greyMeanAbsorptionEmission::aCont(), wideBandAbsorptionEmission::aCont(), ISAT< CompType, ThermoType >::add(), snappyRefineDriver::addFaceZones(), multiphaseInterSystem::addInterfacePorosity(), ABAQUSCore::readHelper::addNewElset(), polyMeshTetDecomposition::adjustTetBasePtIs(), MassTransferPhaseSystem< BasePhaseSystem >::alphaTransfer(), foamReport::apply(), distribution::approxTotalEntries(), boundaryRegion::boundaryTypes(), cellMatcher::calcLocalFaces(), GAMGAgglomeration::calculateRegionMaster(), argList::check(), objectRegistry::checkCacheTemporaryObjects(), primitiveMesh::checkCommonOrder(), primitiveMesh::checkDuplicateFaces(), IOobjectList::classesImpl(), objectRegistry::classesImpl(), cellTable::combine(), multiWorldConnections::comms(), hexRef8::consistentSlowRefinement(), faPatch::constraintTypes(), fvPatch::constraintTypes(), polyPatch::constraintTypes(), MassTransferPhaseSystem< BasePhaseSystem >::correctMassSources(), objectRegistry::count(), IOobjectList::countImpl(), objectRegistry::countImpl(), IOobjectList::countTypeImpl(), objectRegistry::countTypeImpl(), multiWorldConnections::createComms(), multiphaseInterSystem::createSubModels(), multiphaseInterSystem::createSubModels(), multiphaseSystem::dragCoeffs(), edgeSurface::edgeSurface(), energyTransport::energyTransport(), polySurface::findFieldObject(), boundaryRegion::findIndex(), cellTable::findIndex(), polyMeshAdder::findSharedPoints(), multiphaseInterSystem::generatePairs(), phaseSystem::generatePairs(), multiphaseInterSystem::generatePairsAndSubModels(), multiphaseInterSystem::generatePairsTable(), undoableMeshCutter::getAddedCells(), combineFaces::getMergeSets(), undoableMeshCutter::getSplitFaces(), leastSquareGrad< T >::grad(), MassTransferPhaseSystem< BasePhaseSystem >::heatTransfer(), if(), multiphaseInterSystem::incompressible(), faBoundaryMesh::indices(), faBoundaryMesh::indices(), faBoundaryMesh::indices(), pointBoundaryMesh::indices(), pointBoundaryMesh::indices(), pointBoundaryMesh::indices(), polyBoundaryMesh::indices(), polyBoundaryMesh::indices(), polyBoundaryMesh::indices(), ZoneMesh< ZoneType, MeshType >::indices(), ZoneMesh< ZoneType, MeshType >::indices(), ZoneMesh< ZoneType, MeshType >::indices(), LocalInteraction< CloudType >::info(), RecycleInteraction< CloudType >::info(), StandardWallInteraction< CloudType >::info(), interfaceDefinitions::interfaceName(), interfaceDefinitions::isInterface(), multiphaseInterSystem::isochoric(), triSurfaceMesh::isSurfaceClosed(), IOobjectList::lookupClassImpl(), IOobjectList::lookupClassTypeImpl(), objectRegistry::lookupClassTypeImpl(), IOobjectList::lookupImpl(), reconstructedDistanceFunction::markCellsNearSurf(), MassTransferPhaseSystem< BasePhaseSystem >::massSpeciesTransfer(), MassTransferPhaseSystem< BasePhaseSystem >::MassTransferPhaseSystem(), polyBoundaryMesh::matchGroups(), cellTable::materialTypes(), boundaryRegion::maxIndex(), cellTable::maxIndex(), meshRefinement::mergeBaffles(), meshRefinement::mergePatchFacesUndo(), blockMesh::mesh(), multiBandZoneAbsorptionEmission::multiBandZoneAbsorptionEmission(), multiphaseSystem::multiphaseSystem(), multiphaseSystem::multiphaseSystem(), Foam::names_impl(), IOobjectList::namesImpl(), objectRegistry::namesImpl(), IOobjectList::namesTypeImpl(), objectRegistry::namesTypeImpl(), surfaceFeatures::nearestEdges(), surfaceFeatures::nearestSamples(), surfaceFeatures::nearestSamples(), multiphaseInterSystem::nearInterface(), IOobjectList::objectsTypeImpl(), objectRegistry::objectsTypeImpl(), mapDistribute::transformPosition::operator()(), weightedPosition::operator()(), worldConnectBitOrEq::operator()(), Foam::operator<<(), polyBoundaryMesh::patchSet(), ABAQUSsurfaceFormat< Face >::read(), NASsurfaceFormat< Face >::read(), wallBoundedStreamLine::read(), Time::readDict(), Cloud< ParticleType >::readFromFiles(), refinementSurfaces::refinementSurfaces(), boundaryRegion::rename(), substitutionModel::replaceBuiltin(), fieldAverage::restoreWindowFieldsType(), ISAT< CompType, ThermoType >::retrieve(), forceCoeffs::selectCoeffs(), cellTable::selectType(), boundaryCutter::setRefinement(), duplicatePoints::setRefinement(), edgeCollapser::setRefinement(), faceCollapser::setRefinement(), meshCutAndRemove::setRefinement(), meshCutter::setRefinement(), refinementIterator::setRefinement(), tetDecomposer::setRefinement(), undoableMeshCutter::setRefinement(), Foam::shallowCloneFunctions(), multiphaseInterSystem::surfaceTensionForce(), masterUncollatedFileOperation::sync(), syncTools::syncEdgeMap(), syncTools::syncPointMap(), distribution::totalEntries(), multiphaseInterSystem::U(), dynamicRefineFvMesh::unrefine(), uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs(), edgeVertex::updateLabels(), boundaryCutter::updateMesh(), hexRef8::updateMesh(), localPointRegion::updateMesh(), meshCutAndRemove::updateMesh(), meshCutter::updateMesh(), meshRefinement::updateMesh(), Foam::HashTableOps::values(), MassTransferPhaseSystem< BasePhaseSystem >::volTransfer(), reader::warnDuplicates(), meshReader::warnDuplicates(), polySurface::whichRegistry(), while(), writeObjects::write(), gnuplotWriter::write(), xmgraceWriter::write(), fvExprDriver::writeCommon(), fieldAverage::writeFields(), writer::writeSolution(), graph::writeTable(), and streamLineBase::writeToFile().

◆ forAllReverseIters

#define forAllReverseIters	(		container,
			iter )

Value:

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

Reverse iterate across elements in the container object of type.

Container.

Usage: forAllReverseIters(container, iter)

{

statements;

}

forAllReverseIters
#define forAllReverseIters(container, iter)
Reverse iterate across elements in the container object of type.
Definition stdFoam.H:257

See also: forAllConstReverseIters

Definition at line 257 of file stdFoam.H.

◆ forAllConstReverseIters

#define forAllConstReverseIters	(		container,
			iter )

Value:

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

Reverse iterate across elements of container object with const access.

Usage: forAllReverseConstIters(container, iter)

{

statements;

}

See also: forAllReverseIters

Definition at line 278 of file stdFoam.H.

◆ forAll

#define forAll	(		list,
			i )

Value:

for (Foam::label i=0; i<(list).size(); ++i)

Loop across all elements in list.

Usage: forAll(anyList, i)

{

statements;

}

forAll
#define forAll(list, i)
Loop across all elements in list.
Definition stdFoam.H:299

See also: forAllReverse

Definition at line 299 of file stdFoam.H.

◆ forAllReverse

#define forAllReverse	(		list,
			i )

Value:

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

Reverse loop across all elements in list.

Usage: forAllReverse(anyList, i)

{

statements;

}

forAllReverse
#define forAllReverse(list, i)
Reverse loop across all elements in list.
Definition stdFoam.H:315

See also: forAll

Definition at line 315 of file stdFoam.H.

Referenced by regIOobject::addWatch(), GAMGAgglomeration::agglomerateLduAddressing(), regIOobject::checkOut(), GAMGProcAgglomeration::clearCommunicators(), dlLibraryTable::close(), Foam::debug::controlDict(), curvatureSeparation::curvatureSeparation(), TimePaths::findInstancePath(), Foam::listSwitches(), regIOobject::modified(), patchInteractionDataList::patchInteractionDataList(), SprayCloud< CloudType >::penetration(), regIOobject::read(), Time::readDict(), regIOobject::readIfModified(), PatchFlowRateInjection< CloudType >::setPositionAndCell(), addPatchCellLayer::setRefinement(), fileOperation::subRanks(), Foam::subsetAdjacency(), reactingOneDim::updatePhiGas(), patchInjectionBase::whichProc(), OFstreamCollator::write(), 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;

}

forAllIter
#define forAllIter(Container, container, iter)
Iterate across all elements in the container object.
Definition stdFoam.H:334

See also: forAllConstIter

Definition at line 334 of file stdFoam.H.

Referenced by phaseSystem::generatePairsAndSubModels().

◆ 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;

}

forAllConstIter
#define forAllConstIter(Container, container, iter)
Iterate across all elements in the container object.
Definition stdFoam.H:356

See also: forAllIter

Definition at line 356 of file stdFoam.H.

Classes

Namespaces

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ FOAM_DEPRECATED

◆ FOAM_DEPRECATED_FOR

◆ FOAM_DEPRECATED_STRICT

◆ FOAM_DEPRECATED_STRICTER

◆ FOAM_UNLIKELY

◆ FOAM_LIKELY

◆ FOAM_NO_DANGLING_REFERENCE

◆ forAllIters

◆ forAllConstIters

◆ forAllReverseIters

◆ forAllConstReverseIters

◆ forAll

◆ forAllReverse

◆ forAllIter

◆ forAllConstIter