Public Types | 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 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
 
geometricZeroField oldTime () const
 
Internal operator() () const
 
Internal internalField () const
 
Internal v () const
 
Internal::FieldType primitiveField () const
 
Boundary 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...
 

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.

Member Typedef Documentation

◆ Internal

typedef zeroField Internal

Definition at line 61 of file geometricZeroField.H.

◆ Patch

typedef zeroField Patch

Definition at line 62 of file geometricZeroField.H.

◆ Boundary

typedef zeroFieldField Boundary

Definition at line 63 of file geometricZeroField.H.

◆ cmptType

typedef zero cmptType

Definition at line 64 of file geometricZeroField.H.

Constructor & Destructor Documentation

◆ geometricZeroField()

geometricZeroField ( )
inline

Construct null.

Definition at line 70 of file geometricZeroField.H.

Member Function Documentation

◆ dimensions()

const Foam::dimensionSet & dimensions ( ) const
inline

Definition at line 30 of file geometricZeroFieldI.H.

References Foam::dimless.

◆ operator[]()

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

Definition at line 36 of file geometricZeroFieldI.H.

◆ oldTime()

Foam::geometricZeroField oldTime ( ) const
inline

Definition at line 42 of file geometricZeroFieldI.H.

◆ operator()()

Foam::geometricZeroField::Internal operator() ( ) const
inline

Definition at line 49 of file geometricZeroFieldI.H.

◆ internalField()

Foam::geometricZeroField::Internal internalField ( ) const
inline

Definition at line 56 of file geometricZeroFieldI.H.

◆ v()

Foam::geometricZeroField::Internal v ( ) const
inline

Definition at line 63 of file geometricZeroFieldI.H.

◆ primitiveField()

Foam::geometricZeroField::Internal::FieldType primitiveField ( ) const
inline

Definition at line 70 of file geometricZeroFieldI.H.

◆ boundaryField()

Foam::geometricZeroField::Boundary boundaryField ( ) const
inline

Definition at line 77 of file geometricZeroFieldI.H.

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