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:

Collaboration diagram for oneField:

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

Public Member Functions
	oneField () noexcept=default
oneField	field () const noexcept
one	operator[] (const label) const noexcept
Public Member Functions inherited from one
constexpr	one () noexcept
constexpr	one (Istream &) noexcept
constexpr	operator label () const noexcept
constexpr	operator float () const noexcept
constexpr	operator double () const noexcept

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 47 of file oneField.H.

Member Typedef Documentation

FieldType

typedef oneField FieldType

Definition at line 55 of file oneField.H.

Constructor & Destructor Documentation

oneField()

oneField ( )

defaultnoexcept

Member Function Documentation

field()

oneField field ( ) const

inlinenoexcept

Definition at line 66 of file oneField.H.

operator[]()

one operator[] ( const  label ) const

inlinenoexcept

Definition at line 74 of file oneField.H.

---

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

• src/OpenFOAM/fields/Fields/oneField/oneField.H