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 ()
 Construct null. More...
 
const dimensionSet & dimensions () const
 
one operator[] (const label) const
 
oneField field () const
 
oneField oldTime () const
 
Internal operator() () const
 
Internal v () const
 
Internal::FieldType primitiveField () const
 
Boundary boundaryField () const
 
- Public Member Functions inherited from one
constexpr one () noexcept
 Null constructible. 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 54 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 ( )
inline

Construct null.

Definition at line 71 of file geometricOneField.H.

Member Function Documentation

◆ dimensions()

const Foam::dimensionSet & dimensions ( ) const
inline

Definition at line 32 of file geometricOneFieldI.H.

References Foam::dimless.

◆ operator[]()

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

Definition at line 38 of file geometricOneFieldI.H.

◆ field()

Foam::oneField field ( ) const
inline

Definition at line 44 of file geometricOneFieldI.H.

◆ oldTime()

Foam::oneField oldTime ( ) const
inline

Definition at line 50 of file geometricOneFieldI.H.

◆ operator()()

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

Definition at line 57 of file geometricOneFieldI.H.

◆ v()

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

Definition at line 64 of file geometricOneFieldI.H.

◆ primitiveField()

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

Definition at line 71 of file geometricOneFieldI.H.

◆ boundaryField()

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

Definition at line 78 of file geometricOneFieldI.H.

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