Loading...
Searching...
No Matches
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...

#include <geometricZeroField.H>

Inheritance diagram for geometricZeroField:
Collaboration diagram for geometricZeroField:

Public Types

typedef zeroField Internal
typedef zeroField Patch
typedef zeroFieldField Boundary
typedef zero cmptType
Public Types inherited from zero
typedef zero value_type
 The value type.

Public Member Functions

 geometricZeroField () noexcept=default
 Default construct.
const dimensionSetdimensions () const noexcept
zeroField field () const noexcept
zeroField oldTime () const noexcept
Internal internalField () const noexcept
zeroField 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.
constexpr zero (Istream &) noexcept
 Construct from Istream consumes no content.
constexpr operator bool () const noexcept
 Return false (0) for bool.
constexpr operator label () const noexcept
 Return 0 for label.
constexpr operator float () const noexcept
 Return 0 for float.
constexpr operator double () const noexcept
 Return 0 for double.
zero operator[] (const label) const noexcept
 Component-wise or element-wise access returns zero.
template<class T>
constexpr zero operator() (const T &) const noexcept
 Unary functor returns zero.

Additional Inherited Members

Static Public Attributes inherited from zero
static zero dummy
 A static instance, when modifiable reference is required by an API.

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

Member Typedef Documentation

◆ Internal

Definition at line 56 of file geometricZeroField.H.

◆ Patch

typedef zeroField Patch

Definition at line 57 of file geometricZeroField.H.

◆ Boundary

Definition at line 58 of file geometricZeroField.H.

◆ cmptType

typedef zero cmptType

Definition at line 59 of file geometricZeroField.H.

Constructor & Destructor Documentation

◆ geometricZeroField()

geometricZeroField ( )
defaultnoexcept

Default construct.

References Foam::noexcept.

Member Function Documentation

◆ dimensions()

const dimensionSet & dimensions ( ) const
inlinenoexcept

Definition at line 72 of file geometricZeroField.H.

References dimensions(), Foam::dimless, and Foam::noexcept.

Referenced by dimensions().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ field()

zeroField field ( ) const
inlinenoexcept

Definition at line 77 of file geometricZeroField.H.

References Foam::noexcept.

◆ oldTime()

zeroField oldTime ( ) const
inlinenoexcept

Definition at line 82 of file geometricZeroField.H.

References Foam::noexcept.

◆ internalField()

Internal internalField ( ) const
inlinenoexcept

Definition at line 87 of file geometricZeroField.H.

References Foam::noexcept.

◆ primitiveField()

zeroField primitiveField ( ) const
inlinenoexcept

Definition at line 92 of file geometricZeroField.H.

References Foam::noexcept.

◆ boundaryField()

Boundary boundaryField ( ) const
inlinenoexcept

Definition at line 97 of file geometricZeroField.H.

References Foam::noexcept.

◆ v()

Internal v ( ) const
inlinenoexcept

Definition at line 103 of file geometricZeroField.H.

References Foam::noexcept.

◆ operator[]()

scalar operator[] ( const label ) const
inlinenoexcept

Definition at line 111 of file geometricZeroField.H.

◆ operator()()

Internal operator() ( ) const
inlinenoexcept

Definition at line 116 of file geometricZeroField.H.

References Foam::noexcept.


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