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
	Default construct. More...
zeroField	field () const noexcept
	Method name compatibility with DimensionedField. More...
scalar	operator[] (const label) const noexcept
zeroField	operator() () const noexcept
zeroField	operator- () const noexcept
Public Member Functions inherited from zero
constexpr	zero () noexcept
	Default construct. More...
constexpr	zero (Istream &) noexcept
	Construct from Istream consumes no content. More...
constexpr	operator bool () const noexcept
	Return false (0) for bool. More...
constexpr	operator label () const noexcept
	Return 0 for label. More...
constexpr	operator float () const noexcept
	Return 0 for float. More...
constexpr	operator double () const noexcept
	Return 0 for double. More...
zero	operator[] (const label) const noexcept
	Component-wise or element-wise access returns zero. More...
template<class T >
constexpr zero	operator() (const T &) const noexcept
	Unary functor returns zero. More...

Additional Inherited Members
Public Types inherited from zero
typedef zero	value_type
	The value type. More...
Static Public Attributes inherited from zero
static zero	dummy
	A static instance, when modifiable reference is required by an API. More...

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

Default construct.

Member Function Documentation

field()

zeroField field ( ) const

inlinenoexcept

Method name compatibility with DimensionedField.

Definition at line 66 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 74 of file zeroField.H.

operator()()

zeroField operator() ( ) const

inlinenoexcept

Definition at line 79 of file zeroField.H.

operator-()

zeroField operator- ( ) const

inlinenoexcept

Definition at line 84 of file zeroField.H.

---

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

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