Public Types | Public Member Functions | List of all members
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:
[legend]
Collaboration diagram for geometricZeroField:
[legend]

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
 Default construct. More...
 
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
 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...
 

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 55 of file geometricZeroField.H.

Member Typedef Documentation

◆ Internal

typedef zeroField Internal

Definition at line 63 of file geometricZeroField.H.

◆ Patch

typedef zeroField Patch

Definition at line 64 of file geometricZeroField.H.

◆ Boundary

typedef zeroFieldField Boundary

Definition at line 65 of file geometricZeroField.H.

◆ cmptType

typedef zero cmptType

Definition at line 66 of file geometricZeroField.H.

Constructor & Destructor Documentation

◆ geometricZeroField()

geometricZeroField ( )
defaultnoexcept

Default construct.

Member Function Documentation

◆ dimensions()

const dimensionSet & dimensions ( ) const
inlinenoexcept

Definition at line 77 of file geometricZeroField.H.

References Foam::dimless.

◆ field()

zeroField field ( ) const
inlinenoexcept

Definition at line 82 of file geometricZeroField.H.

◆ oldTime()

zeroField oldTime ( ) const
inlinenoexcept

Definition at line 87 of file geometricZeroField.H.

◆ internalField()

Internal internalField ( ) const
inlinenoexcept

Definition at line 92 of file geometricZeroField.H.

◆ primitiveField()

Internal primitiveField ( ) const
inlinenoexcept

Definition at line 97 of file geometricZeroField.H.

◆ boundaryField()

Boundary boundaryField ( ) const
inlinenoexcept

Definition at line 102 of file geometricZeroField.H.

◆ v()

Internal v ( ) const
inlinenoexcept

Definition at line 108 of file geometricZeroField.H.

◆ operator[]()

scalar operator[] ( const  label) const
inlinenoexcept

Definition at line 116 of file geometricZeroField.H.

◆ operator()()

Internal operator() ( ) const
inlinenoexcept

Definition at line 121 of file geometricZeroField.H.

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