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 ()
	Construct null. More...
scalar	operator[] (const label) const
zeroField	field () const
Public Member Functions inherited from zero
	zero ()

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 50 of file zeroField.H.

Constructor & Destructor Documentation

zeroField()

zeroField ( )

inline

Construct null.

Definition at line 59 of file zeroField.H.

Member Function Documentation

operator[]()

Foam::scalar operator[] ( const  label ) const

inline

Definition at line 30 of file zeroFieldI.H.

field()

Foam::zeroField field ( ) const

inline

Definition at line 36 of file zeroFieldI.H.

---

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

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