oneFieldField Class Reference

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

Inheritance diagram for oneFieldField:
Collaboration diagram for oneFieldField:

Public Member Functions

 oneFieldField () noexcept=default
 Default construct. More...
 
oneField operator[] (const label) const noexcept
 Return the field. More...
 
one operator[] (const labelPair &) const noexcept
 Return the field element. More...
 
- 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...
 
one operator[] (const label) const noexcept
 Component-wise or element-wise access returns one. More...
 

Additional Inherited Members

- Public Types inherited from one
typedef one value_type
 The value type. More...
 

Detailed Description

A class representing the concept of a field of oneFields 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 48 of file oneFieldField.H.

Constructor & Destructor Documentation

◆ oneFieldField()

oneFieldField ( )
defaultnoexcept

Default construct.

Member Function Documentation

◆ operator[]() [1/2]

oneField operator[] ( const label  ) const
inlinenoexcept

Return the field.

Definition at line 67 of file oneFieldField.H.

◆ operator[]() [2/2]

one operator[] ( const labelPair ) const
inlinenoexcept

Return the field element.

Definition at line 75 of file oneFieldField.H.


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