refCount Class Reference

Reference counter for various OpenFOAM components. More...

#include <refCount.H>

Inherited by FieldField< PatchField, Type >, FieldField< Foam::fvPatchField, scalar >, FieldField< Foam::fvPatchField, Foam::Vector< scalar > >, FieldField< Foam::pointPatchField, Foam::Vector< scalar > >, FieldField< Field, Foam::Vector< scalar > >, FieldField< Field, scalar >, FieldField< Foam::Field, scalar >, FieldField< Foam::Field, LUType >, FieldField< Foam::Field, solveScalar >, FieldField< Foam::Field, Type >, FieldField< Foam::fvPatchField, Type >, FieldField< Foam::pointPatchField, Type >, FieldField< Foam::fvsPatchField, Type >, FieldField< Foam::faPatchField, scalar >, FieldField< Foam::faePatchField, scalar >, FieldField< Foam::faPatchField, Foam::Vector< scalar > >, FieldField< Foam::faePatchField, Foam::Vector< scalar > >, FieldField< Foam::faPatchField, Foam::SphericalTensor< scalar > >, FieldField< Foam::faePatchField, Foam::SphericalTensor< scalar > >, FieldField< Foam::faPatchField, Foam::SymmTensor< scalar > >, FieldField< Foam::faePatchField, Foam::SymmTensor< scalar > >, FieldField< Foam::faPatchField, Foam::Tensor< scalar > >, FieldField< Foam::faePatchField, Foam::Tensor< scalar > >, FieldField< Foam::pointPatchField, scalar >, edgeInterpolationScheme< scalar >, faDdtScheme< scalar >, faMatrix< scalar >, faMatrix< vector >, faMatrix< tensor >, faMatrix< sphericalTensor >, faMatrix< symmTensor >, convectionScheme< scalar >, fluxFieldType< Type >, laplacianScheme< scalar, scalar >, laplacianScheme< scalar, symmTensor >, laplacianScheme< scalar, tensor >, laplacianScheme< vector, scalar >, laplacianScheme< vector, symmTensor >, laplacianScheme< vector, tensor >, laplacianScheme< sphericalTensor, scalar >, laplacianScheme< sphericalTensor, symmTensor >, laplacianScheme< sphericalTensor, tensor >, laplacianScheme< symmTensor, scalar >, laplacianScheme< symmTensor, symmTensor >, laplacianScheme< symmTensor, tensor >, laplacianScheme< tensor, scalar >, laplacianScheme< tensor, symmTensor >, laplacianScheme< tensor, tensor >, fvMatrix< scalar >, fvMatrix< vector >, fvMatrix< sphericalTensor >, fvMatrix< symmTensor >, fvMatrix< tensor >, multivariateSurfaceInterpolationScheme< scalar >, surfaceInterpolationScheme< scalar >, surfaceInterpolationScheme< GType >, FieldBase, FieldField< Field, Type >, edgeInterpolationScheme< Type >, convectionScheme< Type >, divScheme< Type >, faD2dt2Scheme< Type >, faDdtScheme< Type >, gradScheme< Type >, laplacianScheme< Type >, lnGradScheme< Type >, faMatrix< Type >, function1Base, convectionScheme< Type >, d2dt2Scheme< Type >, ddtScheme< Type >, divScheme< Type >, gradScheme< Type >, laplacianScheme< Type, GType >, snGradScheme< Type >, fvGeometryScheme, fvMatrix< Type >, multivariateSurfaceInterpolationScheme< Type >, patchFunction1Base, surfaceInterpolationScheme< Type >, token::compound, and waveModel.

Classes
struct	zero
	A non-counting (dummy) refCount. More...

Public Member Functions
constexpr	refCount () noexcept
	Default construct, initializing count to 0.
int	use_count () const noexcept
	Return the current reference count.
bool	unique () const noexcept
	Return true if the reference count is zero.
void	operator++ () noexcept
	Increment the reference count.
void	operator++ (int) noexcept
	Increment the reference count.
void	operator-- () noexcept
	Decrement the reference count.
void	operator-- (int) noexcept
	Decrement the reference count.

Detailed Description

Reference counter for various OpenFOAM components.

See also

Foam::tmp Foam::token::compound

Definition at line 44 of file refCount.H.

Constructor & Destructor Documentation

refCount()

refCount ( )

inlineconstexprnoexcept

Default construct, initializing count to 0.

Definition at line 63 of file refCount.H.

References Foam::noexcept.

Referenced by convectionScheme< Type >::convectionScheme(), FieldBase::FieldBase(), function1Base::function1Base(), function1Base::function1Base(), function1Base::function1Base(), patchFunction1Base::patchFunction1Base(), patchFunction1Base::patchFunction1Base(), and patchFunction1Base::patchFunction1Base().

Here is the caller graph for this function:

Member Function Documentation

use_count()

int use_count ( ) const

inlinenoexcept

Return the current reference count.

Definition at line 74 of file refCount.H.

References Foam::noexcept.

unique()

bool unique ( ) const

inlinenoexcept

Return true if the reference count is zero.

Definition at line 82 of file refCount.H.

References Foam::noexcept.

operator++() [1/2]

void operator++ ( )

inlinenoexcept

Increment the reference count.

Definition at line 93 of file refCount.H.

References Foam::noexcept.

operator++() [2/2]

void operator++ ( int )

inlinenoexcept

Increment the reference count.

Definition at line 101 of file refCount.H.

operator--() [1/2]

void operator-- ( )

inlinenoexcept

Decrement the reference count.

Definition at line 109 of file refCount.H.

References Foam::noexcept.

operator--() [2/2]

void operator-- ( int )

inlinenoexcept

Decrement the reference count.

Definition at line 117 of file refCount.H.

---

The documentation for this class was generated from the following file:

• src/OpenFOAM/memory/refCount/refCount.H