zeroField Class Reference

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

Inheritance diagram for zeroField:

Collaboration diagram for zeroField:

Public Member Functions
	zeroField () noexcept=default
zeroField	field () const noexcept
scalar	operator[] (const label) const noexcept
zeroField	operator() () const noexcept
zeroField	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

Additional Inherited Members
Public Types inherited from zero
typedef zero	value_type

Detailed Description

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

Used for example as the argument to a function in which certain terms are optional, see source terms in the MULES solvers.

Definition at line 47 of file zeroField.H.

Constructor & Destructor Documentation

zeroField()

zeroField ( )

defaultnoexcept

Member Function Documentation

field()

zeroField field ( ) const

inlinenoexcept

Definition at line 61 of file zeroField.H.

Referenced by isoAdvection::advect().

Here is the caller graph for this function:

operator[]()

scalar operator[] ( const  label ) const

inlinenoexcept

Definition at line 69 of file zeroField.H.

operator()()

zeroField operator() ( ) const

inlinenoexcept

Definition at line 74 of file zeroField.H.

operator-()

zeroField operator- ( ) const

inlinenoexcept

Definition at line 79 of file zeroField.H.

---

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

• src/OpenFOAM/fields/Fields/zeroField/zeroField.H