Public Types | Public Member Functions | List of all members
geometricOneField Class Reference

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

Inheritance diagram for geometricOneField:
[legend]
Collaboration diagram for geometricOneField:
[legend]

Public Types

typedef oneField Internal
 
typedef oneField Patch
 
typedef oneFieldField Boundary
 
typedef one cmptType
 
- Public Types inherited from one
typedef one value_type
 

Public Member Functions

 geometricOneField () noexcept=default
 Default construct. More...
 
const dimensionSet & dimensions () const noexcept
 
oneField field () const noexcept
 
oneField oldTime () const noexcept
 
Internal internalField () const noexcept
 
Internal primitiveField () const noexcept
 
Boundary boundaryField () const noexcept
 
Internal v () const noexcept
 
one operator[] (const label) const noexcept
 
Internal operator() () const noexcept
 
- Public Member Functions inherited from one
constexpr one () noexcept
 Default construct. More...
 
constexpr one (Istream &) noexcept
 Construct from Istream consumes no content. More...
 
constexpr operator label () const noexcept
 Return 1 for label. More...
 
constexpr operator float () const noexcept
 Return 1 for float. More...
 
constexpr operator double () const noexcept
 Return 1 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 one 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 geometricOneField.H.

Member Typedef Documentation

◆ Internal

typedef oneField Internal

Definition at line 63 of file geometricOneField.H.

◆ Patch

typedef oneField Patch

Definition at line 64 of file geometricOneField.H.

◆ Boundary

typedef oneFieldField Boundary

Definition at line 65 of file geometricOneField.H.

◆ cmptType

typedef one cmptType

Definition at line 66 of file geometricOneField.H.

Constructor & Destructor Documentation

◆ geometricOneField()

geometricOneField ( )
defaultnoexcept

Default construct.

Member Function Documentation

◆ dimensions()

const dimensionSet& dimensions ( ) const
inlinenoexcept

Definition at line 77 of file geometricOneField.H.

References Foam::dimless.

◆ field()

oneField field ( ) const
inlinenoexcept

Definition at line 82 of file geometricOneField.H.

◆ oldTime()

oneField oldTime ( ) const
inlinenoexcept

Definition at line 87 of file geometricOneField.H.

◆ internalField()

Internal internalField ( ) const
inlinenoexcept

Definition at line 92 of file geometricOneField.H.

◆ primitiveField()

Internal primitiveField ( ) const
inlinenoexcept

Definition at line 97 of file geometricOneField.H.

◆ boundaryField()

Boundary boundaryField ( ) const
inlinenoexcept

Definition at line 102 of file geometricOneField.H.

◆ v()

Internal v ( ) const
inlinenoexcept

Definition at line 108 of file geometricOneField.H.

◆ operator[]()

one operator[] ( const  label) const
inlinenoexcept

Definition at line 116 of file geometricOneField.H.

◆ operator()()

Internal operator() ( ) const
inlinenoexcept

Definition at line 121 of file geometricOneField.H.

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