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:
Inheritance graph
[legend]
Collaboration diagram for geometricOneField:
Collaboration graph
[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
 
geometricOneField oldTime () const
 
Internal operator() () const
 
Internal internalField () const
 
Internal v () const
 
Internal::FieldType primitiveField () const
 
Boundary boundaryField () const
 
- Public Member Functions inherited from one
 one ()
 Construct null. More...
 
 operator label () const
 Return 1 for label. More...
 
 operator float () const
 Return 1 for float. More...
 
 operator double () const
 Return 1 for double. More...
 
 operator long double () const
 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 52 of file geometricOneField.H.

Member Typedef Documentation

◆ Internal

typedef oneField Internal

Definition at line 61 of file geometricOneField.H.

◆ Patch

typedef oneField Patch

Definition at line 62 of file geometricOneField.H.

◆ Boundary

typedef oneFieldField Boundary

Definition at line 63 of file geometricOneField.H.

◆ cmptType

typedef one cmptType

Definition at line 64 of file geometricOneField.H.

Constructor & Destructor Documentation

◆ geometricOneField()

geometricOneField ( )
inline

Construct null.

Definition at line 70 of file geometricOneField.H.

Member Function Documentation

◆ dimensions()

const Foam::dimensionSet & dimensions ( ) const
inline

Definition at line 30 of file geometricOneFieldI.H.

References Foam::dimless.

◆ operator[]()

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

Definition at line 36 of file geometricOneFieldI.H.

◆ oldTime()

Foam::geometricOneField oldTime ( ) const
inline

Definition at line 42 of file geometricOneFieldI.H.

◆ operator()()

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

Definition at line 49 of file geometricOneFieldI.H.

◆ internalField()

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

Definition at line 56 of file geometricOneFieldI.H.

◆ v()

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

Definition at line 63 of file geometricOneFieldI.H.

◆ primitiveField()

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

Definition at line 70 of file geometricOneFieldI.H.

◆ boundaryField()

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

Definition at line 77 of file geometricOneFieldI.H.

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