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

#include <oneField.H>

Inheritance diagram for oneField:

[legend]

Collaboration diagram for oneField:

[legend]

Public Types
typedef oneField	FieldType
Public Types inherited from one
typedef one	value_type
	The value type.

Public Member Functions
	oneField () noexcept=default
	Default construct.
oneField	field () const noexcept
	Method name compatibility with DimensionedField.
Public Member Functions inherited from one
constexpr	one () noexcept
	Default construct.
constexpr	one (Istream &) noexcept
	Construct from Istream consumes no content.
constexpr	operator label () const noexcept
	Return 1 for label.
constexpr	operator float () const noexcept
	Return 1 for float.
constexpr	operator double () const noexcept
	Return 1 for double.
one	operator[] (const label) const noexcept
	Component-wise or element-wise access returns one.

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

Default construct.

References Foam::noexcept.

Referenced by field().

Here is the caller graph for this function:

Member Function Documentation

◆ field()

oneField field ( ) const

inlinenoexcept

Method name compatibility with DimensionedField.

Definition at line 71 of file oneField.H.

References field(), Foam::noexcept, and oneField().

Referenced by field().

Here is the call graph for this function: