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

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

Public Member Functions
	geometricOneField () noexcept=default
const dimensionSet &	dimensions () const noexcept
oneField	field () const noexcept
oneField	oldTime () const noexcept
Internal	internalField () const noexcept
Internal	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
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 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 49 of file geometricOneField.H.

Member Typedef Documentation

Internal

typedef oneField Internal

Definition at line 57 of file geometricOneField.H.

Patch

typedef oneField Patch

Definition at line 58 of file geometricOneField.H.

Boundary

typedef oneFieldField Boundary

Definition at line 59 of file geometricOneField.H.

cmptType

typedef one cmptType

Definition at line 60 of file geometricOneField.H.

Constructor & Destructor Documentation

geometricOneField()

geometricOneField ( )

defaultnoexcept

Member Function Documentation

dimensions()

const dimensionSet& dimensions ( ) const

inlinenoexcept

Definition at line 71 of file geometricOneField.H.

References Foam::dimless.

field()

oneField field ( ) const

inlinenoexcept

Definition at line 76 of file geometricOneField.H.

oldTime()

oneField oldTime ( ) const

inlinenoexcept

Definition at line 81 of file geometricOneField.H.

internalField()

Internal internalField ( ) const

inlinenoexcept

Definition at line 86 of file geometricOneField.H.

primitiveField()

Internal primitiveField ( ) const

inlinenoexcept

Definition at line 91 of file geometricOneField.H.

boundaryField()

Boundary boundaryField ( ) const

inlinenoexcept

Definition at line 96 of file geometricOneField.H.

v()

Internal v ( ) const

inlinenoexcept

Definition at line 102 of file geometricOneField.H.

operator[]()

one operator[] ( const  label ) const

inlinenoexcept

Definition at line 110 of file geometricOneField.H.

operator()()

Internal operator() ( ) const

inlinenoexcept

Definition at line 115 of file geometricOneField.H.

---

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

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