oneField Class Reference

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

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

Public Types

typedef oneField FieldType
 
- Public Types inherited from one
typedef one value_type
 

Public Member Functions

 oneField ()=default
 Construct null. More...
 
oneField field () const
 
one operator[] (const label) 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 field 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 53 of file oneField.H.

Member Typedef Documentation

◆ FieldType

Definition at line 61 of file oneField.H.

Constructor & Destructor Documentation

◆ oneField()

oneField ( )
default

Construct null.

Referenced by oneField::field().

Here is the caller graph for this function:

Member Function Documentation

◆ field()

oneField field ( ) const
inline

Definition at line 72 of file oneField.H.

References oneField::oneField().

Here is the call graph for this function:

◆ operator[]()

one operator[] ( const  label) const
inline

Definition at line 80 of file oneField.H.

References one::one().

Here is the call graph for this function:

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