geometricZeroField Class Reference

A class representing the concept of a GeometricField of 0 used to avoid unnecessary manipulations for objects which are known to be zero at compile-time. More...

Inheritance diagram for geometricZeroField:

Collaboration diagram for geometricZeroField:

Public Types
typedef zeroField	Internal
typedef zeroField	Patch
typedef zeroFieldField	Boundary
typedef zero	cmptType
Public Types inherited from zero
typedef zero	value_type

Public Member Functions
	geometricZeroField () noexcept=default
const dimensionSet &	dimensions () const noexcept
zeroField	field () const noexcept
zeroField	oldTime () const noexcept
Internal	internalField () const noexcept
Internal	primitiveField () const noexcept
Boundary	boundaryField () const noexcept
Internal	v () const noexcept
scalar	operator[] (const label) const noexcept
Internal	operator() () const noexcept
Public Member Functions inherited from zero
constexpr	zero () noexcept
constexpr	zero (Istream &) noexcept
constexpr	operator bool () const noexcept
constexpr	operator label () const noexcept
constexpr	operator float () const noexcept
constexpr	operator double () const noexcept

Detailed Description

A class representing the concept of a GeometricField of 0 used to avoid unnecessary manipulations for objects which are known to be zero at compile-time.

Used for example as the density argument to a function written for compressible to be used for incompressible flow.

Definition at line 49 of file geometricZeroField.H.

Member Typedef Documentation

Internal

typedef zeroField Internal

Definition at line 57 of file geometricZeroField.H.

Patch

typedef zeroField Patch

Definition at line 58 of file geometricZeroField.H.

Boundary

typedef zeroFieldField Boundary

Definition at line 59 of file geometricZeroField.H.

cmptType

typedef zero cmptType

Definition at line 60 of file geometricZeroField.H.

Constructor & Destructor Documentation

geometricZeroField()

geometricZeroField ( )

defaultnoexcept

Member Function Documentation

dimensions()

const dimensionSet& dimensions ( ) const

inlinenoexcept

Definition at line 71 of file geometricZeroField.H.

References Foam::dimless.

field()

zeroField field ( ) const

inlinenoexcept

Definition at line 76 of file geometricZeroField.H.

oldTime()

zeroField oldTime ( ) const

inlinenoexcept

Definition at line 81 of file geometricZeroField.H.

internalField()

Internal internalField ( ) const

inlinenoexcept

Definition at line 86 of file geometricZeroField.H.

primitiveField()

Internal primitiveField ( ) const

inlinenoexcept

Definition at line 91 of file geometricZeroField.H.

boundaryField()

Boundary boundaryField ( ) const

inlinenoexcept

Definition at line 96 of file geometricZeroField.H.

v()

Internal v ( ) const

inlinenoexcept

Definition at line 102 of file geometricZeroField.H.

operator[]()

scalar operator[] ( const  label ) const

inlinenoexcept

Definition at line 110 of file geometricZeroField.H.

operator()()

Internal operator() ( ) const

inlinenoexcept

Definition at line 115 of file geometricZeroField.H.

---

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

• src/OpenFOAM/fields/GeometricFields/geometricZeroField/geometricZeroField.H