OpenFOAM logo
Open Source CFD Toolkit

Scalar.H File Reference


Detailed Description

View Scalar.H
License
This file is part of OpenFOAM.

OpenFOAM is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version.

OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.

You should have received a copy of the GNU General Public License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Description
Single floating point number

Source files

Definition in file Scalar.H.

Go to the source code of this file.

Namespaces

namespace  Foam

Classes

class  pTraits< Scalar >

Defines

#define transFunc(func)

Functions

word name (const Scalar s)
Scalar & setComponent (Scalar &s, const direction)
Scalar component (const Scalar s, const direction)
Scalar atan2 (const Scalar y, const Scalar x)
Scalar mag (const Scalar s)
Scalar sign (const Scalar s)
Scalar pos (const Scalar s)
Scalar neg (const Scalar s)
bool equal (const Scalar &s1, const Scalar &s2)
bool notEqual (const Scalar s1, const Scalar s2)
Scalar limit (const Scalar s1, const Scalar s2)
Scalar magSqr (const Scalar s)
Scalar sqr (const Scalar s)
Scalar pow3 (const Scalar s)
Scalar pow4 (const Scalar s)
Scalar cmptAv (const Scalar s)
Scalar cmptMag (const Scalar s)
Scalar scale (const Scalar s, const Scalar d)
Scalar sqrt (const Scalar s)
Scalar exp (const Scalar s)
Scalar log (const Scalar s)
Scalar log10 (const Scalar s)
Scalar sin (const Scalar s)
Scalar cos (const Scalar s)
Scalar tan (const Scalar s)
Scalar asin (const Scalar s)
Scalar acos (const Scalar s)
Scalar atan (const Scalar s)
Scalar sinh (const Scalar s)
Scalar cosh (const Scalar s)
Scalar tanh (const Scalar s)
Scalar asinh (const Scalar s)
Scalar acosh (const Scalar s)
Scalar atanh (const Scalar s)
Scalar erf (const Scalar s)
Scalar erfc (const Scalar s)
Scalar lgamma (const Scalar s)
Scalar j0 (const Scalar s)
Scalar j1 (const Scalar s)
Scalar jn (const int n, const Scalar s)
Scalar y0 (const Scalar s)
Scalar y1 (const Scalar s)
Scalar yn (const int n, const Scalar s)
Scalar stabilise (const Scalar s, const Scalar small)
Scalar readScalar (Istream &is)
Istream & operator>> (Istream &, Scalar &)


Define Documentation

#define transFunc func   ) 
 

Value:

inline Scalar func(const Scalar s) \
{                                  \
    return ::func(s);              \
}

Definition at line 181 of file Scalar.H.


Function Documentation

Scalar acos const Scalar  s  )  [inline]
 

Definition at line 196 of file Scalar.H.

Scalar acosh const Scalar  s  )  [inline]
 

Definition at line 202 of file Scalar.H.

Scalar asin const Scalar  s  )  [inline]
 

Definition at line 195 of file Scalar.H.

Scalar asinh const Scalar  s  )  [inline]
 

Definition at line 201 of file Scalar.H.

Scalar atan const Scalar  s  )  [inline]
 

Definition at line 197 of file Scalar.H.

Scalar atan2 const Scalar  y,
const Scalar  x
[inline]
 

Definition at line 105 of file Scalar.H.

Scalar atanh const Scalar  s  )  [inline]
 

Definition at line 203 of file Scalar.H.

Scalar cmptAv const Scalar  s  )  [inline]
 

Definition at line 165 of file Scalar.H.

Scalar cmptMag const Scalar  s  )  [inline]
 

Definition at line 170 of file Scalar.H.

Scalar component const Scalar  s,
const   direction
[inline]
 

Definition at line 100 of file Scalar.H.

Scalar cos const Scalar  s  )  [inline]
 

Definition at line 193 of file Scalar.H.

Scalar cosh const Scalar  s  )  [inline]
 

Definition at line 199 of file Scalar.H.

bool equal const Scalar &  s1,
const Scalar &  s2
[inline]
 

Definition at line 130 of file Scalar.H.

Scalar erf const Scalar  s  )  [inline]
 

