geometricOneField Class Reference

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

#include <geometricOneField.H>

Inheritance diagram for geometricOneField:

Collaboration diagram for geometricOneField:

Public Types
typedef oneField	Internal
typedef oneField	Patch
typedef oneFieldField	Boundary
typedef one	cmptType
Public Types inherited from one
typedef one	value_type
	The value type.

Public Member Functions
	geometricOneField () noexcept=default
	Default construct.
const dimensionSet &	dimensions () const noexcept
oneField	field () const noexcept
oneField	oldTime () const noexcept
Internal	internalField () const noexcept
oneField	primitiveField () const noexcept
Boundary	boundaryField () const noexcept
Internal	v () const noexcept
one	operator[] (const label) const noexcept
Internal	operator() () const noexcept
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 GeometricField 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 48 of file geometricOneField.H.

Member Typedef Documentation

Internal

typedef oneField Internal

Definition at line 56 of file geometricOneField.H.

Patch

typedef oneField Patch

Definition at line 57 of file geometricOneField.H.

Boundary

typedef oneFieldField Boundary

Definition at line 58 of file geometricOneField.H.

cmptType

typedef one cmptType

Definition at line 59 of file geometricOneField.H.

Constructor & Destructor Documentation

geometricOneField()

geometricOneField ( )

defaultnoexcept

Default construct.

References Foam::noexcept.

Member Function Documentation

dimensions()

const dimensionSet & dimensions ( ) const

inlinenoexcept

Definition at line 72 of file geometricOneField.H.

References dimensions(), Foam::dimless, and Foam::noexcept.

Referenced by dimensions().

Here is the call graph for this function:

Here is the caller graph for this function:

field()

oneField field ( ) const

inlinenoexcept

Definition at line 77 of file geometricOneField.H.

References Foam::noexcept.

oldTime()

oneField oldTime ( ) const

inlinenoexcept

Definition at line 82 of file geometricOneField.H.

References Foam::noexcept.

internalField()

Internal internalField ( ) const

inlinenoexcept

Definition at line 87 of file geometricOneField.H.

References Foam::noexcept.

primitiveField()

oneField primitiveField ( ) const

inlinenoexcept

Definition at line 92 of file geometricOneField.H.

References Foam::noexcept.

boundaryField()

Boundary boundaryField ( ) const

inlinenoexcept

Definition at line 97 of file geometricOneField.H.

References Foam::noexcept.

v()

Internal v ( ) const

inlinenoexcept

Definition at line 103 of file geometricOneField.H.

References Foam::noexcept.

operator[]()

one operator[] ( const label ) const

inlinenoexcept

Definition at line 111 of file geometricOneField.H.

References one::one().

Here is the call graph for this function:

operator()()

Internal operator() ( ) const

inlinenoexcept

Definition at line 116 of file geometricOneField.H.

References Foam::noexcept.

---

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

• src/OpenFOAM/fields/GeometricFields/geometricOneField/geometricOneField.H