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 ()
 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
constexpr zero () noexcept
 Null constructible. 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 54 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 ( )
inline

Construct null.

Definition at line 72 of file geometricZeroField.H.

Member Function Documentation

◆ dimensions()

const Foam::dimensionSet & dimensions ( ) const
inline

Definition at line 32 of file geometricZeroFieldI.H.

References Foam::dimless.

◆ operator[]()

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

Definition at line 37 of file geometricZeroFieldI.H.

◆ field()

Foam::zeroField field ( ) const
inline

Definition at line 42 of file geometricZeroFieldI.H.

References Foam::vtk::Tools::zeroField().

Here is the call graph for this function:

◆ operator()()

Foam::zeroField operator() ( ) const
inline

Definition at line 47 of file geometricZeroFieldI.H.

References Foam::vtk::Tools::zeroField().

Here is the call graph for this function:

◆ oldTime()

Foam::zeroField oldTime ( ) const
inline

Definition at line 52 of file geometricZeroFieldI.H.

References Foam::vtk::Tools::zeroField().

Here is the call graph for this function:

◆ boundaryField()

Foam::zeroFieldField boundaryField ( ) const
inline

Definition at line 57 of file geometricZeroFieldI.H.

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