Public Member Functions | List of all members
geometricZeroField Class Reference

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

Inheritance diagram for geometricZeroField:
Inheritance graph
[legend]
Collaboration diagram for geometricZeroField:
Collaboration graph
[legend]

Public Member Functions

 geometricZeroField ()
 Construct null. More...
 
const dimensionSet & dimensions () const
 
scalar operator[] (const label) const
 
zeroField field () const
 
zeroField operator() () const
 
zeroField oldTime () const
 
zeroFieldField boundaryField () const
 
- Public Member Functions inherited from zero
 zero ()
 Construct null. More...
 
 operator bool () const
 Return 0 for bool. More...
 
 operator label () const
 Return 0 for label. More...
 
 operator float () const
 Return 0 for float. More...
 
 operator double () const
 Return 0 for double. More...
 
 operator long double () const
 Return 0 for double. More...
 

Additional Inherited Members

- Public Types inherited from zero
typedef zero value_type
 

Detailed Description

A class representing the concept of a GeometricField of 1 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 52 of file geometricZeroField.H.

Constructor & Destructor Documentation

◆ geometricZeroField()

geometricZeroField ( )
inline

Construct null.

Definition at line 62 of file geometricZeroField.H.

References geometricZeroField::boundaryField(), geometricZeroField::dimensions(), geometricZeroField::field(), geometricZeroField::oldTime(), geometricZeroField::operator()(), and geometricZeroField::operator[]().

Here is the call graph for this function:

Member Function Documentation

◆ dimensions()

const Foam::dimensionSet & dimensions ( ) const
inline

Definition at line 30 of file geometricZeroFieldI.H.

References Foam::dimless.

Referenced by geometricZeroField::geometricZeroField().

Here is the caller graph for this function:

◆ operator[]()

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

Definition at line 35 of file geometricZeroFieldI.H.

Referenced by geometricZeroField::geometricZeroField().

Here is the caller graph for this function:

◆ field()

Foam::zeroField field ( ) const
inline

Definition at line 40 of file geometricZeroFieldI.H.

Referenced by geometricZeroField::geometricZeroField().

Here is the caller graph for this function:

◆ operator()()

Foam::zeroField operator() ( ) const
inline

Definition at line 45 of file geometricZeroFieldI.H.

Referenced by geometricZeroField::geometricZeroField().

Here is the caller graph for this function:

◆ oldTime()

Foam::zeroField oldTime ( ) const
inline

Definition at line 50 of file geometricZeroFieldI.H.

Referenced by geometricZeroField::geometricZeroField().

Here is the caller graph for this function:

◆ boundaryField()

Foam::zeroFieldField boundaryField ( ) const
inline

Definition at line 55 of file geometricZeroFieldI.H.

Referenced by geometricZeroField::geometricZeroField().

Here is the caller graph for this function:
The documentation for this class was generated from the following files: