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 () noexcept=default
	Default construct. More...

oneField	field () const noexcept

one	operator[] (const label) const noexcept

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...

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

typedef oneField FieldType

Definition at line 61 of file oneField.H.

Constructor & Destructor Documentation

◆ oneField()

oneField ( )

defaultnoexcept

Default construct.

Member Function Documentation

◆ field()

oneField field ( ) const

inlinenoexcept

Definition at line 72 of file oneField.H.

◆ operator[]()

one operator[] ( const label ) const

inlinenoexcept

Definition at line 80 of file oneField.H.

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

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

Public Types

Public Member Functions