zeroFieldField Class Reference

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

Inheritance diagram for zeroFieldField:
Collaboration diagram for zeroFieldField:

Public Member Functions

 zeroFieldField () noexcept=default
 Default construct. More...
 
zeroField operator[] (const label) const noexcept
 Return the field. More...
 
zero operator[] (const labelPair &) const noexcept
 Return the field element. More...
 
- 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 zeroFields 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 48 of file zeroFieldField.H.

Constructor & Destructor Documentation

◆ zeroFieldField()

zeroFieldField ( )
defaultnoexcept

Default construct.

Member Function Documentation

◆ operator[]() [1/2]

zeroField operator[] ( const label  ) const
inlinenoexcept

Return the field.

Definition at line 67 of file zeroFieldField.H.

◆ operator[]() [2/2]

zero operator[] ( const labelPair ) const
inlinenoexcept

Return the field element.

Definition at line 75 of file zeroFieldField.H.


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