scalarImpl.H File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	pTraits< Scalar >
struct	nameOp< Scalar >
	A word representation of a floating-point value. More...
struct	compareOp< Scalar >
	Compare scalar values. More...
struct	equalOp< Scalar >
	Compare scalar values for equality. More...
struct	notEqualOp< Scalar >
	Compare scalar values for inequality. More...
struct	floorOp< Scalar >
	Round scalar downwards - functor version of std::floor. More...
struct	ceilOp< Scalar >
	Round scalar upwards - functor version of std::ceil. More...
struct	roundOp< Scalar >
	Round scalar - functor version of std::round. More...

Namespaces
namespace	Foam
	Namespace for OpenFOAM.

Functions
word	name (const Scalar val)
	A word representation of a floating-point value.
Scalar	ScalarRead (const char *buf)
	Parse entire buffer as a float/double, skipping leading/trailing whitespace.
bool	ScalarRead (const char *buf, Scalar &val)
	Parse entire buffer as a float/double, skipping leading/trailing whitespace.
Scalar	ScalarRead (const std::string &str)
	Parse entire string as a float/double, skipping leading/trailing whitespace.
bool	ScalarRead (const std::string &str, Scalar &val)
	Parse entire string as a float/double, skipping leading/trailing whitespace.
Scalar	ScalarRead (Istream &is)
	Read from Istream (uses tokenizer).
Istream &	operator>> (Istream &is, Scalar &val)
Ostream &	operator<< (Ostream &os, const Scalar val)
	transFunc (sqrt) transFunc(cbrt) transFunc(exp) transFunc(log) transFunc(log10) transFunc(sin) transFunc(cos) transFunc(tan) transFunc(asin) transFunc(acos) transFunc(atan) transFunc(sinh) transFunc(cosh) transFunc(tanh) transFunc(asinh) transFunc(acosh) transFunc(atanh) transFunc(erf) transFunc(erfc) transFunc(lgamma) transFunc(tgamma) besselFunc(j0) besselFunc(j1) besselFunc(y0) besselFunc(y1) besselFunc2(jn) besselFunc2(yn) inline Scalar &setComponent(Scalar &val
	Non-const access to scalar-type (has no components).
constexpr Scalar	component (const Scalar val, const direction) noexcept
	Return scalar value (has no components).
Scalar	sign (const Scalar s) noexcept
	Return 1 if s is greater_equal zero, or otherwise -1.
Scalar	pos (const Scalar s) noexcept
	Return 1 if s is greater than zero, otherwise 0.
Scalar	pos0 (const Scalar s) noexcept
	Return 1 if s is greater_equal zero, or otherwise 0.
Scalar	neg (const Scalar s) noexcept
	Return 1 if s is less than zero, or otherwise 0.
Scalar	neg0 (const Scalar s) noexcept
	Return 1 if s is less_equal zero, or otherwise 0.
Scalar	posPart (const Scalar s) noexcept
	Return the positive part of s, otherwise zero. Same as max(0, s).
Scalar	negPart (const Scalar s) noexcept
	Return the negative part of s, otherwise zero. Same as min(0, s).
bool	equal (const Scalar &a, const Scalar &b)
bool	notEqual (const Scalar a, const Scalar b)
Scalar	clamp (const Scalar val, Foam::zero_one)
	Clamp scalar value to a 0-1 range.
Scalar	clamp (const Scalar val, const Scalar lower, const Scalar upper)
Scalar	limit (const Scalar s1, const Scalar s2)
Scalar	minMod (const Scalar s1, const Scalar s2)
constexpr Scalar	lerp (const Scalar a, const Scalar b, const Scalar t)
	Linear interpolation of scalars a and b by factor t.
Scalar	magSqr (const Scalar s)
Scalar	sqr (const Scalar s)
Scalar	pow3 (const Scalar s)
Scalar	pow4 (const Scalar s)
Scalar	pow5 (const Scalar s)
Scalar	pow6 (const Scalar s)
Scalar	pow025 (const Scalar s)
Scalar	inv (const Scalar s)
Scalar	dot (const Scalar s1, const Scalar s2)
Scalar	cmptMultiply (const Scalar s1, const Scalar s2)
Scalar	cmptPow (const Scalar s1, const Scalar s2)
Scalar	cmptDivide (const Scalar s1, const Scalar s2)
Scalar	cmptMax (const Scalar s)
Scalar	cmptMin (const Scalar s)
Scalar	cmptAv (const Scalar s)
Scalar	cmptSqr (const Scalar s)
Scalar	cmptMag (const Scalar s)
Scalar	cmptMagSqr (const Scalar s)
Scalar	sqrtSumSqr (const Scalar a, const Scalar b)
Scalar	stabilise (const Scalar s, const Scalar tol)
	Stabilisation around zero for division.

Variables
const direction	noexcept

Detailed Description

Original source file scalarImpl.H

Definition in file scalarImpl.H.