Definition at line 207 of file Scalar.H.

Scalar erfc const Scalar  s  )  [inline]
 

Definition at line 208 of file Scalar.H.

Scalar exp const Scalar  s  )  [inline]
 

Definition at line 189 of file Scalar.H.

Referenced by specieThermo::A(), Foam::Ek(), and if().

Scalar j0 const Scalar  s  )  [inline]
 

Definition at line 211 of file Scalar.H.

Scalar j1 const Scalar  s  )  [inline]
 

Definition at line 212 of file Scalar.H.

Scalar jn const int  n,
const Scalar  s
[inline]
 

Definition at line 214 of file Scalar.H.

References Foam::yn().

Here is the call graph for this function:

Scalar lgamma const Scalar  s  )  [inline]
 

Definition at line 209 of file Scalar.H.

Scalar limit const Scalar  s1,
const Scalar  s2
[inline]
 

Definition at line 140 of file Scalar.H.

Scalar log const Scalar  s  )  [inline]
 

Definition at line 190 of file Scalar.H.

Scalar log10 const Scalar  s  )  [inline]
 

Definition at line 191 of file Scalar.H.

Scalar mag const Scalar  s  )  [inline]
 

Definition at line 110 of file Scalar.H.

Scalar magSqr const Scalar  s  )  [inline]
 

Definition at line 145 of file Scalar.H.

word name const Scalar  s  ) 
 

Scalar neg const Scalar  s  )  [inline]
 

Definition at line 125 of file Scalar.H.

Referenced by downwind::downwind().

bool notEqual const Scalar  s1,
const Scalar  s2
[inline]
 

Definition at line 135 of file Scalar.H.

Istream& operator>> Istream &  ,
Scalar & 
 

Scalar pos const Scalar  s  )  [inline]
 

Definition at line 120 of file Scalar.H.

Referenced by multivariateUpwind::fieldScheme::fieldScheme(), and upwindEdgeInterpolation::upwindEdgeInterpolation().

Scalar pow3 const Scalar  s  )  [inline]
 

Definition at line 155 of file Scalar.H.

Scalar pow4 const Scalar  s  )  [inline]
 

Definition at line 160 of file Scalar.H.

Scalar readScalar Istream &  is  ) 
 

Referenced by STLpoint::operator point().

Scalar scale const Scalar  s,
const Scalar  d
[inline]
 

Definition at line 175 of file Scalar.H.

Scalar& setComponent Scalar &  s,
const   direction
[inline]
 

Definition at line 95 of file Scalar.H.

Scalar sign const Scalar  s  )  [inline]
 

Definition at line 115 of file Scalar.H.

Scalar sin const Scalar  s  )  [inline]
 

Definition at line 192 of file Scalar.H.

Scalar sinh const Scalar  s  )  [inline]
 

Definition at line 198 of file Scalar.H.

Scalar sqr const Scalar  s  )  [inline]
 

Definition at line 150 of file Scalar.H.

Scalar sqrt const Scalar  s  )  [inline]
 

Definition at line 188 of file Scalar.H.

Referenced by if(), and GenSGSStress::k().

Scalar stabilise const Scalar  s,
const Scalar  small
[inline]
 

Definition at line 231 of file Scalar.H.

Referenced by QUICKLimiter::limiter(), PhiLimiter::limiter(), limitedCubicVLimiter::limiter(), limitedCubicLimiter::limiter(), NVDVTVDV::phict(), NVDTVD::phict(), NVDVTVDV::r(), NVDTVD::r(), linearUpwindWeight::weight(), and GammaWeight::weight().

Scalar tan const Scalar  s  )  [inline]
 

Definition at line 194 of file Scalar.H.

Scalar tanh const Scalar  s  )  [inline]
 

Definition at line 200 of file Scalar.H.

Scalar y0 const Scalar  s  )  [inline]
 

Definition at line 219 of file Scalar.H.

Scalar y1 const Scalar  s  )  [inline]
 

Definition at line 220 of file Scalar.H.

Scalar yn const int  n,
const Scalar  s
[inline]
 

Definition at line 222 of file Scalar.H.

References Scalar.

Referenced by Foam::jn().

For further information go to www.openfoam.org